Package adams.flow.template

Class FileProcessingWithProgressBar

  • All Implemented Interfaces:
    Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractActorTemplate>, SizeOfHandler, Serializable
    public class FileProcessingWithProgressBar
extends AbstractActorTemplate
    Generates a Trigger with a FileSystemSearch which updates a progress bar. 

    -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:
 
    -select-subset <boolean> (property: selectSubset)
    If enabled, the user can select a subset of the files.
    default: false
 
    -max-variable <adams.core.VariableName> (property: maxVariable)
    The name of the variable to use for storing the number of files (= maximum
    ).
    default: max
 
    -count-variable <adams.core.VariableName> (property: countVariable)
    The name of the variable to use for storing the progress count.
    default: count
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_SelectSubset

        protected boolean m_SelectSubset
        whether to let the user select a subset.

      • m_MaxVariable

        protected VariableName m_MaxVariable
        the variable to store the # of files.

      • m_CountVariable

        protected VariableName m_CountVariable
        the variable to store the current progress in.

    • Constructor Detail

      • FileProcessingWithProgressBar

        public FileProcessingWithProgressBar()

    • Method Detail

      • setSelectSubset

        public void setSelectSubset​(boolean value)
        Sets whether to let the user select a subset.
        Parameters:
        value - true if user can select

      • getSelectSubset

        public boolean getSelectSubset()
        Returns whether to let the user select a subset.
        Returns:
        true if user can select

      • selectSubsetTipText

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

      • setMaxVariable

        public void setMaxVariable​(VariableName value)
        Sets the variable name to use for storing the number of files (= maximum).
        Parameters:
        value - the variable name

      • getMaxVariable

        public VariableName getMaxVariable()
        Returns the variable name to use for storing the number of files (= maximum).
        Returns:
        the variable name

      • maxVariableTipText

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

      • setCountVariable

        public void setCountVariable​(VariableName value)
        Sets the variable name to use for storing the progress count.
        Parameters:
        value - the variable name

      • getCountVariable

        public VariableName getCountVariable()
        Returns the variable name to use for storing the progress count.
        Returns:
        the variable name

      • countVariableTipText

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

      • isInteractive

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