public class OutputSequenceStackFactory extends Object
OutputSequence
of different kinds for writing stacks to a directory.Modifier and Type | Field and Description |
---|---|
static OutputSequenceStackFactory |
NO_RESTRICTIONS
A factory with no restrictions on what kind of stacks can be outputted.
|
Modifier and Type | Method and Description |
---|---|
static OutputSequenceStackFactory |
always2D()
The stacks that are outputted are guaranteed to be two-dimensional.
|
OutputSequenceIncrementing<Stack> |
incrementingByOne(String subdirectoryName,
OutputterChecked outputter)
Creates an sequence of stacks in a subdirectory with a number in the outputted file name that
increments each time by one.
|
OutputSequenceIndexed<Stack,String> |
withoutOrderCurrentDirectory(String outputName,
OutputterChecked outputter)
Creates a sequence of stacks in the current context's directory that has no pattern.
|
void |
withoutOrderSubset(NamedProvider<Stack> stacks,
String outputName,
boolean suppressSubdirectory,
OutputterChecked outputter)
Writes all or a subset from a set of named-stacks to a directory.
|
public static final OutputSequenceStackFactory NO_RESTRICTIONS
public static OutputSequenceStackFactory always2D()
public OutputSequenceIncrementing<Stack> incrementingByOne(String subdirectoryName, OutputterChecked outputter) throws OutputWriteFailedException
subdirectoryName
- the name of the subdirectory in which stacks will be written
(relative to context
.outputter
- determines where and how the outputting occursOutputWriteFailedException
- if any output fails to be successfully written.public OutputSequenceIndexed<Stack,String> withoutOrderCurrentDirectory(String outputName, OutputterChecked outputter) throws OutputWriteFailedException
outputter
- determines where and how the outputting occursoutputName
- name to use for the directory, for checking if it is allowed, and for the
second-level outputs.OutputWriteFailedException
- if any output fails to be successfully written.public void withoutOrderSubset(NamedProvider<Stack> stacks, String outputName, boolean suppressSubdirectory, OutputterChecked outputter) throws OutputWriteFailedException
A second-level output manager filters which stacks are written.
stacks
- the stacks to output (or a subset thereof according to the second-level output
manager).outputName
- name to use for the directory, for checking if it is allowed, and for the
second-level outputs.suppressSubdirectory
- if true, a separate subdirectory is not created, and rather the
outputs occur in the parent directory.outputter
- determines where and how the outputting occurs.OutputWriteFailedException
- if any output fails to be successfully written.Copyright © 2010–2023 Owen Feehan, ETH Zurich, University of Zurich, Hoffmann-La Roche. All rights reserved.