Package adams.flow.transformer

Class WekaInstanceBuffer

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.core.VariablesInspectionHandler, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.core.OutputProducer, adams.flow.core.VariableMonitor, Serializable, Comparable
    public class WekaInstanceBuffer
extends adams.flow.transformer.AbstractTransformer
implements adams.flow.core.VariableMonitor
    Can act in two different ways:
    1. Instance -> Instances (row -> dataset)
    Buffers weka.core.Instance objects and outputs a weka.core.Instances object, whenever the interval condition has been met.
    2. Instances -> Instance (dataset -> row)
    Outputs all the weka.core.Instance objects that the incoming weka.core.Instances object contains.

    Input/output:
    - accepts:
       weka.core.Instance
       weka.core.Instance[]
    - generates:
       weka.core.Instances


    -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: WekaInstanceBuffer
 
    -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
 
    -operation <INSTANCES_TO_INSTANCE|INSTANCE_TO_INSTANCES> (property: operation)
    The way the buffer operates, 'dataset -> row' or 'row -> dataset'.
    default: INSTANCE_TO_INSTANCES
 
    -check <boolean> (property: checkHeader)
    Whether to check the headers - if the headers change, the Instance object
    gets dumped into a new file (in case of INSTANCE_TO_INSTANCES).
    default: false
 
    -interval <int> (property: interval)
    The interval at which to output the Instances object (in case of INSTANCE_TO_INSTANCES
    ).
    default: 1
    minimum: 1
 
    -clear-buffer <boolean> (property: clearBuffer)
    Whether to clear the buffer once the dataset has been forwarded (in case
    of INSTANCE_TO_INSTANCES).
    default: false
 
    -var-name <adams.core.VariableName> (property: variableName)
    The variable to monitor.
    default: variable
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  WekaInstanceBuffer.Operation
      Defines how the buffer actor operates.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BACKUP_BUFFER
      the key for storing the current buffer in the backup.
      static String BACKUP_ITERATOR
      the key for storing the current iterator in the backup.
      protected weka.core.Instances m_Buffer
      the currently buffered data.
      protected boolean m_CheckHeader
      whether to check the header.
      protected boolean m_ClearBuffer
      whether to clear the buffer once it has been forwarded.
      protected boolean m_ClearBufferRequired
      whether variable triggered clear of buffer.
      protected int m_Interval
      the interval of when to output the Instances object.
      protected Iterator<weka.core.Instance> m_Iterator
      the iterator for broadcasting Instance objects.
      protected WekaInstanceBuffer.Operation m_Operation
      the way the buffer operates.
      protected adams.core.VariableName m_VariableName
      the variable to listen to.

      • Fields inherited from class adams.flow.transformer.AbstractTransformer

        BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

      • Fields inherited from class adams.flow.core.AbstractActor

        m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

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

        m_OptionManager

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

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the class that the consumer accepts.
      protected Hashtable<String,​Object> backupState()
      Backs up the current state of the actor before update the variables.
      String checkHeaderTipText()
      Returns the tip text for this property.
      String clearBufferTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      Class[] generates()
      Returns the class of objects that it generates.
      boolean getCheckHeader()
      Returns whether the header gets checked or not.
      boolean getClearBuffer()
      Returns whether to clear the buffer once the dataset has been forwarded.
      int getInterval()
      Returns the interval for outputting the Instances objects.
      WekaInstanceBuffer.Operation getOperation()
      Returns the way the buffer operates.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      adams.core.VariableName getVariableName()
      Returns the name of the variable to monitor.
      String globalInfo()
      Returns a string describing the object.
      boolean hasPendingOutput()
      Checks whether there is pending output to be collected after executing the flow item.
      String intervalTipText()
      Returns the tip text for this property.
      String operationTipText()
      Returns the tip text for this property.
      adams.flow.core.Token output()
      Returns the generated token.
      protected void pruneBackup()
      Removes entries from the backup.
      protected void reset()
      Resets the scheme.
      protected void restoreState​(Hashtable<String,​Object> state)
      Restores the state of the actor before the variables got updated.
      void setCheckHeader​(boolean value)
      Sets whether to check the header or not.
      void setClearBuffer​(boolean value)
      Sets whether to clear the buffer once the dataset has been forwarded.
      void setInterval​(int value)
      Sets the interval for outputting the Instances objects.
      void setOperation​(WekaInstanceBuffer.Operation value)
      Sets the way the buffer operates.
      void setVariableName​(adams.core.VariableName value)
      Sets the name of the variable to monitor.
      void variableChanged​(adams.event.VariableChangeEvent e)
      Gets triggered when a variable changed (added, modified, removed).
      String variableNameTipText()
      Returns the tip text for this property.
      void wrapUp()
      Cleans up after the execution has finished.

      • Methods inherited from class adams.flow.transformer.AbstractTransformer

        currentInput, execute, hasInput, input, postExecute

      • Methods inherited from class adams.flow.core.AbstractActor

        annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

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

        getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

      • Methods inherited from interface adams.flow.core.Actor

        cleanUp, compareTo, destroy, equals, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

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

        getLoggingLevel, setLoggingLevel

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

        getLogger, isLoggingEnabled

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, getOptionManager

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Field Detail

      • BACKUP_BUFFER

        public static final String BACKUP_BUFFER
        the key for storing the current buffer in the backup.
        See Also:
        Constant Field Values

      • BACKUP_ITERATOR

        public static final String BACKUP_ITERATOR
        the key for storing the current iterator in the backup.
        See Also:
        Constant Field Values

      • m_Buffer

        protected weka.core.Instances m_Buffer
        the currently buffered data.

      • m_Iterator

        protected Iterator<weka.core.Instance> m_Iterator
        the iterator for broadcasting Instance objects.

      • m_CheckHeader

        protected boolean m_CheckHeader
        whether to check the header.

      • m_Interval

        protected int m_Interval
        the interval of when to output the Instances object.

      • m_ClearBuffer

        protected boolean m_ClearBuffer
        whether to clear the buffer once it has been forwarded.

      • m_VariableName

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

      • m_ClearBufferRequired

        protected boolean m_ClearBufferRequired
        whether variable triggered clear of buffer.

    • Constructor Detail

      • WekaInstanceBuffer

        public WekaInstanceBuffer()

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

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.flow.core.Actor
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.core.AbstractActor
        Returns:
        null if no info available, otherwise short string

      • setOperation

        public void setOperation​(WekaInstanceBuffer.Operation value)
        Sets the way the buffer operates.
        Parameters:
        value - the operation

      • operationTipText

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

      • setCheckHeader

        public void setCheckHeader​(boolean value)
        Sets whether to check the header or not.
        Parameters:
        value - if true then the headers get checked

      • getCheckHeader

        public boolean getCheckHeader()
        Returns whether the header gets checked or not.
        Returns:
        true if the header gets checked

      • checkHeaderTipText

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

      • setInterval

        public void setInterval​(int value)
        Sets the interval for outputting the Instances objects.
        Parameters:
        value - the interval

      • getInterval

        public int getInterval()
        Returns the interval for outputting the Instances objects.
        Returns:
        the interval

      • intervalTipText

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

      • setClearBuffer

        public void setClearBuffer​(boolean value)
        Sets whether to clear the buffer once the dataset has been forwarded.
        Parameters:
        value - true if to clear buffer

      • getClearBuffer

        public boolean getClearBuffer()
        Returns whether to clear the buffer once the dataset has been forwarded.
        Returns:
        true if to clear buffer

      • clearBufferTipText

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

      • setVariableName

        public void setVariableName​(adams.core.VariableName value)
        Sets the name of the variable to monitor.
        Specified by:
        setVariableName in interface adams.flow.core.VariableMonitor
        Parameters:
        value - the name

      • getVariableName

        public adams.core.VariableName getVariableName()
        Returns the name of the variable to monitor.
        Specified by:
        getVariableName in interface adams.flow.core.VariableMonitor
        Returns:
        the name

      • variableNameTipText

        public String variableNameTipText()
        Returns the tip text for this property.
        Specified by:
        variableNameTipText in interface adams.flow.core.VariableMonitor
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • variableChanged

        public void variableChanged​(adams.event.VariableChangeEvent e)
        Gets triggered when a variable changed (added, modified, removed).
        Specified by:
        variableChanged in interface adams.flow.core.Actor
        Specified by:
        variableChanged in interface adams.event.VariableChangeListener
        Overrides:
        variableChanged in class adams.flow.core.AbstractActor
        Parameters:
        e - the event

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface adams.flow.core.InputConsumer
        Returns:
        weka.core.Instance.class, weka.core.Instance[].class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface adams.flow.core.OutputProducer
        Returns:
        weka.core.Instances.class

      • pruneBackup

        protected void pruneBackup()
        Removes entries from the backup.
        Overrides:
        pruneBackup in class adams.flow.core.AbstractActor

      • backupState

        protected Hashtable<String,​Object> backupState()
        Backs up the current state of the actor before update the variables.
        Overrides:
        backupState in class adams.flow.transformer.AbstractTransformer
        Returns:
        the backup

      • restoreState

        protected void restoreState​(Hashtable<String,​Object> state)
        Restores the state of the actor before the variables got updated.
        Overrides:
        restoreState in class adams.flow.transformer.AbstractTransformer
        Parameters:
        state - the backup of the state to restore from

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class adams.flow.core.AbstractActor

      • doExecute

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

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether there is pending output to be collected after executing the flow item.
        Specified by:
        hasPendingOutput in interface adams.flow.core.OutputProducer
        Overrides:
        hasPendingOutput in class adams.flow.transformer.AbstractTransformer
        Returns:
        true if there is pending output

      • output

        public adams.flow.core.Token output()
        Returns the generated token.
        Specified by:
        output in interface adams.flow.core.OutputProducer
        Overrides:
        output in class adams.flow.transformer.AbstractTransformer
        Returns:
        the generated token

      • wrapUp

        public void wrapUp()
        Cleans up after the execution has finished.
        Specified by:
        wrapUp in interface adams.flow.core.Actor
        Overrides:
        wrapUp in class adams.flow.transformer.AbstractTransformer