Package adams.flow.transformer

Class CopyFile

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, MultiAttemptSupporter, MultiAttemptWithWaitSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class CopyFile
extends AbstractTransformer
implements MultiAttemptWithWaitSupporter
    Copies the file received on its input port to the target directory if it matches the provided regular expression.
    In case of a directory, the directory gets copied recursively.
    If required, you can also provide a new filename (just the name, no path).
    The generated target file/directory gets forwarded in the flow.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       java.lang.String
       java.io.File


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: CopyFile
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -create-sub-dirs <boolean> (property: createSubDirectories)
    If set to true, sub directories from the last path component of the inputs 
    are created below the target directory (eg: /some/where/blah -> TARGET/blah
    ).
    default: false
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression to match the filename against.
    default: .*
 
    -target-dir <adams.core.io.PlaceholderDirectory> (property: targetDirectory)
    The target directory to copy the files to.
    default: ${CWD}
 
    -filename <java.lang.String> (property: filename)
    The (optional) new filename in the target directory, using the old name 
    if left empty.
    default: 
 
    -num-attempts <int> (property: numAttempts)
    The number of attempts for copying.
    default: 1
    minimum: 1
 
    -attempt-interval <int> (property: attemptInterval)
    The time in msec to wait before the next attempt.
    default: 1000
    minimum: 0
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_CreateSubDirectories

        protected boolean m_CreateSubDirectories
        whether the input is a directory and directory should be re-created below target directory (only the last path component: /some/where/blah -> TARGET/blah will get created).

      • m_RegExp

        protected BaseRegExp m_RegExp
        the regular expression for the files to match.

      • m_Filename

        protected String m_Filename
        the (optional) new filename.

      • m_NumAttempts

        protected int m_NumAttempts
        the number of tries for writing the data.

      • m_AttemptInterval

        protected int m_AttemptInterval
        the interval between attempts.

    • Constructor Detail

      • CopyFile

        public CopyFile()

    • Method Detail

      • setCreateSubDirectories

        public void setCreateSubDirectories​(boolean value)
        Sets whether to re-create the sub-directory (last path component of input) below the target directory.
        Parameters:
        value - if true sub-dirs are created

      • getCreateSubDirectories

        public boolean getCreateSubDirectories()
        Returns whether to re-create the sub-directory (last path component of input) below the target directory.
        Returns:
        true if sub-dires are created

      • createSubDirectoriesTipText

        public String createSubDirectoriesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expressions to use.
        Parameters:
        value - the regular expressions

      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expressions in use.
        Returns:
        the regular expressions

      • regExpTipText

        public String regExpTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setTargetDirectory

        public void setTargetDirectory​(PlaceholderDirectory value)
        Sets the target directory for the files.
        Parameters:
        value - the target directory

      • getTargetDirectory

        public PlaceholderDirectory getTargetDirectory()
        Returns the target directory for the files.
        Returns:
        the target directory

      • targetDirectoryTipText

        public String targetDirectoryTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setFilename

        public void setFilename​(String value)
        Sets the new filename to use.
        Parameters:
        value - the new filename, leave empty to use old

      • getFilename

        public String getFilename()
        Returns the new filename to use.
        Returns:
        the new filename, ignored if empty

      • filenameTipText

        public String filenameTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNumAttempts

        public void setNumAttempts​(int value)
        Sets the number of attempts.
        Specified by:
        setNumAttempts in interface MultiAttemptSupporter
        Parameters:
        value - the number of attempts

      • getNumAttempts

        public int getNumAttempts()
        Returns the number of attempts.
        Specified by:
        getNumAttempts in interface MultiAttemptSupporter
        Returns:
        the number of attempts

      • numAttemptsTipText

        public String numAttemptsTipText()
        Returns the tip text for this property.
        Specified by:
        numAttemptsTipText in interface MultiAttemptSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • attemptIntervalTipText

        public String attemptIntervalTipText()
        Returns the tip text for this property.
        Specified by:
        attemptIntervalTipText in interface MultiAttemptWithWaitSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        java.lang.String.class, java.io.File.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        java.lang.String.class, java.io.File.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message