DataGenerator (weka-stable 3.6.8 API)

java.lang.Object
- weka.datagenerators.DataGenerator

All Implemented Interfaces:

Serializable, OptionHandler, Randomizable, RevisionHandler

Direct Known Subclasses:

ClassificationGenerator, ClusterGenerator, RegressionGenerator
```
public abstract class DataGenerator
extends Object
implements OptionHandler, Randomizable, Serializable, RevisionHandler
```
Abstract superclass for data generators that generate data for classifiers and clusterers.

Version:

$Revision: 1.8 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`m_CreatingRelationName` flag, that indicates whether the relationname is currently assembled
`protected Instances`	`m_DatasetFormat` The format for the generated dataset
`protected boolean`	`m_Debug` Debugging mode
`protected StringWriter`	`m_DefaultOutput` default output (is printed to stdout after generation)
`protected int`	`m_NumExamplesAct` Number of instances that should be produced into the dataset this number is by default m_NumExamples, but can be reset by the generator
`protected static HashSet`	`m_OptionBlacklist` a black list for options not to be listed (for derived generators) in the makeOptionString method
`protected PrintWriter`	`m_Output` PrintWriter for outputting the generated data
`protected Random`	`m_Random` random number generator
`protected String`	`m_RelationName` Relation name the dataset should have
`protected int`	`m_Seed` random number generator seed

Constructor Summary

Constructors
Constructor and Description

DataGenerator()
initializes with default settings.

Constructors
Constructor and Description
`DataGenerator()` initializes with default settings.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`addToBlacklist(String option)` adds the given option, e.g., for "-V" use "V", to the blacklist of options that are not to be output via the makeOptionString method
`protected static void`	`clearBlacklist()` removes all entries from the options blacklist
`String`	`debugTipText()` Returns the tip text for this property
`protected int`	`defaultNumExamplesAct()` returns the default number of actual examples
`StringWriter`	`defaultOutput()` Gets the string writer, which is used for outputting to stdout.
`protected String`	`defaultRelationName()` returns a relation name based on the options
`protected int`	`defaultSeed()` returns the default seed
`Instances`	`defineDataFormat()` Initializes the format for the dataset produced.
`protected Vector`	`enumToVector(Enumeration enm)` creates a vector out of the enumeration from the listOptions of the super class.
`String`	`formatTipText()` Returns the tip text for this property
`abstract Instance`	`generateExample()` Generates one example of the dataset.
`abstract Instances`	`generateExamples()` Generates all examples of the dataset.
`abstract String`	`generateFinished()` Generates a comment string that documentates the data generator.
`abstract String`	`generateStart()` Generates a comment string that documentates the data generator.
`Instances`	`getDatasetFormat()` Gets the format of the dataset that is to be generated.
`boolean`	`getDebug()` Gets the debug flag.
`int`	`getNumExamplesAct()` Gets the number of examples the dataset should have.
`String[]`	`getOptions()` Gets the current settings of the datagenerator RDG1.
`PrintWriter`	`getOutput()` Gets the print writer.
`Random`	`getRandom()` Gets the random generator.
`String`	`getRelationName()` Gets the relation name the dataset should have.
`protected String`	`getRelationNameToUse()` returns the relation name to use, i.e., in case the currently set relation name is empty, a generic one is returned.
`int`	`getSeed()` Gets the random number seed.
`abstract boolean`	`getSingleModeFlag()` Return if single mode is set for the given data generator mode depends on option setting and or generator type.
`protected static boolean`	`isOnBlacklist(String option)` checks, whether the given option is in the blacklist of options not to be output by makeOptionString
`Enumeration`	`listOptions()` Returns an enumeration describing the available options.
`static void`	`makeData(DataGenerator generator, String[] options)` Calls the data generator.
`protected static String`	`makeOptionString(DataGenerator generator)` returns all the options in a string
`protected String`	`numExamplesActTipText()` Returns the tip text for this property
`String`	`outputTipText()` Returns the tip text for this property
`String`	`randomTipText()` Returns the tip text for this property
`String`	`relationNameTipText()` Returns the tip text for this property
`protected String[]`	`removeBlacklist(String[] options)` removes all the options from the options array that are blacklisted
`protected static void`	`runDataGenerator(DataGenerator datagenerator, String[] options)` runs the datagenerator instance with the given options.
`String`	`seedTipText()` Returns the tip text for this property
`void`	`setDatasetFormat(Instances newFormat)` Sets the format of the dataset that is to be generated.
`void`	`setDebug(boolean debug)` Sets the debug flag.
`protected void`	`setNumExamplesAct(int numExamplesAct)` Sets the number of examples the dataset should have.
`void`	`setOptions(String[] options)` Parses a list of options for this object.
`void`	`setOutput(PrintWriter newOutput)` Sets the print writer.
`void`	`setRandom(Random newRandom)` Sets the random generator.
`void`	`setRelationName(String relationName)` Sets the relation name the dataset should have.
`void`	`setSeed(int newSeed)` Sets the random number seed.
`protected String`	`toStringFormat()` Returns a string representing the dataset in the instance queue.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface weka.core.RevisionHandler
getRevision

- Field Detail
  - m_Debug
```
protected boolean m_Debug
```
    Debugging mode
  - m_DatasetFormat
```
protected Instances m_DatasetFormat
```
    The format for the generated dataset
  - m_RelationName
```
protected String m_RelationName
```
    Relation name the dataset should have
  - m_NumExamplesAct
```
protected int m_NumExamplesAct
```
    Number of instances that should be produced into the dataset this number is by default m_NumExamples, but can be reset by the generator
  - m_DefaultOutput
```
protected transient StringWriter m_DefaultOutput
```
    default output (is printed to stdout after generation)
  - m_Output
```
protected transient PrintWriter m_Output
```
    PrintWriter for outputting the generated data
  - m_Seed
```
protected int m_Seed
```
    random number generator seed
  - m_Random
```
protected Random m_Random
```
    random number generator
  - m_CreatingRelationName
```
protected boolean m_CreatingRelationName
```
    flag, that indicates whether the relationname is currently assembled
  - m_OptionBlacklist
```
protected static HashSet m_OptionBlacklist
```
    a black list for options not to be listed (for derived generators) in the makeOptionString method
    
    See Also:
    
    makeOptionString(DataGenerator)
- Constructor Detail
  - DataGenerator
```
public DataGenerator()
```
    initializes with default settings.
    Note: default values are set via a default<name> method. These default methods are also used in the listOptions method and in the setOptions method. Why? Derived generators can override the return value of these default methods, to avoid exceptions.
- Method Detail
  - enumToVector
```
protected Vector enumToVector(Enumeration enm)
```
    creates a vector out of the enumeration from the listOptions of the super class. Only a "convenience" method.
    
    Parameters:
    
    enm - the Enumeration to dump into a vector
    
    Returns:
    
    the elements of the enumeration in a vector
  - listOptions
```
public Enumeration listOptions()
```
    Returns an enumeration describing the available options.
    
    Specified by:
    
    listOptions in interface OptionHandler
    
    Returns:
    
    an enumeration of all the available options
  - setOptions
```
public void setOptions(String[] options)
                throws Exception
```
    Parses a list of options for this object.
    For list of valid options see class description.
    
    Specified by:
    
    setOptions in interface OptionHandler
    
    Parameters:
    
    options - the list of options as an array of strings
    
    Throws:
    
    Exception - if an option is not supported
  - getOptions
```
public String[] getOptions()
```
    Gets the current settings of the datagenerator RDG1. Removing of blacklisted options has to be done in the derived class, that defines the blacklist-entry.
    
    Specified by:
    
    getOptions in interface OptionHandler
    
    Returns:
    
    an array of strings suitable for passing to setOptions
    
    See Also:
    
    removeBlacklist(String[])
  - defineDataFormat
```
public Instances defineDataFormat()
                           throws Exception
```
    Initializes the format for the dataset produced. Must be called before the generateExample or generateExamples methods are used. Also sets a default relation name in case the current relation name is empty.
    
    Returns:
    
    the format for the dataset
    
    Throws:
    
    Exception - if the generating of the format failed
    
    See Also:
    
    defaultRelationName()
  - generateExample
```
public abstract Instance generateExample()
                                  throws Exception
```
    Generates one example of the dataset.
    
    Returns:
    
    the generated example
    
    Throws:
    
    Exception - if the format of the dataset is not yet defined
    
    Exception - if the generator only works with generateExamples which means in non single mode
  - generateExamples
```
public abstract Instances generateExamples()
                                    throws Exception
```
    Generates all examples of the dataset.
    
    Returns:
    
    the generated dataset
    
    Throws:
    
    Exception - if the format of the dataset is not yet defined
    
    Exception - if the generator only works with generateExample, which means in single mode
  - generateStart
```
public abstract String generateStart()
                              throws Exception
```
    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
    
    Throws:
    
    Exception - if the generating of the documentation fails
  - generateFinished
```
public abstract String generateFinished()
                                 throws Exception
```
    Generates a comment string that documentates the data generator. By default this string is added at the end of the produced output as ARFF file type.
    
    Returns:
    
    string contains info about the generated rules
    
    Throws:
    
    Exception - if the generating of the documentation fails
  - getSingleModeFlag
```
public abstract boolean 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
    
    Throws:
    
    Exception - if mode is not set yet
  - setDebug
```
public void setDebug(boolean debug)
```
    Sets the debug flag.
    
    Parameters:
    
    debug - the new debug flag
  - getDebug
```
public boolean getDebug()
```
    Gets the debug flag.
    
    Returns:
    
    the debug flag
  - debugTipText
```
public String debugTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setRelationName
```
public void setRelationName(String relationName)
```
    Sets the relation name the dataset should have.
    
    Parameters:
    
    relationName - the new relation name
  - defaultRelationName
```
protected String defaultRelationName()
```
    returns a relation name based on the options
    
    Returns:
    
    a relation name based on the options
  - getRelationNameToUse
```
protected String getRelationNameToUse()
```
    returns the relation name to use, i.e., in case the currently set relation name is empty, a generic one is returned. Must be used in defineDataFormat()
    
    Returns:
    
    the relation name
    
    See Also:
    
    defaultRelationName(), defineDataFormat()
  - getRelationName
```
public String getRelationName()
```
    Gets the relation name the dataset should have.
    
    Returns:
    
    the relation name the dataset should have
  - relationNameTipText
```
public String relationNameTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - defaultNumExamplesAct
```
protected int defaultNumExamplesAct()
```
    returns the default number of actual examples
    
    Returns:
    
    the default number of actual examples
  - setNumExamplesAct
```
protected void setNumExamplesAct(int numExamplesAct)
```
    Sets the number of examples the dataset should have.
    
    Parameters:
    
    numExamplesAct - the new number of examples
  - getNumExamplesAct
```
public int getNumExamplesAct()
```
    Gets the number of examples the dataset should have.
    
    Returns:
    
    the number of examples the dataset should have
  - numExamplesActTipText
```
protected String numExamplesActTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setOutput
```
public void setOutput(PrintWriter newOutput)
```
    Sets the print writer.
    
    Parameters:
    
    newOutput - the new print writer
  - getOutput
```
public PrintWriter getOutput()
```
    Gets the print writer.
    
    Returns:
    
    print writer object
  - defaultOutput
```
public StringWriter defaultOutput()
```
    Gets the string writer, which is used for outputting to stdout. A workaround for the problem of closing stdout when closing the associated Printwriter.
    
    Returns:
    
    print string writer object
  - outputTipText
```
public String outputTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setDatasetFormat
```
public void setDatasetFormat(Instances newFormat)
```
    Sets the format of the dataset that is to be generated.
    
    Parameters:
    
    newFormat - the new dataset format of the dataset
  - getDatasetFormat
```
public Instances getDatasetFormat()
```
    Gets the format of the dataset that is to be generated.
    
    Returns:
    
    the dataset format of the dataset
  - formatTipText
```
public String formatTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - defaultSeed
```
protected int defaultSeed()
```
    returns the default seed
    
    Returns:
    
    the default seed
  - getSeed
```
public int getSeed()
```
    Gets the random number seed.
    
    Specified by:
    
    getSeed in interface Randomizable
    
    Returns:
    
    the random number seed.
  - setSeed
```
public void setSeed(int newSeed)
```
    Sets the random number seed.
    
    Specified by:
    
    setSeed in interface Randomizable
    
    Parameters:
    
    newSeed - the new random number seed.
  - seedTipText
```
public String seedTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getRandom
```
public Random getRandom()
```
    Gets the random generator.
    
    Returns:
    
    the random generator
  - setRandom
```
public void setRandom(Random newRandom)
```
    Sets the random generator.
    
    Parameters:
    
    newRandom - is the random generator.
  - randomTipText
```
public String randomTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - toStringFormat
```
protected String toStringFormat()
```
    Returns a string representing the dataset in the instance queue.
    
    Returns:
    
    the string representing the output data format
  - clearBlacklist
```
protected static void clearBlacklist()
```
    removes all entries from the options blacklist
  - addToBlacklist
```
protected static void addToBlacklist(String option)
```
    adds the given option, e.g., for "-V" use "V", to the blacklist of options that are not to be output via the makeOptionString method
    
    Parameters:
    
    option - the option to exclude from listing
    
    See Also:
    
    makeOptionString(DataGenerator)
  - isOnBlacklist
```
protected static boolean isOnBlacklist(String option)
```
    checks, whether the given option is in the blacklist of options not to be output by makeOptionString
    
    Parameters:
    
    option - the option to check
    
    Returns:
    
    true if the option is on the blacklist
    
    See Also:
    
    makeOptionString(DataGenerator)
  - removeBlacklist
```
protected String[] removeBlacklist(String[] options)
```
    removes all the options from the options array that are blacklisted
    
    Parameters:
    
    options - the options to remove from the blacklist
    
    Returns:
    
    the processed options array
  - makeOptionString
```
protected static String makeOptionString(DataGenerator generator)
```
    returns all the options in a string
    
    Parameters:
    
    generator - the DataGenerator to return all the options for
    
    Returns:
    
    the assembled option string
  - makeData
```
public static void makeData(DataGenerator generator,
                            String[] options)
                     throws Exception
```
    Calls the data generator.
    
    Parameters:
    
    generator - one of the data generators
    
    options - options of the data generator
    
    Throws:
    
    Exception - if there was an error in the option list
  - runDataGenerator
```
protected static void runDataGenerator(DataGenerator datagenerator,
                                       String[] options)
```
    runs the datagenerator instance with the given options.
    
    Parameters:
    
    datagenerator - the datagenerator to run
    
    options - the commandline options

Class DataGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface weka.core.RevisionHandler

Field Detail

m_Debug

m_DatasetFormat

m_RelationName

m_NumExamplesAct

m_DefaultOutput

m_Output

m_Seed

m_Random

m_CreatingRelationName

m_OptionBlacklist

Constructor Detail

DataGenerator

Method Detail

enumToVector

listOptions

setOptions

getOptions

defineDataFormat

generateExample

generateExamples

generateStart

generateFinished

getSingleModeFlag

setDebug

getDebug

debugTipText

setRelationName

defaultRelationName

getRelationNameToUse

getRelationName

relationNameTipText

defaultNumExamplesAct

setNumExamplesAct

getNumExamplesAct

numExamplesActTipText

setOutput

getOutput

defaultOutput

outputTipText

setDatasetFormat

getDatasetFormat

formatTipText

defaultSeed

getSeed

setSeed

seedTipText

getRandom

setRandom

randomTipText

toStringFormat

clearBlacklist

addToBlacklist

isOnBlacklist

removeBlacklist

makeOptionString

makeData

runDataGenerator