Package adams.flow.transformer

Class PrependDir

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, ForwardSlashSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class PrependDir
extends AbstractTransformer
implements ClassCrossReference, ForwardSlashSupporter
    Prepends the prefix to the file/directory being passed through.
    By default, the appropriate separator (forward slash or backslash) gets inserted between the file/directory and prefix. This can be turned off.


    See also:
    adams.flow.transformer.BaseName
    adams.flow.transformer.DirName
    adams.flow.transformer.RelativeDir
    adams.flow.transformer.AppendName
    adams.flow.transformer.FileExtension

    Input/output:
    - accepts:
       java.lang.String
       java.lang.String[]
       java.io.File
       java.io.File[]
    - generates:
       java.lang.String
       java.lang.String[]
       java.io.File
       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: PrependDir
 
    -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 execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -prefix <java.lang.String> (property: prefix)
    The prefix to append to the file/directory.
    default: 
 
    -no-separator <boolean> (property: noSeparator)
    If enabled, no separator (forward slash or backslash) gets inserted between 
    prefix and file/directory.
    default: false
 
    -use-forward-slashes <boolean> (property: useForwardSlashes)
    If enabled and receiving string(s) as input, forward slashes are used in 
    the output (but the '\\' prefix of UNC paths is not converted).
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Prefix

        protected String m_Prefix
        the prefix to prepend the file/directory.

      • m_NoSeparator

        protected boolean m_NoSeparator
        whether to avoid adding a separator between file/dir and prefix.

      • m_UseForwardSlashes

        protected boolean m_UseForwardSlashes
        whether to output forward slashes.

    • Constructor Detail

      • PrependDir

        public PrependDir()

    • Method Detail

      • setPrefix

        public void setPrefix​(String value)
        Sets the prefix to append.
        Parameters:
        value - the prefix

      • getPrefix

        public String getPrefix()
        Returns the prefix to append.
        Returns:
        the prefix

      • prefixTipText

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

      • setNoSeparator

        public void setNoSeparator​(boolean value)
        Sets whether to suppress inserting a separator between file/dir and prefix.
        Parameters:
        value - if true no separator gets inserted

      • getNoSeparator

        public boolean getNoSeparator()
        Returns whether to suppress inserting a separator between file/dir and prefix.
        Returns:
        true if no separator gets inserted

      • noSeparatorTipText

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

      • setUseForwardSlashes

        public void setUseForwardSlashes​(boolean value)
        Sets whether to use forward slashes in the output.
        Specified by:
        setUseForwardSlashes in interface ForwardSlashSupporter
        Parameters:
        value - if true then use forward slashes

      • getUseForwardSlashes

        public boolean getUseForwardSlashes()
        Returns whether to use forward slashes in the output.
        Specified by:
        getUseForwardSlashes in interface ForwardSlashSupporter
        Returns:
        true if forward slashes are used

      • useForwardSlashesTipText

        public String useForwardSlashesTipText()
        Returns the tip text for this property.
        Specified by:
        useForwardSlashesTipText in interface ForwardSlashSupporter
        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.lang.String[].class, java.io.File.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.lang.String[].class, java.io.File.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