Package adams.flow.source

Class DumpVariables

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class DumpVariables
extends AbstractSimpleSource
    Outputs the variable names and their associated values in the specified format.

    Input/output:
    - generates:
       adams.data.spreadsheet.SpreadSheet


    -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: DumpVariables
 
    -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
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression used for matching the variable names.
    default: .*
 
    -invert <boolean> (property: invert)
    If set to true, then the matching sense is inverted.
    default: false
 
    -output-type <SPREADSHEET|PROPERTIES|MAP> (property: outputType)
    The output format to use.
    default: SPREADSHEET
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_RegExp

        protected BaseRegExp m_RegExp
        the regular expression to match.

      • m_Invert

        protected boolean m_Invert
        whether to invert the matching sense.

    • Constructor Detail

      • DumpVariables

        public DumpVariables()

    • Method Detail

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expression to match the variable names against.
        Parameters:
        value - the regular expression

      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expression to match the variable names against.
        Returns:
        the regular expression

      • 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.

      • setInvert

        public void setInvert​(boolean value)
        Sets whether to invert the matching sense.
        Parameters:
        value - true if inverting matching sense

      • getInvert

        public boolean getInvert()
        Returns whether to invert the matching sense.
        Returns:
        true if matching sense is inverted

      • invertTipText

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

      • setOutputType

        public void setOutputType​(DumpVariables.OutputType value)
        Sets the format to output the variables in.
        Parameters:
        value - the format

      • getOutputType

        public DumpVariables.OutputType getOutputType()
        Returns the format to output the variables in.
        Returns:
        the format

      • outputTypeTipText

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens

      • doExecute

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