Package adams.flow.transformer

Class PostProcessor

  • 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.event.VariableChangeListener, adams.flow.core.Actor, adams.flow.core.ErrorHandler, adams.flow.core.InputConsumer, adams.flow.core.ModelLoaderSupporter, adams.flow.core.OutputProducer, Serializable, Comparable
    public class PostProcessor
extends adams.flow.transformer.AbstractTransformer
implements adams.flow.core.ModelLoaderSupporter
    Post-processes the input Instances or, after the post-processor has been initialized with Instances, also input Instance objects.
    The actual post-processor in use gets output when container output enabled.

    Input/output:
    - accepts:
       weka.core.Instances
       weka.core.Instance
    - generates:
       weka.core.Instances
       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: PostProcessor
 
    -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
 
    -post-processor <adams.data.postprocessor.instances.AbstractPostProcessor> (property: postProcessor)
    The PostProcessor to use to process the Instances.
    default: adams.data.postprocessor.instances.WekaFilter -filter weka.filters.AllFilter
 
    -output-container <boolean> (property: outputContainer)
    If enabled, a container gets output.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BACKUP_ACTUALPOSTPROCESSOR
      the key for storing the current postprocessor in the backup.
      protected AbstractPostProcessor m_ActualPostProcessor
      the postprocessor used for doing the actual work.
      protected PostProcessorModelLoader m_ModelLoader
      the model loader.
      protected boolean m_OutputContainer
      whether to output a container.
      protected AbstractPostProcessor m_PostProcessor
      the postprocessor.
      protected adams.core.io.PlaceholderFile m_PostProcessorDetailsOutput
      the file to save the cleaner details 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

    • Constructor Summary

      Constructors 
      Constructor Description
      PostProcessor()  

    • 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.
      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.
      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 getOutputContainer()
      Returns whether to output a container.
      AbstractPostProcessor getPostProcessor()
      Returns the post-processor in use.
      adams.core.io.PlaceholderFile getPostProcessorDetailsOutput()
      Returns the file for the post-processor details.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      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 outputContainerTipText()
      Returns the tip text for this property.
      String postProcessorDetailsOutputTipText()
      Returns the tip text for this property.
      String postProcessorTipText()
      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 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 setOutputContainer​(boolean value)
      Sets whether to output a container.
      void setPostProcessor​(AbstractPostProcessor value)
      Sets the post-processor to use.
      void setPostProcessorDetailsOutput​(adams.core.io.PlaceholderFile value)
      Sets the file for the post-processor details.
      protected String setUpPostProcessor()
      Configures the postprocessor.
      void stopExecution()
      Stops the execution.
      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, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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

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

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

      • m_ActualPostProcessor

        protected AbstractPostProcessor m_ActualPostProcessor
        the postprocessor used for doing the actual work.

      • m_OutputContainer

        protected boolean m_OutputContainer
        whether to output a container.

      • m_PostProcessorDetailsOutput

        protected adams.core.io.PlaceholderFile m_PostProcessorDetailsOutput
        the file to save the cleaner details to.

    • Constructor Detail

      • PostProcessor

        public PostProcessor()

    • 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

      • setPostProcessor

        public void setPostProcessor​(AbstractPostProcessor value)
        Sets the post-processor to use.
        Parameters:
        value - the post-processor

      • getPostProcessor

        public AbstractPostProcessor getPostProcessor()
        Returns the post-processor in use.
        Returns:
        the post-processor

      • postProcessorTipText

        public String postProcessorTipText()
        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.

      • setOutputContainer

        public void setOutputContainer​(boolean value)
        Sets whether to output a container.
        Parameters:
        value - true if to output a container

      • getOutputContainer

        public boolean getOutputContainer()
        Returns whether to output a container.
        Returns:
        true if to output a container

      • outputContainerTipText

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

      • setPostProcessorDetailsOutput

        public void setPostProcessorDetailsOutput​(adams.core.io.PlaceholderFile value)
        Sets the file for the post-processor details.
        Parameters:
        value - the file

      • getPostProcessorDetailsOutput

        public adams.core.io.PlaceholderFile getPostProcessorDetailsOutput()
        Returns the file for the post-processor details.
        Returns:
        the file

      • postProcessorDetailsOutputTipText

        public String postProcessorDetailsOutputTipText()
        Returns the tip text for this property.
        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

      • setUpPostProcessor

        protected String setUpPostProcessor()
        Configures the postprocessor.
        Returns:
        null if successful, otherwise error message

      • 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