Package adams.flow.transformer

Class WekaInstanceEvaluator

  • 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, Serializable, Comparable
    public class WekaInstanceEvaluator
extends adams.flow.transformer.AbstractTransformer
    Adds a new attribute to the data being passed through (normally 'evaluation') and sets the value to the evaluation value returned by the chosen evaluator scheme.

    Input/output:
    - accepts:
       weka.core.Instance
    - generates:
       weka.core.Instance


    -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: WekaInstanceEvaluator
 
    -annotation <adams.core.base.BaseText> (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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -evaluator <adams.data.weka.evaluator.AbstractInstanceEvaluator> (property: evaluator)
    The evaluator to use.
    default: adams.data.weka.evaluator.PassThrough
 
    -instances <adams.flow.core.CallableActorReference> (property: instancesActor)
    The name of the callable actor from which to retrieve Instances in case 
    of adams.data.weka.evaluator.AbstractDatasetInstanceEvaluator-derived classes,
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String ATTRIBUTE_NAME
      the default name of the attribute with the evaluation value.
      protected String m_AttributeName
      the attribute name of the evaluation object.
      protected AbstractInstanceEvaluator m_Evaluator
      the evaluator to use.
      protected weka.filters.unsupervised.attribute.Add m_Filter
      the filter that is used for generating the new data format.
      protected adams.flow.source.CallableSource m_GlobalSource
      the callable actor to use.
      protected weka.core.Instances m_Header
      the new header.
      protected adams.flow.core.CallableActorReference m_InstancesActor
      the callable actor to get the Instances from in case of AbstractDatasetInstanceEvaluator.

      • 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.
      void defineOptions()
      Adds options to the internal list of options.
      protected String determineAttributeName​(weka.core.Instances data)
      Determines the name of the evaluation attribute.
      protected String doExecute()
      Executes the flow item.
      String evaluatorTipText()
      Returns the tip text for this property.
      protected String generateHeader​(weka.core.Instance inst)
      Generates the new header for the data.
      Class[] generates()
      Returns the class of objects that it generates.
      AbstractInstanceEvaluator getEvaluator()
      Returns the evaluator to use.
      adams.flow.core.CallableActorReference getInstancesActor()
      Returns the callable actor from which to retrieve Instances in case of AbstractDatasetInstanceEvaluator-derived evaluators.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      String globalInfo()
      Returns a string describing the object.
      String instancesActorTipText()
      Returns the tip text for this property.
      protected void reset()
      Resets the actor.
      void setEvaluator​(AbstractInstanceEvaluator value)
      Sets the evaluator to use.
      void setInstancesActor​(adams.flow.core.CallableActorReference value)
      Sets the callable actor from which to retrieve Instances in case of AbstractDatasetInstanceEvaluator-derived evaluators.
      String setUp()
      Initializes the item for flow execution.
      protected String setUpEvaluator()
      Initializes the evaluator.
      void wrapUp()
      Cleans up after the execution has finished.

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

        backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState

      • 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, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

      • 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, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged

      • 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

      • ATTRIBUTE_NAME

        public static final String ATTRIBUTE_NAME
        the default name of the attribute with the evaluation value.
        See Also:
        Constant Field Values

      • m_InstancesActor

        protected adams.flow.core.CallableActorReference m_InstancesActor
        the callable actor to get the Instances from in case of AbstractDatasetInstanceEvaluator.

      • m_Header

        protected weka.core.Instances m_Header
        the new header.

      • m_AttributeName

        protected String m_AttributeName
        the attribute name of the evaluation object.

      • m_GlobalSource

        protected adams.flow.source.CallableSource m_GlobalSource
        the callable actor to use.

      • m_Filter

        protected weka.filters.unsupervised.attribute.Add m_Filter
        the filter that is used for generating the new data format.

    • Constructor Detail

      • WekaInstanceEvaluator

        public WekaInstanceEvaluator()

    • 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

      • reset

        protected void reset()
        Resets the actor.
        Overrides:
        reset 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

      • setEvaluator

        public void setEvaluator​(AbstractInstanceEvaluator value)
        Sets the evaluator to use.
        Parameters:
        value - the evaluator

      • evaluatorTipText

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

      • setInstancesActor

        public void setInstancesActor​(adams.flow.core.CallableActorReference value)
        Sets the callable actor from which to retrieve Instances in case of AbstractDatasetInstanceEvaluator-derived evaluators.
        Parameters:
        value - the name of the actor

      • getInstancesActor

        public adams.flow.core.CallableActorReference getInstancesActor()
        Returns the callable actor from which to retrieve Instances in case of AbstractDatasetInstanceEvaluator-derived evaluators.
        Returns:
        the name of the actor

      • instancesActorTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        weka.core.Instance.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        weka.core.Instance.class

      • setUp

        public String setUp()
        Initializes the item for flow execution.
        Specified by:
        setUp in interface adams.flow.core.Actor
        Overrides:
        setUp in class adams.flow.core.AbstractActor
        Returns:
        null if everything is fine, otherwise error message

      • determineAttributeName

        protected String determineAttributeName​(weka.core.Instances data)
        Determines the name of the evaluation attribute.
        Parameters:
        data - the original input data
        Returns:
        the generated name
        See Also:
        m_AttributeName

      • setUpEvaluator

        protected String setUpEvaluator()
        Initializes the evaluator.
        Returns:
        null if everything is fine, otherwise error message
        See Also:
        m_Evaluator

      • generateHeader

        protected String generateHeader​(weka.core.Instance inst)
        Generates the new header for the data.
        Parameters:
        inst - the instance to get the original data format from
        Returns:
        null if everything is fine, otherwise error message
        See Also:
        m_Header, m_Filter

      • 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

      • 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