Package org.anchoranalysis.io.generator.sequence.pattern

Class OutputPattern

Object

OutputPattern

Direct Known Subclasses:

OutputPatternIntegerSuffix, OutputPatternStringSuffix

public abstract class OutputPattern
extends Object

A particular naming pattern files follow when outputted.

This involves several aspects:

• An optional subdirectory where the output-sequence is written to, or else the current output-directory (both relative to the input-output-context).
• A naming style (possibly including an index in the filename, and a prefix.suffix) for each file created in that directory.
• An associated output-name that is used as an identifer in forming rules on what outputs are enabled or not.
• Whether to enforce these rules or not, on what outputs are enabled.

along with associated rules for writing.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
OutputPattern(Optional<String> subdirectoryName, IndexableOutputNameStyle outputNameStyle, boolean selective)	Creates a new OutputPattern instance.

Method Summary

Modifier and Type	Method	Description
IndexableOutputNameStyle	getOutputNameStyle()
Optional<String>	getSubdirectoryName()	The name of a subdirectory in the current context to write to, or if empty, files are written into the current directory context.
boolean	isSelective()	Whether the output should be checked to see if it is allowed or not.

Methods inherited from class java.lang.Object

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

Constructor Details

OutputPattern

public OutputPattern(Optional<String> subdirectoryName,
 IndexableOutputNameStyle outputNameStyle,
 boolean selective)

Creates a new OutputPattern instance.

Parameters:

subdirectoryName - The name of a subdirectory in the current context to write to, or if empty, files are written into the current directory context.

outputNameStyle -

selective - Whether the output should be checked to see if it is allowed or not.

Method Details

getSubdirectoryName

public Optional<String> getSubdirectoryName()

The name of a subdirectory in the current context to write to, or if empty, files are written into the current directory context.

getOutputNameStyle

public IndexableOutputNameStyle getOutputNameStyle()

isSelective

public boolean isSelective()

Whether the output should be checked to see if it is allowed or not.