us.temerity.pipeline.plugin
Class CommonActionUtils

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.CommonActionUtils

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

Direct Known Subclasses:

CompositeAction, CompositeActionUtils, CopyAction, CopyAction, DLEnvCubeAction, DLRenderAction, DLShaderAction, EnvCrossToSeqAction, ExtractSeqAction, HfsActionUtils, HfsOPLibsAction, HfsOPLibsMergeAction, JavaUtilityAction, ListSourcesAction, MayaMRayInitMELAction, MayaOccMELAction, MayaPartCacheGroupAction, MayaRemoveRefMELAction, MayaRenderGlobalsAction, MayaRenderGlobalsAction, MayaRenderGlobalsAction, MayaReRigMELAction, MayaShdCopyMELAction, MRayCamOverrideAction, MRayMakeShaderAction, MRayOptionsAction, MRayOptionsAction, MRayRenderGlobalsAction, MRayRenderGlobalsAction, MRayRenderGlobalsAction, MRayTexturePackAction, PythonActionUtils, ScriptAction, ShakeCompAction, ShakeThumbnailAction, ShakeThumbnailAction, SilhouetteBuildAction, SleepAction, SpliceAction, SwitchAction, TestAction, ThumbnailAction, TouchAction

public class CommonActionUtils
extends BaseAction

Superclass of most Action plugins which augments BaseAction with many commonly useful helper methods.

This class provides convenience methods for accessing and validating Action parameters, constructing node target/source related file system paths, creating subprocesses and other common operations performed inside the prep method of most Actions.

See Also:

Serialized Form

Field Summary

static String

aExtraOptions

Fields inherited from class us.temerity.pipeline.BasePlugin

pDescription

Fields inherited from class us.temerity.pipeline.PluginID

pVendor, pVersionID

Fields inherited from class us.temerity.pipeline.Named

pName

Constructor Summary

protected

CommonActionUtils(String name, VersionID vid, String vendor, String desc) Construct with the given name, version, vendor and description.

Method Summary

protected void	addExtraOptionsParam() Adds an additional command-line options parameter to the action.
protected void	addExtraOptionsParamToLayout(LayoutGroup layout) Add the parameter created by the addExtraOptionsParam method to the given parameter layout group.
SubProcessHeavy	createScriptSubProcess(ActionAgenda agenda, File script, File outFile, File errFile) A convienence method for creating the SubProcessHeavy instance to be returned by the prep method when generating a temporary script to execute some OS-specific commands.
SubProcessHeavy	createSubProcess(ActionAgenda agenda, String program, ArrayList<String> args, File outFile, File errFile) A convienence method for creating the SubProcessHeavy instance to be returned by the prep method in a mostly OS-independent manner.
SubProcessHeavy	createSubProcess(ActionAgenda agenda, String program, ArrayList<String> args, Map<String,String> env, File outFile, File errFile) A convienence method for creating the SubProcessHeavy instance to be returned by the prep method in a mostly OS-independent manner.
SubProcessHeavy	createSubProcess(ActionAgenda agenda, String program, ArrayList<String> args, Map<String,String> env, File dir, File outFile, File errFile) A convienence method for creating the SubProcessHeavy instance to be returned by the prep method in a mostly OS-independent manner.
SubProcessHeavy	createSubProcess(ActionAgenda agenda, String program, File outFile, File errFile) A convienence method for creating the SubProcessHeavy instance to be returned by the prep method in a mostly OS-independent manner.
SubProcessHeavy	createTempCopySubProcess(ActionAgenda agenda, File temp, Path target, File outFile, File errFile) A convienence method for creating the SubProcessHeavy instance to be returned by the prep method when simply copying a single temporary file created in the prep method to the target location.
File	createTempScript(ActionAgenda agenda) Create a unique temporary script file appropriate for the current operating system type.
static String	escPath(Path path) Convert an abstract file system path into an OS specific path string with any backslashes escaped.
static String	escPath(String str) Escape any backslashes in the given file system path string.
ArrayList<String>	getExtraOptionsArgs() Get any additional command-line arguments specified using the action parameter created by the addExtraOptionsParam method.
Path	getPrimarySourcePath(String pname, ActionAgenda agenda, Collection<String> suffixes, String desc) Get the abstract path to the single primary file associated with a source node specified by the given parameter.
Path	getPrimarySourcePath(String pname, ActionAgenda agenda, String desc) Get the abstract path to the single primary file associated with a source node specified by the given parameter.
Path	getPrimarySourcePath(String pname, ActionAgenda agenda, String suffix, String desc) Get the abstract path to the single primary file associated with a source node specified by the given parameter.
ArrayList<Path>	getPrimarySourcePaths(String pname, ActionAgenda agenda, Collection<String> suffixes, String desc) Get the abstract paths to the primary files associated with a source node specified by the given parameter.
ArrayList<Path>	getPrimarySourcePaths(String pname, ActionAgenda agenda, String desc) Get the abstract paths to the primary files associated with a source node specified by the given parameter.
ArrayList<Path>	getPrimarySourcePaths(String pname, ActionAgenda agenda, String suffix, String desc) Get the abstract paths to the primary files associated with a source node specified by the given parameter.
Path	getPrimaryTargetPath(ActionAgenda agenda, Collection<String> suffixes, String desc) Get the abstract path to the single primary file associated with a target node.
Path	getPrimaryTargetPath(ActionAgenda agenda, String desc) Get the abstract path to the single primary file associated with a target node.
Path	getPrimaryTargetPath(ActionAgenda agenda, String suffix, String desc) Get the abstract path to the single primary file associated with a target node.
ArrayList<Path>	getPrimaryTargetPaths(ActionAgenda agenda, Collection<String> suffixes, String desc) Get the abstract paths to the primary files associated with a target node.
ArrayList<Path>	getPrimaryTargetPaths(ActionAgenda agenda, String desc) Get the abstract paths to the primary files associated with a target node.
ArrayList<Path>	getPrimaryTargetPaths(ActionAgenda agenda, String suffix, String desc) Get the abstract paths to the primary files associated with a target node.
boolean	getSecondarySourceBooleanParamValue(String source, FilePattern fpat, String name) Get the value of the single valued non-null secondary source Boolean parameter with the given name.
double	getSecondarySourceDoubleParamValue(String source, FilePattern fpat, String name) Get the value of the single valued non-null secondary source Double parameter with the given name.
double	getSecondarySourceDoubleParamValue(String source, FilePattern fpat, String name, Range<Double> range) Get the bounds checked value of the single valued non-null secondary source Double parameter with the given name.
int	getSecondarySourceEnumParamIndex(String source, FilePattern fpat, String name) Get the selected index of the single valued secondary source Enum parameter with the given name.
int	getSecondarySourceIntegerParamValue(String source, FilePattern fpat, String name) Get the value of the single valued non-null secondary source Integer parameter with the given name.
int	getSecondarySourceIntegerParamValue(String source, FilePattern fpat, String name, Range<Integer> range) Get the bounds checked value of the single valued non-null secondary source Integer parameter with the given name.
long	getSecondarySourceLongParamValue(String source, FilePattern fpat, String name) Get the value of the single valued non-null secondary source Long parameter with the given name.
long	getSecondarySourceLongParamValue(String source, FilePattern fpat, String name, Range<Long> range) Get the bounds checked value of the single valued non-null secondary source Long parameter with the given name.
boolean	getSecondarySourceOptionalBooleanParamValue(String source, FilePattern fpat, String name) Get the value of the single valued secondary source Boolean parameter with the given name.
String	getSecondarySourceStringParamValue(String source, FilePattern fpat, String name) Get the value of the single valued secondary source String parameter with the given name.
String	getSecondarySourceStringParamValue(String source, FilePattern fpat, String name, boolean allowsNull) Get the value of the single valued secondary source String parameter with the given name.
boolean	getSingleBooleanParamValue(String name) Get the value of the single valued non-null Boolean parameter with the given name.
double	getSingleDoubleParamValue(String name) Get the value of the single valued non-null Double parameter with the given name.
double	getSingleDoubleParamValue(String name, Range<Double> range) Get the bounds checked value of the single valued non-null Double parameter with the given name.
int	getSingleEnumParamIndex(String name) Get the selected index of the single valued Enum parameter with the given name.
int	getSingleIntegerParamValue(String name) Get the value of the single valued non-null Integer parameter with the given name.
int	getSingleIntegerParamValue(String name, Range<Integer> range) Get the bounds checked value of the single valued non-null Integer parameter with the given name.
long	getSingleLongParamValue(String name) Get the value of the single valued non-null Long parameter with the given name.
long	getSingleLongParamValue(String name, Range<Long> range) Get the bounds checked value of the single valued non-null Long parameter with the given name.
boolean	getSingleOptionalBooleanParamValue(String name) Get the value of the single valued Boolean parameter with the given name.
String	getSingleStringParamValue(String name) Get the value of the single valued String parameter with the given name.
String	getSingleStringParamValue(String name, boolean allowsNull) Get the value of the single valued String parameter with the given name.
Tuple2d	getSingleTuple2dParamValue(String name) Get the value of the single valued non-null Tuple2d parameter with the given name.
Tuple2d	getSingleTuple2dParamValue(String name, boolean allowsNull) Get the value of the single valued Tuple2d parameter with the given name.
Tuple2d	getSingleTuple2dParamValue(String name, Range<Tuple2d> range, boolean allowsNull) Get the bounds checked value of the single valued Tuple2d parameter with the given name.
Tuple2i	getSingleTuple2iParamValue(String name) Get the value of the single valued non-null Tuple2i parameter with the given name.
Tuple2i	getSingleTuple2iParamValue(String name, boolean allowsNull) Get the value of the single valued Tuple2i parameter with the given name.
Tuple2i	getSingleTuple2iParamValue(String name, Range<Tuple2i> range, boolean allowsNull) Get the bounds checked value of the single valued Tuple2i parameter with the given name.
Tuple3d	getSingleTuple3dParamValue(String name) Get the value of the single valued non-null Tuple3d parameter with the given name.
Tuple3d	getSingleTuple3dParamValue(String name, boolean allowsNull) Get the value of the single valued Tuple3d parameter with the given name.
Tuple3d	getSingleTuple3dParamValue(String name, Range<Tuple3d> range, boolean allowsNull) Get the bounds checked value of the single valued Tuple3d parameter with the given name.
Tuple3i	getSingleTuple3iParamValue(String name) Get the value of the single valued non-null Tuple3i parameter with the given name.
Tuple3i	getSingleTuple3iParamValue(String name, boolean allowsNull) Get the value of the single valued Tuple3i parameter with the given name.
Tuple3i	getSingleTuple3iParamValue(String name, Range<Tuple3i> range, boolean allowsNull) Get the bounds checked value of the single valued Tuple3i parameter with the given name.
Tuple4d	getSingleTuple4dParamValue(String name) Get the value of the single valued non-null Tuple4d parameter with the given name.
Tuple4d	getSingleTuple4dParamValue(String name, boolean allowsNull) Get the value of the single valued Tuple4d parameter with the given name.
Tuple4d	getSingleTuple4dParamValue(String name, Range<Tuple4d> range, boolean allowsNull) Get the bounds checked value of the single valued Tuple4d parameter with the given name.
boolean	getSourceBooleanParamValue(String source, String name) Get the value of the single valued non-null source Boolean parameter with the given name.
double	getSourceDoubleParamValue(String source, String name) Get the value of the single valued non-null source Double parameter with the given name.
double	getSourceDoubleParamValue(String source, String name, Range<Double> range) Get the bounds checked value of the single valued non-null source Double parameter with the given name.
int	getSourceEnumParamIndex(String source, String name) Get the selected index of the single valued source Enum parameter with the given name.
int	getSourceIntegerParamValue(String source, String name) Get the value of the single valued non-null source Integer parameter with the given name.
int	getSourceIntegerParamValue(String source, String name, Range<Integer> range) Get the bounds checked value of the single valued non-null source Integer parameter with the given name.
long	getSourceLongParamValue(String source, String name) Get the value of the single valued non-null source Long parameter with the given name.
long	getSourceLongParamValue(String source, String name, Range<Long> range) Get the bounds checked value of the single valued non-null source Long parameter with the given name.
boolean	getSourceOptionalBooleanParamValue(String source, String name) Get the value of the single valued source Boolean parameter with the given name.
String	getSourceStringParamValue(String source, String name) Get the value of the single valued source String parameter with the given name.
String	getSourceStringParamValue(String source, String name, boolean allowsNull) Get the value of the single valued source String parameter with the given name.
static Path	getWorkingNodeFilePath(ActionAgenda agenda, String name, FileSeq fseq) Get the abstract working area file system path to the first file in the given node file sequence.
static Path	getWorkingNodeFilePath(ActionAgenda agenda, String name, Path file) Get the abstract working area file system path to the given node file.
static Path	getWorkingNodeFilePath(NodeID nodeID, Path file) Get the abstract working area file system path to the given node file.
static Path	getWorkingNodeFilePath(NodeID nodeID, String file) Get the abstract working area file system path to the given node file.
static ArrayList<Path>	getWorkingNodeFilePaths(ActionAgenda agenda, String name, FileSeq fseq) Get the abstract working area file system paths in the given node file sequence.

Methods inherited from class us.temerity.pipeline.BaseAction

addPreset, addPresetValues, addSingleParam, chmod, cleanupLater, clearAllLinkParams, clearLinkParams, clone, createTemp, createTemp, equals, equalSingleParams, equalSourceParams, fromGlue, getInitialSourceParams, getPluginType, getPresetChoices, getPresetValues, getSecondarySequences, getSecondarySourceNames, getSecondarySourceParam, getSecondarySourceParams, getSecondarySourceParamValue, getSingleLayout, getSingleParam, getSingleParams, getSingleParamValue, getSourceLayout, getSourceNames, getSourceParam, getSourceParams, getSourceParamValue, getTempDir, getTempPath, hasSecondarySourceParams, hasSingleParams, hasSourceParams, initSecondarySourceParams, initSourceParams, prep, removeAllSourceParams, removeSecondarySourceParams, removeSecondarySourceParams, removeSourceParams, setSecondarySourceParamValue, setSingleLayout, setSingleParamValue, setSingleParamValues, setSourceLayout, setSourceParamValue, setSourceParamValues, supportsSourceParams, toGlue

Methods inherited from class us.temerity.pipeline.BasePlugin

addSupport, compareTo, getDescription, getFullMessage, getPluginID, getResource, getResources, getResourceSize, getSupports, isUnderDevelopment, removeSupport, setSupports, supports, toString, underDevelopment

Methods inherited from class us.temerity.pipeline.PluginID

getVendor, getVersionID

Methods inherited from class us.temerity.pipeline.Named

getName

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

aExtraOptions

public static final String aExtraOptions

See Also:

Constant Field Values

Constructor Detail

CommonActionUtils

protected CommonActionUtils(String name,
                            VersionID vid,
                            String vendor,
                            String desc)

Construct with the given name, version, vendor and description.

Parameters:

name - The short name of the action.

vid - The action plugin revision number.

vendor - The name of the plugin vendor.

desc - A short description of the action.

Method Detail

getWorkingNodeFilePaths

public static final ArrayList<Path> getWorkingNodeFilePaths(ActionAgenda agenda,
                                                            String name,
                                                            FileSeq fseq)

Get the abstract working area file system paths in the given node file sequence.

Parameters:

agenda - The agenda to be accomplished by the action.

name - The unique node name.

fseq - The file sequence associated with the node.

getWorkingNodeFilePath

public static final Path getWorkingNodeFilePath(ActionAgenda agenda,
                                                String name,
                                                FileSeq fseq)

Get the abstract working area file system path to the first file in the given node file sequence.

Parameters:

agenda - The agenda to be accomplished by the action.

name - The unique node name.

fseq - The file sequence associated with the node.

getWorkingNodeFilePath

public static final Path getWorkingNodeFilePath(ActionAgenda agenda,
                                                String name,
                                                Path file)

Get the abstract working area file system path to the given node file.

Parameters:

agenda - The agenda to be accomplished by the action.

name - The unique node name.

file - The name of the file relative to the directory containing the node.

getWorkingNodeFilePath

public static final Path getWorkingNodeFilePath(NodeID nodeID,
                                                Path file)

Get the abstract working area file system path to the given node file.

Parameters:

nodeID - The unique working version identifier.

file - The name of the file relative to the directory containing the node.

getWorkingNodeFilePath

public static final Path getWorkingNodeFilePath(NodeID nodeID,
                                                String file)

Get the abstract working area file system path to the given node file.

Parameters:

nodeID - The unique working version identifier.

file - The name of the file relative to the directory containing the node.

createTempScript

public final File createTempScript(ActionAgenda agenda)
                            throws PipelineException

Create a unique temporary script file appropriate for the current operating system type.

On Unix/MacOS this will be an bash(1) script, while on Windows the script will be a BAT file suitable for evaluation by "Cmd". The returned script file is suitable for use as with the createScriptSubProcess method.

Parameters:

agenda - The agenda to be accomplished by the action.

Throws:

PipelineException

addExtraOptionsParam

protected final void addExtraOptionsParam()

Adds an additional command-line options parameter to the action.

The following single valued parameters is added:

Extra Options

Additional command-line arguments.

This method should be called in the subclass constructor before specifying parameter layouts.

addExtraOptionsParamToLayout

protected final void addExtraOptionsParamToLayout(LayoutGroup layout)

Add the parameter created by the addExtraOptionsParam method to the given parameter layout group.

getExtraOptionsArgs

public final ArrayList<String> getExtraOptionsArgs()
                                            throws PipelineException

Get any additional command-line arguments specified using the action parameter created by the addExtraOptionsParam method.

Throws:

PipelineException

getSingleEnumParamIndex

public final int getSingleEnumParamIndex(String name)
                                  throws PipelineException

Get the selected index of the single valued Enum parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists.

getSingleBooleanParamValue

public final boolean getSingleBooleanParamValue(String name)
                                         throws PipelineException

Get the value of the single valued non-null Boolean parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists.

getSingleOptionalBooleanParamValue

public final boolean getSingleOptionalBooleanParamValue(String name)
                                                 throws PipelineException

Get the value of the single valued Boolean parameter with the given name.

If null value is treated as false.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists.

getSingleLongParamValue

public final long getSingleLongParamValue(String name)
                                   throws PipelineException

Get the value of the single valued non-null Long parameter with the given name.

This method can be used to retrieve ByteSizeActionParam values.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null.

getSingleLongParamValue

public final long getSingleLongParamValue(String name,
                                          Range<Long> range)
                                   throws PipelineException

Get the bounds checked value of the single valued non-null Long parameter with the given name.

This method can also be used to retrieve ByteSizeActionParam values.

Parameters:

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists, the value is null or is out-of-bounds.

getSingleIntegerParamValue

public final int getSingleIntegerParamValue(String name)
                                     throws PipelineException

Get the value of the single valued non-null Integer parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null.

getSingleIntegerParamValue

public final int getSingleIntegerParamValue(String name,
                                            Range<Integer> range)
                                     throws PipelineException

Get the bounds checked value of the single valued non-null Integer parameter with the given name.

Parameters:

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists, the value is null or is out-of-bounds.

getSingleTuple2iParamValue

public final Tuple2i getSingleTuple2iParamValue(String name)
                                         throws PipelineException

Get the value of the single valued non-null Tuple2i parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null.

getSingleTuple2iParamValue

public final Tuple2i getSingleTuple2iParamValue(String name,
                                                boolean allowsNull)
                                         throws PipelineException

Get the value of the single valued Tuple2i parameter with the given name.

Parameters:

name - The name of the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null and allowsNull is false.

getSingleTuple2iParamValue

public final Tuple2i getSingleTuple2iParamValue(String name,
                                                Range<Tuple2i> range,
                                                boolean allowsNull)
                                         throws PipelineException

Get the bounds checked value of the single valued Tuple2i parameter with the given name.

Parameters:

name - The name of the parameter.

range - The valid range values for the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists, the value is null or is out-of-bounds.

getSingleTuple3iParamValue

public final Tuple3i getSingleTuple3iParamValue(String name)
                                         throws PipelineException

Get the value of the single valued non-null Tuple3i parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null.

getSingleTuple3iParamValue

public final Tuple3i getSingleTuple3iParamValue(String name,
                                                boolean allowsNull)
                                         throws PipelineException

Get the value of the single valued Tuple3i parameter with the given name.

Parameters:

name - The name of the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null and allowsNull is false.

getSingleTuple3iParamValue

public final Tuple3i getSingleTuple3iParamValue(String name,
                                                Range<Tuple3i> range,
                                                boolean allowsNull)
                                         throws PipelineException

Get the bounds checked value of the single valued Tuple3i parameter with the given name.

Parameters:

name - The name of the parameter.

range - The valid range values for the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists, the value is null or is out-of-bounds.

getSingleDoubleParamValue

public final double getSingleDoubleParamValue(String name)
                                       throws PipelineException

Get the value of the single valued non-null Double parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null.

getSingleDoubleParamValue

public final double getSingleDoubleParamValue(String name,
                                              Range<Double> range)
                                       throws PipelineException

Get the bounds checked value of the single valued non-null Double parameter with the given name.

Parameters:

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists, the value is null or is out-of-bounds.

getSingleTuple2dParamValue

public final Tuple2d getSingleTuple2dParamValue(String name)
                                         throws PipelineException

Get the value of the single valued non-null Tuple2d parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null.

getSingleTuple2dParamValue

public final Tuple2d getSingleTuple2dParamValue(String name,
                                                boolean allowsNull)
                                         throws PipelineException

Get the value of the single valued Tuple2d parameter with the given name.

Parameters:

name - The name of the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null and allowsNull is false.

getSingleTuple2dParamValue

public final Tuple2d getSingleTuple2dParamValue(String name,
                                                Range<Tuple2d> range,
                                                boolean allowsNull)
                                         throws PipelineException

Get the bounds checked value of the single valued Tuple2d parameter with the given name.

Parameters:

name - The name of the parameter.

range - The valid range values for the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists, the value is null or is out-of-bounds.

getSingleTuple3dParamValue

public final Tuple3d getSingleTuple3dParamValue(String name)
                                         throws PipelineException

Get the value of the single valued non-null Tuple3d parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null.

getSingleTuple3dParamValue

public final Tuple3d getSingleTuple3dParamValue(String name,
                                                boolean allowsNull)
                                         throws PipelineException

Get the value of the single valued Tuple3d parameter with the given name.

Parameters:

name - The name of the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null and allowsNull is false.

getSingleTuple3dParamValue

public final Tuple3d getSingleTuple3dParamValue(String name,
                                                Range<Tuple3d> range,
                                                boolean allowsNull)
                                         throws PipelineException

Get the bounds checked value of the single valued Tuple3d parameter with the given name.

Parameters:

name - The name of the parameter.

range - The valid range values for the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists, the value is null or is out-of-bounds.

getSingleTuple4dParamValue

public final Tuple4d getSingleTuple4dParamValue(String name)
                                         throws PipelineException

Get the value of the single valued non-null Tuple4d parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null.

getSingleTuple4dParamValue

public final Tuple4d getSingleTuple4dParamValue(String name,
                                                boolean allowsNull)
                                         throws PipelineException

Get the value of the single valued Tuple4d parameter with the given name.

Parameters:

name - The name of the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists or the value is null and allowsNull is false.

getSingleTuple4dParamValue

public final Tuple4d getSingleTuple4dParamValue(String name,
                                                Range<Tuple4d> range,
                                                boolean allowsNull)
                                         throws PipelineException

Get the bounds checked value of the single valued Tuple4d parameter with the given name.

Parameters:

name - The name of the parameter.

range - The valid range values for the parameter.

allowsNull - Whether this parameter can have a null value.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued parameter with the given name exists, the value is null or is out-of-bounds.

getSingleStringParamValue

public final String getSingleStringParamValue(String name,
                                              boolean allowsNull)
                                       throws PipelineException

Get the value of the single valued String parameter with the given name.

Parameters:

name - The name of the parameter.

allowsNull - Whether this parameter can have a null or empty value.

Returns:

The action parameter value or (optionally) null if the value is null or the empty string.

Throws:

PipelineException - If no single valued parameter with the given name exists or (optionally) if the value is null or empty.

getSingleStringParamValue

public final String getSingleStringParamValue(String name)
                                       throws PipelineException

Get the value of the single valued String parameter with the given name.

Parameters:

name - The name of the parameter.

Returns:

The action parameter value or null if the value is null or the empty string.

Throws:

PipelineException - If no single valued parameter with the given name exists

getSourceEnumParamIndex

public final int getSourceEnumParamIndex(String source,
                                         String name)
                                  throws PipelineException

Get the selected index of the single valued source Enum parameter with the given name.

Parameters:

source - The name of the source.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists.

getSourceBooleanParamValue

public final boolean getSourceBooleanParamValue(String source,
                                                String name)
                                         throws PipelineException

Get the value of the single valued non-null source Boolean parameter with the given name.

Parameters:

source - The name of the source.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists.

getSourceOptionalBooleanParamValue

public final boolean getSourceOptionalBooleanParamValue(String source,
                                                        String name)
                                                 throws PipelineException

Get the value of the single valued source Boolean parameter with the given name.

If null value is treated as false.

Parameters:

source - The name of the source.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists.

getSourceLongParamValue

public final long getSourceLongParamValue(String source,
                                          String name)
                                   throws PipelineException

Get the value of the single valued non-null source Long parameter with the given name.

This method can be used to retrieve ByteSizeActionParam values.

Parameters:

source - The name of the source.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists or the value is null.

getSourceLongParamValue

public final long getSourceLongParamValue(String source,
                                          String name,
                                          Range<Long> range)
                                   throws PipelineException

Get the bounds checked value of the single valued non-null source Long parameter with the given name.

This method can also be used to retrieve ByteSizeActionParam values.

Parameters:

source - The name of the source.

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists, the value is null or is out-of-bounds.

getSourceIntegerParamValue

public final int getSourceIntegerParamValue(String source,
                                            String name)
                                     throws PipelineException

Get the value of the single valued non-null source Integer parameter with the given name.

Parameters:

source - The name of the source.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists or the value is null.

getSourceIntegerParamValue

public final int getSourceIntegerParamValue(String source,
                                            String name,
                                            Range<Integer> range)
                                     throws PipelineException

Get the bounds checked value of the single valued non-null source Integer parameter with the given name.

Parameters:

source - The name of the source.

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists, the value is null or is out-of-bounds.

getSourceDoubleParamValue

public final double getSourceDoubleParamValue(String source,
                                              String name)
                                       throws PipelineException

Get the value of the single valued non-null source Double parameter with the given name.

Parameters:

source - The name of the source.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists or the value is null.

getSourceDoubleParamValue

public final double getSourceDoubleParamValue(String source,
                                              String name,
                                              Range<Double> range)
                                       throws PipelineException

Get the bounds checked value of the single valued non-null source Double parameter with the given name.

Parameters:

source - The name of the source.

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued source parameter with the given name exists, the value is null or is out-of-bounds.

getSourceStringParamValue

public final String getSourceStringParamValue(String source,
                                              String name,
                                              boolean allowsNull)
                                       throws PipelineException

Get the value of the single valued source String parameter with the given name.

Parameters:

source - The name of the source.

name - The name of the parameter.

allowsNull - Whether this parameter can have a null or empty value.

Returns:

The action parameter value or (optionally) null if the value is null or the empty string.

Throws:

PipelineException - If no single valued source parameter with the given name exists or (optionally) if the value is null or empty.

getSourceStringParamValue

public final String getSourceStringParamValue(String source,
                                              String name)
                                       throws PipelineException

Get the value of the single valued source String parameter with the given name.

Parameters:

source - The name of the source.

name - The name of the parameter.

Returns:

The action parameter value or null if the value is null or the empty string.

Throws:

PipelineException - If no single valued source parameter with the given name exists

getSecondarySourceEnumParamIndex

public final int getSecondarySourceEnumParamIndex(String source,
                                                  FilePattern fpat,
                                                  String name)
                                           throws PipelineException

Get the selected index of the single valued secondary source Enum parameter with the given name.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists.

getSecondarySourceBooleanParamValue

public final boolean getSecondarySourceBooleanParamValue(String source,
                                                         FilePattern fpat,
                                                         String name)
                                                  throws PipelineException

Get the value of the single valued non-null secondary source Boolean parameter with the given name.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists.

getSecondarySourceOptionalBooleanParamValue

public final boolean getSecondarySourceOptionalBooleanParamValue(String source,
                                                                 FilePattern fpat,
                                                                 String name)
                                                          throws PipelineException

Get the value of the single valued secondary source Boolean parameter with the given name.

If null value is treated as false.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists.

getSecondarySourceLongParamValue

public final long getSecondarySourceLongParamValue(String source,
                                                   FilePattern fpat,
                                                   String name)
                                            throws PipelineException

Get the value of the single valued non-null secondary source Long parameter with the given name.

This method can be used to retrieve ByteSizeActionParam values.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists or the value is null.

getSecondarySourceLongParamValue

public final long getSecondarySourceLongParamValue(String source,
                                                   FilePattern fpat,
                                                   String name,
                                                   Range<Long> range)
                                            throws PipelineException

Get the bounds checked value of the single valued non-null secondary source Long parameter with the given name.

This method can also be used to retrieve ByteSizeActionParam values.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists, the value is null or is out-of-bounds.

getSecondarySourceIntegerParamValue

public final int getSecondarySourceIntegerParamValue(String source,
                                                     FilePattern fpat,
                                                     String name)
                                              throws PipelineException

Get the value of the single valued non-null secondary source Integer parameter with the given name.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists or the value is null.

getSecondarySourceIntegerParamValue

public final int getSecondarySourceIntegerParamValue(String source,
                                                     FilePattern fpat,
                                                     String name,
                                                     Range<Integer> range)
                                              throws PipelineException

Get the bounds checked value of the single valued non-null secondary source Integer parameter with the given name.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists, the value is null or is out-of-bounds.

getSecondarySourceDoubleParamValue

public final double getSecondarySourceDoubleParamValue(String source,
                                                       FilePattern fpat,
                                                       String name)
                                                throws PipelineException

Get the value of the single valued non-null secondary source Double parameter with the given name.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists or the value is null.

getSecondarySourceDoubleParamValue

public final double getSecondarySourceDoubleParamValue(String source,
                                                       FilePattern fpat,
                                                       String name,
                                                       Range<Double> range)
                                                throws PipelineException

Get the bounds checked value of the single valued non-null secondary source Double parameter with the given name.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

range - The valid range values for the parameter.

Returns:

The action parameter value.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists, the value is null or is out-of-bounds.

getSecondarySourceStringParamValue

public final String getSecondarySourceStringParamValue(String source,
                                                       FilePattern fpat,
                                                       String name,
                                                       boolean allowsNull)
                                                throws PipelineException

Get the value of the single valued secondary source String parameter with the given name.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

allowsNull - Whether this parameter can have a null or empty value.

Returns:

The action parameter value or (optionally) null if the value is null or the empty string.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists or (optionally) if the value is null or empty.

getSecondarySourceStringParamValue

public final String getSecondarySourceStringParamValue(String source,
                                                       FilePattern fpat,
                                                       String name)
                                                throws PipelineException

Get the value of the single valued secondary source String parameter with the given name.

Parameters:

source - The name of the source.

fpat - The FilePattern of the Secondary Sequence.

name - The name of the parameter.

Returns:

The action parameter value or null if the value is null or the empty string.

Throws:

PipelineException - If no single valued secondary source parameter with the given name exists.

escPath

public static final String escPath(String str)

Escape any backslashes in the given file system path string.

escPath

public static final String escPath(Path path)

Convert an abstract file system path into an OS specific path string with any backslashes escaped.

getPrimaryTargetPaths

public final ArrayList<Path> getPrimaryTargetPaths(ActionAgenda agenda,
                                                   String desc)
                                            throws PipelineException

Get the abstract paths to the primary files associated with a target node.

Parameters:

agenda - The agenda to be accomplished by the action.

desc - A brief description of the type of files expected (used to generate error messages).

Returns:

The paths to the target files.

Throws:

PipelineException

getPrimaryTargetPaths

public final ArrayList<Path> getPrimaryTargetPaths(ActionAgenda agenda,
                                                   String suffix,
                                                   String desc)
                                            throws PipelineException

Get the abstract paths to the primary files associated with a target node.

Parameters:

agenda - The agenda to be accomplished by the action.

suffix - The allowable filename suffix.

desc - A brief description of the type of files expected (used to generate error messages).

Returns:

The paths to the target files.

Throws:

PipelineException

getPrimaryTargetPaths

public final ArrayList<Path> getPrimaryTargetPaths(ActionAgenda agenda,
                                                   Collection<String> suffixes,
                                                   String desc)
                                            throws PipelineException

Get the abstract paths to the primary files associated with a target node.

Parameters:

agenda - The agenda to be accomplished by the action.

suffixes - The allowable filename suffixes.

desc - A brief description of the type of files expected (used to generate error messages).

Returns:

The paths to the target files.

Throws:

PipelineException

getPrimaryTargetPath

public final Path getPrimaryTargetPath(ActionAgenda agenda,
                                       String desc)
                                throws PipelineException

Get the abstract path to the single primary file associated with a target node.

Parameters:

agenda - The agenda to be accomplished by the action.

desc - A brief description of the type of file expected (used to generate error messages).

Returns:

The path to the target file.

Throws:

PipelineException

getPrimaryTargetPath

public final Path getPrimaryTargetPath(ActionAgenda agenda,
                                       String suffix,
                                       String desc)
                                throws PipelineException

Get the abstract path to the single primary file associated with a target node.

Parameters:

agenda - The agenda to be accomplished by the action.

suffix - The allowable filename suffix.

desc - A brief description of the type of file expected (used to generate error messages).

Returns:

The path to the target file.

Throws:

PipelineException

getPrimaryTargetPath

public final Path getPrimaryTargetPath(ActionAgenda agenda,
                                       Collection<String> suffixes,
                                       String desc)
                                throws PipelineException

Get the abstract path to the single primary file associated with a target node.

Parameters:

agenda - The agenda to be accomplished by the action.

suffixes - The allowable filename suffixes.

desc - A brief description of the type of file expected (used to generate error messages).

Returns:

The path to the target file.

Throws:

PipelineException

getPrimarySourcePaths

public final ArrayList<Path> getPrimarySourcePaths(String pname,
                                                   ActionAgenda agenda,
                                                   String desc)
                                            throws PipelineException

Get the abstract paths to the primary files associated with a source node specified by the given parameter.

Parameters:

pname - The name of the single valued parameter which names the source node.

agenda - The agenda to be accomplished by the action.

desc - A brief description of the type of files expected (used to generate error messages).

Returns:

The paths to the primary files of the source node or null if none was specified.

Throws:

PipelineException

getPrimarySourcePaths

public final ArrayList<Path> getPrimarySourcePaths(String pname,
                                                   ActionAgenda agenda,
                                                   String suffix,
                                                   String desc)
                                            throws PipelineException

Get the abstract paths to the primary files associated with a source node specified by the given parameter.

Parameters:

pname - The name of the single valued parameter which names the source node.

agenda - The agenda to be accomplished by the action.

suffix - The allowable filename suffix.

desc - A brief description of the type of files expected (used to generate error messages).

Returns:

The paths to the primary files of the source node or null if none was specified.

Throws:

PipelineException

getPrimarySourcePaths

public final ArrayList<Path> getPrimarySourcePaths(String pname,
                                                   ActionAgenda agenda,
                                                   Collection<String> suffixes,
                                                   String desc)
                                            throws PipelineException

Get the abstract paths to the primary files associated with a source node specified by the given parameter.

Parameters:

pname - The name of the single valued parameter which names the source node.

agenda - The agenda to be accomplished by the action.

suffixes - The allowable filename suffixes.

desc - A brief description of the type of files expected (used to generate error messages).

Returns:

The paths to the primary files of the source node or null if none was specified.

Throws:

PipelineException

getPrimarySourcePath

public final Path getPrimarySourcePath(String pname,
                                       ActionAgenda agenda,
                                       String desc)
                                throws PipelineException

Get the abstract path to the single primary file associated with a source node specified by the given parameter.

Parameters:

pname - The name of the single valued parameter which names the source node.

agenda - The agenda to be accomplished by the action.

desc - A brief description of the type of file expected (used to generate error messages).

Returns:

The path to the primary file of the source node or null if none was specified.

Throws:

PipelineException

getPrimarySourcePath

public final Path getPrimarySourcePath(String pname,
                                       ActionAgenda agenda,
                                       String suffix,
                                       String desc)
                                throws PipelineException

Get the abstract path to the single primary file associated with a source node specified by the given parameter.

Parameters:

pname - The name of the single valued parameter which names the source node.

agenda - The agenda to be accomplished by the action.

suffix - The allowable filename suffix.

desc - A brief description of the type of file expected (used to generate error messages).

Returns:

The path to the primary file of the source node or null if none was specified.

Throws:

PipelineException

getPrimarySourcePath

public final Path getPrimarySourcePath(String pname,
                                       ActionAgenda agenda,
                                       Collection<String> suffixes,
                                       String desc)
                                throws PipelineException

Get the abstract path to the single primary file associated with a source node specified by the given parameter.

Parameters:

pname - The name of the single valued parameter which names the source node.

agenda - The agenda to be accomplished by the action.

suffixes - The allowable filename suffixes.

desc - A brief description of the type of file expected (used to generate error messages).

Returns:

The path to the primary file of the source node or null if none was specified.

Throws:

PipelineException

createSubProcess

public final SubProcessHeavy createSubProcess(ActionAgenda agenda,
                                              String program,
                                              File outFile,
                                              File errFile)
                                       throws PipelineException

A convienence method for creating the SubProcessHeavy instance to be returned by the prep method in a mostly OS-independent manner.

The caller is reponsible for handling any differences in program name and arguments between the different operating system types, but this method will handle specifying the process owner, title, environment and working directory.

When run on a Unix or MacOS system, the working directory is the working area directory containing the target node. On Windows, the working directory is always the local temporary directory since many Windows programs fail if the working directory in on a network share. The caller is responsible for making any target file paths relative to the working directory on Unix/MacOS and absolute on Windows. The correct path for target files can be obtained using the ActionAgenda.getTargetPath method.

Parameters:

agenda - The agenda to be accomplished by the Action.

program - The name of program to execute as an OS level subprocess.

outFile - The file to which all STDOUT output is redirected.

errFile - The file to which all STDERR output is redirected.

Throws:

PipelineException

createSubProcess

public final SubProcessHeavy createSubProcess(ActionAgenda agenda,
                                              String program,
                                              ArrayList<String> args,
                                              File outFile,
                                              File errFile)
                                       throws PipelineException

A convienence method for creating the SubProcessHeavy instance to be returned by the prep method in a mostly OS-independent manner.

The caller is reponsible for handling any differences in program name and arguments between the different operating system types, but this method will handle specifying the process owner, title, environment and working directory.

When run on a Unix or MacOS system, the working directory is the working area directory containing the target node. On Windows, the working directory is always the local temporary directory since many Windows programs fail if the working directory in on a network share. The caller is responsible for making any target file paths relative to the working directory on Unix/MacOS and absolute on Windows. The correct path for target files can be obtained using the ActionAgenda.getTargetPath method.

Parameters:

agenda - The agenda to be accomplished by the Action.

program - The name of program to execute as an OS level subprocess.

args - The command line arguments of the program to execute or null for an empty argument list.

outFile - The file to which all STDOUT output is redirected.

errFile - The file to which all STDERR output is redirected.

Throws:

PipelineException

createSubProcess

public final SubProcessHeavy createSubProcess(ActionAgenda agenda,
                                              String program,
                                              ArrayList<String> args,
                                              Map<String,String> env,
                                              File outFile,
                                              File errFile)
                                       throws PipelineException

A convienence method for creating the SubProcessHeavy instance to be returned by the prep method in a mostly OS-independent manner.

The caller is reponsible for handling any differences in program name and arguments between the different operating system types, but this method will handle specifying the process owner, title, environment and working directory. The default Toolset generated environment can be overridden if specified using a non-null env parameter.

When run on a Unix or MacOS system, the working directory is the working area directory containing the target node. On Windows, the working directory is always the local temporary directory since many Windows programs fail if the working directory in on a network share. The caller is responsible for making any target file paths relative to the working directory on Unix/MacOS and absolute on Windows. The correct path for target files can be obtained using the ActionAgenda.getTargetPath method.

Parameters:

agenda - The agenda to be accomplished by the Action.

program - The name of program to execute as an OS level subprocess.

args - The command line arguments of the program to execute or null for an empty argument list.

env - The environment under which the OS level process is run or null to use the environment defined by the ActionAgenda.

outFile - The file to which all STDOUT output is redirected.

errFile - The file to which all STDERR output is redirected.

Throws:

PipelineException

createSubProcess

public final SubProcessHeavy createSubProcess(ActionAgenda agenda,
                                              String program,
                                              ArrayList<String> args,
                                              Map<String,String> env,
                                              File dir,
                                              File outFile,
                                              File errFile)
                                       throws PipelineException

A convienence method for creating the SubProcessHeavy instance to be returned by the prep method in a mostly OS-independent manner.

The caller is reponsible for handling any differences in program name and arguments between the different operating system types, but this method will handle specifying the process owner, title, environment. The default Toolset generated environment can be overridden if specified using a non-null env parameter.

Parameters:

agenda - The agenda to be accomplished by the Action.

program - The name of program to execute as an OS level subprocess.

args - The command line arguments of the program to execute or null for an empty argument list.

env - The environment under which the OS level process is run or null to use the environment defined by the ActionAgenda.

dir - The working directory where the subprocess is run.

outFile - The file to which all STDOUT output is redirected.

errFile - The file to which all STDERR output is redirected.

Throws:

PipelineException

createScriptSubProcess

public final SubProcessHeavy createScriptSubProcess(ActionAgenda agenda,
                                                    File script,
                                                    File outFile,
                                                    File errFile)
                                             throws PipelineException

A convienence method for creating the SubProcessHeavy instance to be returned by the prep method when generating a temporary script to execute some OS-specific commands.

If running on Unix or MacOS, the supplied script must be a bash(1) shell script while on Windows the script must be an executable BAT/CMD file. The Action is reposible for making sure that the contents of these scripts are portable. This method simply takes care of the common wrapper code needed to instantiate a SubProcessHeavy to run the script.

Parameters:

agenda - The agenda to be accomplished by the Action.

script - The temporary script file to execute.

outFile - The file to which all STDOUT output is redirected.

errFile - The file to which all STDERR output is redirected.

Throws:

PipelineException

createTempCopySubProcess

public final SubProcessHeavy createTempCopySubProcess(ActionAgenda agenda,
                                                      File temp,
                                                      Path target,
                                                      File outFile,
                                                      File errFile)
                                               throws PipelineException

A convienence method for creating the SubProcessHeavy instance to be returned by the prep method when simply copying a single temporary file created in the prep method to the target location.

Parameters:

agenda - The agenda to be accomplished by the Action.

temp - The temporary file to copy.

target - The abtract path to the location of the target file.

outFile - The file to which all STDOUT output is redirected.

errFile - The file to which all STDERR output is redirected.

Throws:

PipelineException