Package adams.flow.template

Class InstanceDumperVariable

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.ShallowCopySupporter<adams.flow.template.AbstractActorTemplate>, adams.core.SizeOfHandler, Serializable
    public class InstanceDumperVariable
extends adams.flow.template.AbstractActorTemplate
    Generates a sub-flow that sets a variable for the adams.flow.transformer.WekaInstanceDumper transformer's outputPrefix property using a prefix based on the full flow name. In other words, the ARFF/CSV file will get generated in the same location as the flow.

    Valid options are: 

    -D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 
    -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 be used for the 'outputPrefix' property.
    default: variable
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected adams.core.VariableName m_VariableName
      the variable to update.

      • Fields inherited from class adams.flow.template.AbstractActorTemplate

        m_Name

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void defineOptions()
      Adds options to the internal list of options.
      protected adams.flow.core.Actor doGenerate()
      Generates the actor.
      adams.core.VariableName getVariableName()
      Returns the variable name to generate the sub-flow for.
      String globalInfo()
      Returns a string describing the object.
      boolean isInteractive()
      Whether the flow generated is an interactive one.
      void setVariableName​(adams.core.VariableName value)
      Sets the variable name to generate the sub-flow for.
      String variableNameTipText()
      Returns the tip text for this property.

      • Methods inherited from class adams.flow.template.AbstractActorTemplate

        compareTo, equals, forCommandLine, forName, generate, getBaselineCorrections, getDefaultName, getName, nameTipText, postGenerate, preGenerate, setName, shallowCopy, shallowCopy

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Field Detail

      • m_VariableName

        protected adams.core.VariableName m_VariableName
        the variable to update.

    • Constructor Detail

      • InstanceDumperVariable

        public InstanceDumperVariable()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • defineOptions

        public void defineOptions()
        Adds options to the internal list of options.
        Specified by:
        defineOptions in interface adams.core.option.OptionHandler
        Overrides:
        defineOptions in class adams.flow.template.AbstractActorTemplate

      • setVariableName

        public void setVariableName​(adams.core.VariableName value)
        Sets the variable name to generate the sub-flow for.
        Parameters:
        value - the variable

      • getVariableName

        public adams.core.VariableName getVariableName()
        Returns the variable name to generate the sub-flow for.
        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

      • isInteractive

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

      • doGenerate

        protected adams.flow.core.Actor doGenerate()
        Generates the actor.
        Specified by:
        doGenerate in class adams.flow.template.AbstractActorTemplate
        Returns:
        the generated acto