Package org.anchoranalysis.io.output.writer

Class WriterRouterErrors

Object

org.anchoranalysis.io.output.writer.WriterRouterErrors

public class WriterRouterErrors
extends Object

Write data via ElementWriters to the file system.

Or alternatively write by creating new sub-directories for writing data to.

This class is similar to Writer but:

• exceptions are suppressed and errors are instead reported.
• differences exist around writing sub-folders.

These operations occur in association with the currently bound output manager.

The ElementWriterSupplier interface is used so as to avoid object-creation if an operation isn't actually written.

Note that a ElementWriter may write more than one file for a given element.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
WriterRouterErrors(Writer delegate, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method	Description
Optional<Path>	createFilenameForWriting(String outputName, String extension)	The path to write a particular output to.
Optional<Outputter>	createSubdirectory(String outputName, boolean inheritOutputRulesAndRecording)	Maybe creates a subdirectory for writing to.
<T> void	write(String outputName, ElementWriterSupplier<T> elementWriter, ElementSupplier<T> element)	Writes an element using an ElementWriter to the current directory.
<T> void	writeWithIndex(IndexableOutputNameStyle outputNameStyle, ElementWriterSupplier<T> elementWriter, ElementSupplier<T> element, String index)	Writes an indexed-element using an ElementWriter in the current directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WriterRouterErrors

public WriterRouterErrors(Writer delegate, ErrorReporter errorReporter)

Method Details

createSubdirectory

public Optional<Outputter> createSubdirectory(String outputName, boolean inheritOutputRulesAndRecording)

Maybe creates a subdirectory for writing to.

Parameters:

outputName - the name of the subdirectory.

inheritOutputRulesAndRecording - if true, the output rules and recording are inherited from the parent directory. if false, they are not, and all outputs are allowed and are unrecorded.

Returns:

an output-manager for the directory if it is allowed, otherwise Optional.empty().

write

public <T> void write(String outputName, ElementWriterSupplier<T> elementWriter, ElementSupplier<T> element)

Writes an element using an ElementWriter to the current directory.

Parameters:

outputName - the name of the subdirectory. This may determine if an output is allowed or not.

elementWriter - writes the element to the filesystem

element - the element to write

writeWithIndex

public <T> void writeWithIndex(IndexableOutputNameStyle outputNameStyle, ElementWriterSupplier<T> elementWriter, ElementSupplier<T> element, String index)

Writes an indexed-element using an ElementWriter in the current directory.

Parameters:

outputNameStyle - how to combine a particular output-name with an index

elementWriter - writes the element to the filesystem

element - the element to write

index - the index

createFilenameForWriting

public Optional<Path> createFilenameForWriting(String outputName, String extension)

The path to write a particular output to.

This is an alternative method to write to the file system rather than using an ElementWriter and write(String, ElementWriterSupplier, ElementSupplier) and writeWithIndex(IndexableOutputNameStyle, ElementWriterSupplier, ElementSupplier, String).

Parameters:

outputName - the output-name. This is the filename without an extension, and may determine if an output is allowed or not.

extension - the extension

Returns:

the path to write to, if it is allowed, otherwise Optional.empty().