MOA 12.03
Real Time Analytics for Data Streams
weka.datagenerators.classifiers.classification.MOA Class Reference

A wrapper around MOA instance streams. More...

Inheritance diagram for weka.datagenerators.classifiers.classification.MOA:
Collaboration diagram for weka.datagenerators.classifiers.classification.MOA:

List of all members.

Public Member Functions

String globalInfo ()
 Returns a string describing this data generator.
Enumeration listOptions ()
 Returns an enumeration describing the available options.
void setOptions (String[] options) throws Exception
 Parses a list of options for this object.
String[] getOptions ()
 Gets the current settings of the datagenerator.
void setGenerator (ClassOption value)
 Sets the MOA stream generator to use.
ClassOption getGenerator ()
 Returns the current MOA stream generator in use.
String generatorTipText ()
 Returns the tooltip displayed in the GUI.
boolean getSingleModeFlag () throws Exception
 Return if single mode is set for the given data generator mode depends on option setting and or generator type.
Instances defineDataFormat () throws Exception
 Initializes the format for the dataset produced.
Instance generateExample () throws Exception
 Generates one example of the dataset.
Instances generateExamples () throws Exception
 Generates all examples of the dataset.
String generateStart ()
 Generates a comment string that documentates the data generator.
String generateFinished () throws Exception
 Generates a comment string that documentats the data generator.
String getRevision ()
 Returns the revision string.

Static Public Member Functions

static void main (String[] args)
 Main method for executing this class.

Protected Attributes

InstanceStream m_ActualGenerator = new LEDGenerator()
 the actual data generator.
ClassOption m_Generator = new ClassOption("InstanceStream", 'B', "The MOA instance stream generator to use from within WEKA.", InstanceStream.class, m_ActualGenerator.getClass().getName())
 for manipulating the generator through the GUI.

Detailed Description

A wrapper around MOA instance streams.

Valid options are:

 -h
  Prints this help.
 -o <file>
  The name of the output file, otherwise the generated data is
  printed to stdout.
 -r <name>
  The name of the relation.
 -d
  Whether to print debug informations.
 -S
  The seed for random function (default 1)
 -n <num>
  The number of examples to generate (default 100)
 -B <classname + options>
  The MOA stream generator.
  (default: moa.streams.generators.LEDGenerator)
Author:
FracPete (fracpete at waikato dot ac dot nz)
Version:
$Revision$

Definition at line 79 of file datagenerators/classifiers/classification/MOA.java.


Member Function Documentation

Instances weka.datagenerators.classifiers.classification.MOA.defineDataFormat ( ) throws Exception

Initializes the format for the dataset produced.

Returns:
the format for the dataset
Exceptions:
Exceptionif the generating of the format failed

Definition at line 233 of file datagenerators/classifiers/classification/MOA.java.

Here is the call graph for this function:

Instance weka.datagenerators.classifiers.classification.MOA.generateExample ( ) throws Exception

Generates one example of the dataset.

Returns:
the generated example, null if no further example available
Exceptions:
Exceptionif the format of the dataset is not yet defined
Exceptionif the generator only works with generateExamples which means in non single mode

Definition at line 259 of file datagenerators/classifiers/classification/MOA.java.

Referenced by weka.datagenerators.classifiers.classification.MOA.generateExamples().

Here is the call graph for this function:

Here is the caller graph for this function:

Instances weka.datagenerators.classifiers.classification.MOA.generateExamples ( ) throws Exception

Generates all examples of the dataset.

Re-initializes the random number generator with the given seed, before generating instances.

Returns:
the generated dataset
Exceptions:
Exceptionif the format of the dataset is not yet defined
Exceptionif the generator only works with generateExample, which means in single mode
See also:
#getSeed()

Definition at line 276 of file datagenerators/classifiers/classification/MOA.java.

Here is the call graph for this function:

String weka.datagenerators.classifiers.classification.MOA.generateFinished ( ) throws Exception

Generates a comment string that documentats the data generator.

By default this string is added at the end of theproduces output as ARFF file type.

Returns:
string contains info about the generated rules
Exceptions:
Exceptionif the generating of the documentaion fails

Definition at line 314 of file datagenerators/classifiers/classification/MOA.java.

String weka.datagenerators.classifiers.classification.MOA.generateStart ( )

Generates a comment string that documentates the data generator.

By default this string is added at the beginning of the produced output as ARFF file type, next after the options.

Returns:
string contains info about the generated rules

Definition at line 302 of file datagenerators/classifiers/classification/MOA.java.

String weka.datagenerators.classifiers.classification.MOA.generatorTipText ( )

Returns the tooltip displayed in the GUI.

Returns:
the tooltip

Definition at line 212 of file datagenerators/classifiers/classification/MOA.java.

ClassOption weka.datagenerators.classifiers.classification.MOA.getGenerator ( )

Returns the current MOA stream generator in use.

Returns:
the stream generator in use

Definition at line 203 of file datagenerators/classifiers/classification/MOA.java.

String [] weka.datagenerators.classifiers.classification.MOA.getOptions ( )

Gets the current settings of the datagenerator.

Returns:
an array of strings suitable for passing to setOptions

Definition at line 171 of file datagenerators/classifiers/classification/MOA.java.

Here is the call graph for this function:

String weka.datagenerators.classifiers.classification.MOA.getRevision ( )

Returns the revision string.

Returns:
the revision

Definition at line 323 of file datagenerators/classifiers/classification/MOA.java.

boolean weka.datagenerators.classifiers.classification.MOA.getSingleModeFlag ( ) throws Exception

Return if single mode is set for the given data generator mode depends on option setting and or generator type.

Returns:
single mode flag, always true
Exceptions:
Exceptionif mode is not set yet

Definition at line 223 of file datagenerators/classifiers/classification/MOA.java.

String weka.datagenerators.classifiers.classification.MOA.globalInfo ( )

Returns a string describing this data generator.

Returns:
a description of the data generator suitable for displaying in the explorer/experimenter gui

Definition at line 97 of file datagenerators/classifiers/classification/MOA.java.

Enumeration weka.datagenerators.classifiers.classification.MOA.listOptions ( )

Returns an enumeration describing the available options.

Returns:
an enumeration of all the available options

Definition at line 106 of file datagenerators/classifiers/classification/MOA.java.

Here is the call graph for this function:

static void weka.datagenerators.classifiers.classification.MOA.main ( String[]  args) [static]

Main method for executing this class.

Parameters:
argsshould contain arguments for the data producer:

Definition at line 332 of file datagenerators/classifiers/classification/MOA.java.

void weka.datagenerators.classifiers.classification.MOA.setGenerator ( ClassOption  value)

Sets the MOA stream generator to use.

Parameters:
valuethe stream generator to use

Definition at line 193 of file datagenerators/classifiers/classification/MOA.java.

Referenced by weka.datagenerators.classifiers.classification.MOA.setOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

void weka.datagenerators.classifiers.classification.MOA.setOptions ( String[]  options) throws Exception

Parses a list of options for this object.

Valid options are:

 -h
  Prints this help.
 -o <file>
  The name of the output file, otherwise the generated data is
  printed to stdout.
 -r <name>
  The name of the relation.
 -d
  Whether to print debug informations.
 -S
  The seed for random function (default 1)
 -n <num>
  The number of examples to generate (default 100)
 -B <classname + options>
  The MOA stream generator.
  (default: moa.streams.generators.LEDGenerator)
Parameters:
optionsthe list of options as an array of strings
Exceptions:
Exceptionif an option is not supported

Definition at line 151 of file datagenerators/classifiers/classification/MOA.java.

Here is the call graph for this function:


Member Data Documentation

ClassOption weka.datagenerators.classifiers.classification.MOA.m_Generator = new ClassOption("InstanceStream", 'B', "The MOA instance stream generator to use from within WEKA.", InstanceStream.class, m_ActualGenerator.getClass().getName()) [protected]

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations