Package org.anchoranalysis.io.output.writer

Class CheckIfAllowed

Object

CheckIfAllowed

All Implemented Interfaces:

Writer

public class CheckIfAllowed
extends Object
implements Writer

Only allows outputs, if the output-name is allowed in the OutputterChecked.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
CheckIfAllowed(SingleLevelOutputEnabled outputEnabled, Optional<WriterExecuteBeforeEveryOperation> preop, Writer writer)	Creates a new CheckIfAllowed instance.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

CheckIfAllowed

public CheckIfAllowed(SingleLevelOutputEnabled outputEnabled,
 Optional<WriterExecuteBeforeEveryOperation> preop,
 Writer writer)

Creates a new CheckIfAllowed instance.

Parameters:

outputEnabled - Whether a particular output is enabled or not?

preop - If defined, execute before every operation

writer - The writer.

Method Details

createSubdirectory

public Optional<OutputterChecked> createSubdirectory(String outputName,
 boolean inheritOutputRulesAndRecording)
                                              throws OutputWriteFailedException

Description copied from interface: Writer

Maybe creates a subdirectory for writing to.

Specified by:

createSubdirectory in interface Writer

Parameters:

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

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().

Throws:

OutputWriteFailedException - if the directory creation fails.

write

public <T> boolean write(String outputName,
 ElementWriterSupplier<T> elementWriter,
 ElementSupplier<T> element)
                  throws OutputWriteFailedException

Description copied from interface: Writer

Writes an element using an ElementWriter to the current directory.

Specified by:

write in interface Writer

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.

Returns:

true if the output was allowed, false otherwise.

Throws:

OutputWriteFailedException - if the write operation fails.

writeWithIndex

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

Description copied from interface: Writer

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

Specified by:

writeWithIndex in interface Writer

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.

Returns:

true if the output was allowed, false otherwise.

Throws:

OutputWriteFailedException - if the write operation fails.

writeWithoutName

public <T> boolean writeWithoutName(String outputName,
 ElementWriterSupplier<T> elementWriter,
 ElementSupplier<T> element)
                             throws OutputWriteFailedException

Description copied from interface: Writer

Writes an element using an ElementWriter to the current directory, without including an output name in the path.

Specified by:

writeWithoutName in interface Writer

Parameters:

outputName - the name of the subdirectory. This may determine if an output is allowed or not, but will not be included in the outputted filename.

elementWriter - writes the element to the filesystem.

element - the element to write.

Returns:

true if the output was allowed, false otherwise.

Throws:

OutputWriteFailedException - if the write operation fails.

createFilenameForWriting

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

Description copied from interface: Writer

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 Writer.write(String, ElementWriterSupplier, ElementSupplier) and Writer.writeWithIndex(IndexableOutputNameStyle, ElementWriterSupplier, ElementSupplier, String).

Specified by:

createFilenameForWriting in interface Writer

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().