Package adams.flow.transformer

Class Evaluator

  • All Implemented Interfaces:
    adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.ModelFileHandler, 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.data.InPlaceProcessing, adams.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.core.ModelLoaderSupporter, adams.flow.core.OutputProducer, adams.multiprocess.JobRunnerSupporter, Serializable, Comparable
    public class Evaluator
extends adams.flow.transformer.AbstractTransformer
implements adams.flow.core.ModelLoaderSupporter, adams.data.InPlaceProcessing, adams.multiprocess.JobRunnerSupporter
    If input is Instances, build this Evaluator. If Instance, use the built Evaluator.
    The name of this evaluator is used for storing the evaluation result.

    Input/output:
    - accepts:
       weka.core.Instances
       weka.core.Instance
       adams.data.instance.WekaInstanceContainer
       adams.flow.container.EvaluationContainer
    - generates:
       adams.flow.container.EvaluationContainer


    Container information:
    - adams.flow.container.EvaluationContainer: Instance, Instances, Evaluations, Evaluator, Classification, Abstention classification, Distribution, Component, Version, ID, Report 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: Evaluator
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -no-copy <boolean> (property: noCopy)
    If enabled, no copy of the evaluation container is generated before adding
    the additional evaluations.
    default: false
 
    -evaluator <adams.data.evaluator.instance.AbstractEvaluator> (property: evaluator)
    The Evaluator to train on the input data.
    default: adams.data.evaluator.instance.NullEvaluator -missing-evaluation NaN
 
    -model-loading-type <AUTO|FILE|SOURCE_ACTOR|STORAGE> (property: modelLoadingType)
    Determines how to load the model, in case of AUTO, first the model file
    is checked, then the callable actor and then the storage.
    default: AUTO
 
    -model <adams.core.io.PlaceholderFile> (property: modelFile)
    The file to load the model from, ignored if pointing to a directory.
    default: ${CWD}
 
    -model-actor <adams.flow.core.CallableActorReference> (property: modelActor)
    The callable actor (source) to obtain the model from, ignored if not present.
    default:
 
    -model-storage <adams.flow.control.StorageName> (property: modelStorage)
    The storage item to obtain the model from, ignored if not present.
    default: storage
 
    -use-evaluator-reset-variable <boolean> (property: useEvaluatorResetVariable)
    If enabled, chnages to the specified variable are monitored in order to
    reset the evaluator, eg when a storage evaluator changed.
    default: false
 
    -evaluator-reset-variable <adams.core.VariableName> (property: evaluatorResetVariable)
    The variable to monitor for changes in order to reset the evaluator, eg
    when a storage evaluator changed.
    default: variable
 
    -component <java.lang.String> (property: component)
    The component identifier.
    default:
 
    -version <java.lang.String> (property: version)
    The version.
    default:
 
    -clean-after-build <boolean> (property: cleanAfterBuild)
    If enabled, the internnaly built evaluator gets discarded again.
    default: false
 
    -prefer-jobrunner <boolean> (property: preferJobRunner)
    If enabled, tries to offload the processing onto a adams.flow.standalone.JobRunnerInstance;
     applies only to training.
    default: false
    Author:
    dale (dale at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Evaluator.EvaluateJob  

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BACKUP_ACTUALEVALUATOR
      the key for storing the current evaluator in the backup.
      protected AbstractEvaluator m_ActualEvaluator
      the evaluator used for training/evaluating.
      protected boolean m_CleanAfterBuild
      whether to clean up after build.
      protected String m_Component
      the name of the component.
      protected AbstractEvaluator m_Evaluator
      the evaluator.
      protected adams.core.VariableName m_EvaluatorResetVariable
      the variable to monitor for changes, triggering resets of the evaluator.
      protected adams.flow.standalone.JobRunnerInstance m_JobRunnerInstance
      the JobRunnerInstance to use.
      protected EvaluatorModelLoader m_ModelLoader
      the model loader.
      protected boolean m_NoCopy
      whether to only update the container or work on a copy.
      protected boolean m_PreferJobRunner
      whether to offload training into a JobRunnerInstance.
      protected boolean m_ResetEvaluator
      whether we need to reset the evaluator.
      protected boolean m_UseEvaluatorResetVariable
      whether to use a variable to monitor for changes, triggering resets of the evaluator.
      protected String m_Version
      the version of the component.

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Evaluator()  

    • 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 cleanAfterBuildTipText()
      Returns the tip text for this property.
      String componentTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      protected String doExecute()
      Executes the flow item.
      String evaluatorResetVariableTipText()
      Returns the tip text for this property.
      String evaluatorTipText()
      Returns the tip text for this property.
      Class[] generates()
      Returns the class of objects that it generates.
      boolean getCleanAfterBuild()
      Returns whether to discard the internal evaluator again after building it.
      String getComponent()
      Returns the component identifier.
      AbstractEvaluator getEvaluator()
      Returns the evaluator in use.
      adams.core.VariableName getEvaluatorResetVariable()
      Returns the variable to monitor for changes in order to reset the evaluator.
      adams.flow.core.CallableActorReference getModelActor()
      Returns the filter source actor.
      adams.core.io.PlaceholderFile getModelFile()
      Returns the file to load the model from.
      adams.flow.core.AbstractModelLoader.ModelLoadingType getModelLoadingType()
      Returns the loading type.
      adams.flow.control.StorageName getModelStorage()
      Returns the filter storage item.
      boolean getNoCopy()
      Returns whether to skip creating a copy of the container before updating it.
      boolean getPreferJobRunner()
      Returns whether to offload processing to a JobRunner instance if available.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      boolean getUseEvaluatorResetVariable()
      Returns whether to use a variable to monitor for changes in order to reset the evaluator.
      String getVersion()
      Returns the version.
      String globalInfo()
      Returns a string describing the object.
      protected void initialize()
      Initializes the members.
      String modelActorTipText()
      Returns the tip text for this property.
      String modelFileTipText()
      Returns the tip text for this property.
      String modelLoadingTypeTipText()
      Returns the tip text for this property.
      String modelStorageTipText()
      Returns the tip text for this property.
      String noCopyTipText()
      Returns the tip text for this property.
      String preferJobRunnerTipText()
      Returns the tip text for this property.
      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 setCleanAfterBuild​(boolean value)
      Sets whether to discard the internal evaluator again after building it.
      void setComponent​(String value)
      Sets the component identifier to use.
      void setEvaluator​(AbstractEvaluator value)
      Sets the evaluator to use.
      void setEvaluatorResetVariable​(adams.core.VariableName value)
      Sets the variable to monitor for changes in order to reset the evaluator.
      void setLoggingLevel​(adams.core.logging.LoggingLevel value)
      Sets the logging level.
      void setModelActor​(adams.flow.core.CallableActorReference value)
      Sets the filter source actor.
      void setModelFile​(adams.core.io.PlaceholderFile value)
      Sets the file to load the model from.
      void setModelLoadingType​(adams.flow.core.AbstractModelLoader.ModelLoadingType value)
      Sets the loading type.
      void setModelStorage​(adams.flow.control.StorageName value)
      Sets the filter storage item.
      void setNoCopy​(boolean value)
      Sets whether to skip creating a copy of the container before updating it.
      void setPreferJobRunner​(boolean value)
      Sets whether to offload processing to a JobRunner instance if available.
      String setUp()
      Initializes the item for flow execution.
      protected String setUpEvaluator()
      Loads the evaluator from the evaluator file.
      void setUseEvaluatorResetVariable​(boolean value)
      Sets whether to use a variable to monitor for changes in order to reset the evaluator.
      void setVersion​(String value)
      Sets the version to use.
      void stopExecution()
      Stops the execution.
      String useEvaluatorResetVariableTipText()
      Returns the tip text for this property.
      void variableChanged​(adams.event.VariableChangeEvent e)
      Gets triggered when a variable changed (added, modified, removed).
      String versionTipText()
      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, hasPendingOutput, input, output, 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, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables

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

        cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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, toCommandLine

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

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

        getLoggingLevel

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

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

      • m_NoCopy

        protected boolean m_NoCopy
        whether to only update the container or work on a copy.

      • m_ActualEvaluator

        protected AbstractEvaluator m_ActualEvaluator
        the evaluator used for training/evaluating.

      • m_Component

        protected String m_Component
        the name of the component.

      • m_Version

        protected String m_Version
        the version of the component.

      • m_UseEvaluatorResetVariable

        protected boolean m_UseEvaluatorResetVariable
        whether to use a variable to monitor for changes, triggering resets of the evaluator.

      • m_EvaluatorResetVariable

        protected adams.core.VariableName m_EvaluatorResetVariable
        the variable to monitor for changes, triggering resets of the evaluator.

      • m_ResetEvaluator

        protected boolean m_ResetEvaluator
        whether we need to reset the evaluator.

      • m_CleanAfterBuild

        protected boolean m_CleanAfterBuild
        whether to clean up after build.

      • m_PreferJobRunner

        protected boolean m_PreferJobRunner
        whether to offload training into a JobRunnerInstance.

      • m_JobRunnerInstance

        protected transient adams.flow.standalone.JobRunnerInstance m_JobRunnerInstance
        the JobRunnerInstance to use.

    • Constructor Detail

      • Evaluator

        public Evaluator()

    • 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

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize in class adams.flow.core.AbstractActor

      • setLoggingLevel

        public void setLoggingLevel​(adams.core.logging.LoggingLevel value)
        Sets the logging level.
        Specified by:
        setLoggingLevel in interface adams.core.logging.LoggingLevelHandler
        Overrides:
        setLoggingLevel in class adams.core.option.AbstractOptionHandler
        Parameters:
        value - the level

      • setNoCopy

        public void setNoCopy​(boolean value)
        Sets whether to skip creating a copy of the container before updating it.
        Specified by:
        setNoCopy in interface adams.data.InPlaceProcessing
        Parameters:
        value - true if to skip creating copy

      • getNoCopy

        public boolean getNoCopy()
        Returns whether to skip creating a copy of the container before updating it.
        Specified by:
        getNoCopy in interface adams.data.InPlaceProcessing
        Returns:
        true if copying is skipped

      • noCopyTipText

        public String noCopyTipText()
        Returns the tip text for this property.
        Specified by:
        noCopyTipText in interface adams.data.InPlaceProcessing
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setEvaluator

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

      • getEvaluator

        public AbstractEvaluator getEvaluator()
        Returns the evaluator in use.
        Returns:
        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.

      • setModelLoadingType

        public void setModelLoadingType​(adams.flow.core.AbstractModelLoader.ModelLoadingType value)
        Sets the loading type. In case of AbstractModelLoader.ModelLoadingType.AUTO, first file, then callable actor, then storage.
        Specified by:
        setModelLoadingType in interface adams.flow.core.ModelLoaderSupporter
        Parameters:
        value - the type

      • getModelLoadingType

        public adams.flow.core.AbstractModelLoader.ModelLoadingType getModelLoadingType()
        Returns the loading type. In case of AbstractModelLoader.ModelLoadingType.AUTO, first file, then callable actor, then storage.
        Specified by:
        getModelLoadingType in interface adams.flow.core.ModelLoaderSupporter
        Returns:
        the type

      • modelLoadingTypeTipText

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

      • setModelFile

        public void setModelFile​(adams.core.io.PlaceholderFile value)
        Sets the file to load the model from.
        Specified by:
        setModelFile in interface adams.core.io.ModelFileHandler
        Specified by:
        setModelFile in interface adams.flow.core.ModelLoaderSupporter
        Parameters:
        value - the model file

      • getModelFile

        public adams.core.io.PlaceholderFile getModelFile()
        Returns the file to load the model from.
        Specified by:
        getModelFile in interface adams.core.io.ModelFileHandler
        Specified by:
        getModelFile in interface adams.flow.core.ModelLoaderSupporter
        Returns:
        the model file

      • modelFileTipText

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

      • setModelActor

        public void setModelActor​(adams.flow.core.CallableActorReference value)
        Sets the filter source actor.
        Specified by:
        setModelActor in interface adams.flow.core.ModelLoaderSupporter
        Parameters:
        value - the source

      • getModelActor

        public adams.flow.core.CallableActorReference getModelActor()
        Returns the filter source actor.
        Specified by:
        getModelActor in interface adams.flow.core.ModelLoaderSupporter
        Returns:
        the source

      • modelActorTipText

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

      • setModelStorage

        public void setModelStorage​(adams.flow.control.StorageName value)
        Sets the filter storage item.
        Specified by:
        setModelStorage in interface adams.flow.core.ModelLoaderSupporter
        Parameters:
        value - the storage item

      • getModelStorage

        public adams.flow.control.StorageName getModelStorage()
        Returns the filter storage item.
        Specified by:
        getModelStorage in interface adams.flow.core.ModelLoaderSupporter
        Returns:
        the storage item

      • modelStorageTipText

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

      • setUseEvaluatorResetVariable

        public void setUseEvaluatorResetVariable​(boolean value)
        Sets whether to use a variable to monitor for changes in order to reset the evaluator.
        Parameters:
        value - true if to use monitor variable

      • getUseEvaluatorResetVariable

        public boolean getUseEvaluatorResetVariable()
        Returns whether to use a variable to monitor for changes in order to reset the evaluator.
        Returns:
        true if to use monitor variable

      • useEvaluatorResetVariableTipText

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

      • setEvaluatorResetVariable

        public void setEvaluatorResetVariable​(adams.core.VariableName value)
        Sets the variable to monitor for changes in order to reset the evaluator.
        Parameters:
        value - the variable

      • getEvaluatorResetVariable

        public adams.core.VariableName getEvaluatorResetVariable()
        Returns the variable to monitor for changes in order to reset the evaluator.
        Returns:
        the variable

      • evaluatorResetVariableTipText

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

      • setComponent

        public void setComponent​(String value)
        Sets the component identifier to use.
        Parameters:
        value - the component identifier

      • getComponent

        public String getComponent()
        Returns the component identifier.
        Returns:
        the component identifier

      • componentTipText

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

      • setVersion

        public void setVersion​(String value)
        Sets the version to use.
        Parameters:
        value - the version

      • getVersion

        public String getVersion()
        Returns the version.
        Returns:
        the version

      • versionTipText

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

      • setCleanAfterBuild

        public void setCleanAfterBuild​(boolean value)
        Sets whether to discard the internal evaluator again after building it.
        Parameters:
        value - true if to discard

      • getCleanAfterBuild

        public boolean getCleanAfterBuild()
        Returns whether to discard the internal evaluator again after building it.
        Returns:
        true if to discard

      • cleanAfterBuildTipText

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

      • setPreferJobRunner

        public void setPreferJobRunner​(boolean value)
        Sets whether to offload processing to a JobRunner instance if available.
        Specified by:
        setPreferJobRunner in interface adams.multiprocess.JobRunnerSupporter
        Parameters:
        value - if true try to find/use a JobRunner instance

      • getPreferJobRunner

        public boolean getPreferJobRunner()
        Returns whether to offload processing to a JobRunner instance if available.
        Specified by:
        getPreferJobRunner in interface adams.multiprocess.JobRunnerSupporter
        Returns:
        if true try to find/use a JobRunner instance

      • preferJobRunnerTipText

        public String preferJobRunnerTipText()
        Returns the tip text for this property.
        Specified by:
        preferJobRunnerTipText in interface adams.multiprocess.JobRunnerSupporter
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • 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

      • 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

      • accepts

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

      • generates

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

      • 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

      • setUpEvaluator

        protected String setUpEvaluator()
        Loads the evaluator from the evaluator file.
        Returns:
        null if everything worked, otherwise an error message

      • 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

      • 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

      • stopExecution

        public void stopExecution()
        Stops the execution. No message set.
        Specified by:
        stopExecution in interface adams.flow.core.Actor
        Specified by:
        stopExecution in interface adams.core.Stoppable
        Overrides:
        stopExecution in class adams.flow.core.AbstractActor

      • 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