Package adams.flow.source

Class MOAStream

  • 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.OutputProducer, Serializable, Comparable
    public class MOAStream
extends adams.flow.source.AbstractSource
    Generates artificial data using a MOA stream generator.

    Input/output:
    - 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: MOAStream
 
    -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
 
    -stream <moa.options.ClassOption> (property: streamGenerator)
    The stream generator to use for generating the weka.core.Instance objects.
    default: moa.streams.generators.AgrawalGenerator
 
    -num-examples <int> (property: numExamples)
    The number of examples to generate; -1 means infinite.
    default: 10000
    minimum: -1
 
    -chunk-size <int> (property: chunkSize)
    The size of the chunks to create: if 1 then Instance by Instance otherwise 
    an Instances object.
    default: 1
    minimum: 1
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected moa.streams.ExampleStream m_ActualStreamGenerator
      the actual stream generator to use.
      protected int m_ChunkSize
      the chunk size, if 1 then Instance by Instance.
      protected int m_CountExamples
      the number of examples generated so far.
      protected int m_NumExamples
      the maximum number of instance objects to generate.
      protected moa.options.ClassOption m_StreamGenerator
      the stream generator object.

      • 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
      MOAStream()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String chunkSizeTipText()
      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.
      int getChunkSize()
      Returns the chunk size of data to generate; if 1 then Instance by Instance otherwise an Instances object.
      protected moa.streams.ExampleStream getCurrentStreamGenerator()
      Returns the current stream generator, based on the class option.
      protected moa.streams.ExampleStream getDefaultGenerator()
      Returns the default stream generator.
      protected moa.options.ClassOption getDefaultOption()
      Returns the default class option.
      int getNumExamples()
      Returns the number of examples to generate.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      moa.options.ClassOption getStreamGenerator()
      Returns the data generator in use.
      String globalInfo()
      Returns a string describing the object.
      boolean hasPendingOutput()
      Checks whether there is pending output to be collected after executing the flow item.
      protected void initialize()
      Initializes the members.
      String numExamplesTipText()
      Returns the tip text for this property.
      adams.flow.core.Token output()
      Returns the generated token.
      protected void reset()
      Initializes the members.
      void setChunkSize​(int value)
      Sets the chunk size of data to generate; if 1 then Instance by Instance otherwise an Instances object.
      void setNumExamples​(int value)
      Sets the maximum number of examples to generate.
      void setStreamGenerator​(moa.options.ClassOption value)
      Sets the stream generator to use.
      String streamGeneratorTipText()
      Returns the tip text for this property.

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

        annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, 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, postExecute, preExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

      • 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, execute, 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, variableChanged, wrapUp

      • 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

      • m_ActualStreamGenerator

        protected moa.streams.ExampleStream m_ActualStreamGenerator
        the actual stream generator to use.

      • m_StreamGenerator

        protected moa.options.ClassOption m_StreamGenerator
        the stream generator object.

      • m_NumExamples

        protected int m_NumExamples
        the maximum number of instance objects to generate.

      • m_CountExamples

        protected int m_CountExamples
        the number of examples generated so far.

      • m_ChunkSize

        protected int m_ChunkSize
        the chunk size, if 1 then Instance by Instance.

    • Constructor Detail

      • MOAStream

        public MOAStream()

    • 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()
        Initializes the members.
        Overrides:
        reset in class adams.flow.core.AbstractActor

      • initialize

        protected void initialize()
        Initializes the members.
        Overrides:
        initialize 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

      • getDefaultGenerator

        protected moa.streams.ExampleStream getDefaultGenerator()
        Returns the default stream generator.
        Returns:
        the generator

      • getDefaultOption

        protected moa.options.ClassOption getDefaultOption()
        Returns the default class option.
        Returns:
        the option

      • setStreamGenerator

        public void setStreamGenerator​(moa.options.ClassOption value)
        Sets the stream generator to use.
        Parameters:
        value - the stream generator

      • getStreamGenerator

        public moa.options.ClassOption getStreamGenerator()
        Returns the data generator in use.
        Returns:
        the data generator

      • streamGeneratorTipText

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

      • getCurrentStreamGenerator

        protected moa.streams.ExampleStream getCurrentStreamGenerator()
        Returns the current stream generator, based on the class option.
        Returns:
        the stream generator
        See Also:
        getStreamGenerator()

      • setNumExamples

        public void setNumExamples​(int value)
        Sets the maximum number of examples to generate. Less or equal to 0 means infinite.
        Parameters:
        value - the maximum number

      • getNumExamples

        public int getNumExamples()
        Returns the number of examples to generate. Less or equal to 0 means infinite.
        Returns:
        the maximum number

      • numExamplesTipText

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

      • setChunkSize

        public void setChunkSize​(int value)
        Sets the chunk size of data to generate; if 1 then Instance by Instance otherwise an Instances object.
        Parameters:
        value - the chunk size

      • getChunkSize

        public int getChunkSize()
        Returns the chunk size of data to generate; if 1 then Instance by Instance otherwise an Instances object.
        Returns:
        the chunk size

      • chunkSizeTipText

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

      • generates

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

      • 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

      • output

        public adams.flow.core.Token output()
        Returns the generated token.
        Returns:
        the generated token

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether there is pending output to be collected after executing the flow item.
        Returns:
        true if there is pending output