adams.flow.source
Class MOAStream

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.source.AbstractSource
                  adams.flow.source.MOAStream

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, Actor, ErrorHandler, OutputProducer, ProvenanceSupporter, Serializable, Comparable

public class MOAStream
extends AbstractSource
implements ProvenanceSupporter

Generates artificial data using a MOA stream generator.

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

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-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 (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-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
 

Version:

$Revision: 5867 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected moa.streams.InstanceStream	m_ActualStreamGenerator the actual stream generator to use.
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_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

MOAStream()

Method Summary

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.
protected moa.streams.InstanceStream	getCurrentStreamGenerator() Returns the current stream generator, based on the class option.
protected moa.streams.InstanceStream	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.
String	numExamplesTipText() Returns the tip text for this property.
Token	output() Returns the generated token.
protected void	reset() Initializes the members.
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.
void	updateProvenance(ProvenanceContainer cont) Updates the provenance information in the provided container.

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged, wrapUp

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, debug, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, sizeOf, stopExecution, stopExecution, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Field Detail

m_ActualStreamGenerator

protected moa.streams.InstanceStream 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.

Constructor Detail

MOAStream

public MOAStream()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractActor

reset

protected void reset()

Initializes the members.

Overrides:

reset in class AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Specified by:

getQuickInfo in interface Actor

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

getDefaultGenerator

protected moa.streams.InstanceStream 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.InstanceStream 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.

generates

public Class[] generates()

Returns the class of objects that it generates.

Specified by:

generates in interface OutputProducer

Returns:

weka.core.Instance.class

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Returns:

the generated token

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface OutputProducer

Returns:

true if there is pending output

updateProvenance

public void updateProvenance(ProvenanceContainer cont)

Updates the provenance information in the provided container.

Specified by:

updateProvenance in interface ProvenanceSupporter

Parameters:

cont - the provenance container to update