Package adams.flow.template

Class StoreFilenameInVariable

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractActorTemplate>, SizeOfHandler, Serializable
    public class StoreFilenameInVariable
extends AbstractActorTemplate
    Creates a sub-flow that stores the filename passing through in a user-specified variable.

    Valid options are: 

    -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 new name for the actor; leave empty to use current.
    default: 
 
    -variable <adams.core.VariableName> (property: variableName)
    The variable to store the report value in.
    default: variable
 
    -strip-path (property: stripPath)
    If enabled, the path gets stripped from the filename.
 
    -strip-extension (property: stripExtension)
    If enabled, the extension gets stripped from the filename.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_VariableName

        protected VariableName m_VariableName
        the variable to store the value in.

      • m_StripPath

        protected boolean m_StripPath
        whether to strip the path.

      • m_StripExtension

        protected boolean m_StripExtension
        whether to strip the extension.

    • Constructor Detail

      • StoreFilenameInVariable

        public StoreFilenameInVariable()

    • Method Detail

      • setVariableName

        public void setVariableName​(VariableName value)
        Sets the variable to set.
        Parameters:
        value - the variable

      • getVariableName

        public VariableName getVariableName()
        Returns the variable to set.
        Returns:
        the variable

      • variableNameTipText

        public String variableNameTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setStripPath

        public void setStripPath​(boolean value)
        Sets whether to strip the path from the filename.
        Parameters:
        value - true if to strip

      • getStripPath

        public boolean getStripPath()
        Returns whether to strip the path from the filename.
        Returns:
        true if stripped

      • stripPathTipText

        public String stripPathTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • setStripExtension

        public void setStripExtension​(boolean value)
        Sets whether to strip the extension from the filename.
        Parameters:
        value - true if to strip

      • getStripExtension

        public boolean getStripExtension()
        Returns whether to strip the extension from the filename.
        Returns:
        true if stripped

      • stripExtensionTipText

        public String stripExtensionTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the gui

      • isInteractive

        public boolean isInteractive()
        Whether the flow generated is an interactive one.
        Specified by:
        isInteractive in class AbstractActorTemplate
        Returns:
        true if interactive