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

Class OutputPatternIntegerSuffix

Object

OutputPattern

OutputPatternIntegerSuffix

public class OutputPatternIntegerSuffix
extends OutputPattern

A OutputPattern that outputs a file-name with a trailing integer index.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
OutputPatternIntegerSuffix(String outputName, boolean selective)	Creates in a subdirectory, using the outputName as both the subdirectory name and the prefix.
OutputPatternIntegerSuffix(String outputName, boolean suppressSubdirectory, String prefix, int numberDigits, boolean selective)	Creates with a full set of flexibility about how the filename appears and whether a subdirectory is used.
OutputPatternIntegerSuffix(String outputName, int numberDigits, boolean selective)	Like OutputPatternIntegerSuffix(String, boolean) but also whether to check outputs against rules.
OutputPatternIntegerSuffix(String outputName, String prefix)	Creates in a subdirectory, using the output-name as the subdirectory name, and a specific prefix.
OutputPatternIntegerSuffix(String outputName, String prefix, int numberDigits, boolean selective)	Like OutputPatternIntegerSuffix(String, String) but with additional options about the number of digits, and whether to check outputs against rules.

Method Summary

Methods inherited from class org.anchoranalysis.io.generator.sequence.pattern.OutputPattern

getOutputNameStyle, getSubdirectoryName, isSelective

Methods inherited from class java.lang.Object

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

Constructor Details

OutputPatternIntegerSuffix

public OutputPatternIntegerSuffix(String outputName,
 boolean selective)

Creates in a subdirectory, using the outputName as both the subdirectory name and the prefix.

The subdirectoryName is also used as a prefix on outputted files.

The full-name has an increment number appended e.g. $outputName/$outputName_000000.tif etc.

Parameters:

outputName - name of subdirectory to place sequence in (which is also used as the outputName and prefix)

selective - whether to check output-names against the rules or not. If not, all outputs will occur permissively.

OutputPatternIntegerSuffix

public OutputPatternIntegerSuffix(String outputName,
 String prefix)

Creates in a subdirectory, using the output-name as the subdirectory name, and a specific prefix.

The full-name has an increment number appended e.g. $outputName/$prefix_000000.tif etc.

Parameters:

outputName - name of subdirectory to place sequence in (which is also used as the outputName and prefix)

prefix - a string that appears before the index in each outputted filename, with an underscore separating the prefix from the numeric index

OutputPatternIntegerSuffix

public OutputPatternIntegerSuffix(String outputName,
 int numberDigits,
 boolean selective)

Like OutputPatternIntegerSuffix(String, boolean) but also whether to check outputs against rules.

Parameters:

outputName - name of subdirectory to place sequence in (which is also used as the outputName and prefix)

numberDigits - the number of digits in the numeric part of the output-name.

selective - whether to check output-names against the rules or not. If not, all outputs will occur permissively.

OutputPatternIntegerSuffix

public OutputPatternIntegerSuffix(String outputName,
 String prefix,
 int numberDigits,
 boolean selective)

Like OutputPatternIntegerSuffix(String, String) but with additional options about the number of digits, and whether to check outputs against rules.

Parameters:

outputName - name of subdirectory to place sequence in (which is also used as the outputName and prefix)

prefix - a string that appears before the index in each outputted filename, with an underscore separating the prefix from the numeric index

numberDigits - the number of digits in the numeric part of the output-name.

selective - whether to check output-names against the rules or not. If not, all outputs will occur permissively.

OutputPatternIntegerSuffix

public OutputPatternIntegerSuffix(String outputName,
 boolean suppressSubdirectory,
 String prefix,
 int numberDigits,
 boolean selective)

Creates with a full set of flexibility about how the filename appears and whether a subdirectory is used.

Parameters:

outputName - the output-name to use, which also determines the subdirectory name if it is not suppressed.

suppressSubdirectory - if true, a separate subdirectory is not created, and rather the outputs occur in the parent directory.

prefix - a string that appears before the index in each outputted filename, with an underscore separating the prefix from the numeric index

numberDigits - the number of digits in the numeric part of the output-name.

selective - whether to check output-names against the rules or not. If not, all outputs will occur permissively.