ClusterGenerator (interruptible-weka 0.1.2 API)

java.lang.Object
- weka.datagenerators.DataGenerator
- - weka.datagenerators.ClusterGenerator

All Implemented Interfaces:: java.io.Serializable, OptionHandler, Randomizable, RevisionHandler

Direct Known Subclasses:: BIRCHCluster, SubspaceCluster

public abstract class ClusterGenerator
extends DataGenerator

Abstract class for cluster data generators.

Example usage as the main of a datagenerator called RandomGenerator:

 public static void main(String[] args) {
   try {
     DataGenerator.makeData(new RandomGenerator(), args);
   } catch (Exception e) {
     e.printStackTrace();
     System.err.println(e.getMessage());
   }
 }

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Range`	`m_booleanCols` Stores which columns are boolean (default numeric)
`protected boolean`	`m_ClassFlag` class flag
`protected Range`	`m_nominalCols` Stores which columns are nominal (default numeric)
`protected int`	`m_NumAttributes` Number of attribute the dataset should have

Fields inherited from class weka.datagenerators.DataGenerator
m_CreatingRelationName, m_DatasetFormat, m_Debug, m_DefaultOutput, m_NumExamplesAct, m_OptionBlacklist, m_Output, m_Random, m_RelationName, m_Seed

Constructor Summary

Constructors
Constructor and Description

ClusterGenerator()
initializes the generator

Constructors
Constructor and Description
`ClusterGenerator()` initializes the generator

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`booleanColsTipText()` Returns the tip text for this property
`protected java.lang.String`	`checkIndices()` check if attribute types are not contradicting
`java.lang.String`	`classFlagTipText()` Returns the tip text for this property
`protected int`	`defaultNumAttributes()` returns the default number of attributes
`Range`	`getBooleanCols()` returns the range of boolean attributes.
`boolean`	`getClassFlag()` Gets the class flag.
`Range`	`getNominalCols()` returns the range of nominal attributes
`int`	`getNumAttributes()` Gets the number of attributes that should be produced.
`java.lang.String[]`	`getOptions()` Gets the current settings of the classifier.
`java.util.Enumeration<Option>`	`listOptions()` Returns an enumeration describing the available options.
`java.lang.String`	`nominalColsTipText()` Returns the tip text for this property
`java.lang.String`	`numAttributesTipText()` Returns the tip text for this property
`void`	`setBooleanCols(Range value)` Sets which attributes are boolean.
`void`	`setBooleanIndices(java.lang.String rangeList)` Sets which attributes are boolean
`void`	`setClassFlag(boolean classFlag)` Sets the class flag, if class flag is set, the cluster is listed as class atrribute in an extra attribute.
`void`	`setNominalCols(Range value)` Sets which attributes are nominal.
`void`	`setNominalIndices(java.lang.String rangeList)` Sets which attributes are nominal
`void`	`setNumAttributes(int numAttributes)` Sets the number of attributes the dataset should have.
`void`	`setOptions(java.lang.String[] options)` Sets the options.

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_NumAttributes
```
protected int m_NumAttributes
```
    Number of attribute the dataset should have
  - m_ClassFlag
```
protected boolean m_ClassFlag
```
    class flag
  - m_booleanCols
```
protected Range m_booleanCols
```
    Stores which columns are boolean (default numeric)
  - m_nominalCols
```
protected Range m_nominalCols
```
    Stores which columns are nominal (default numeric)
- Constructor Detail
  - ClusterGenerator
```
public ClusterGenerator()
```
    initializes the generator
- Method Detail
  - listOptions
```
public java.util.Enumeration<Option> listOptions()
```
    Returns an enumeration describing the available options.
    
    Specified by:
    
    listOptions in interface OptionHandler
    
    Overrides:
    
    listOptions in class DataGenerator
    
    Returns:
    
    an enumeration of all the available options.
  - setOptions
```
public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
```
    Sets the options.
    
    Specified by:
    
    setOptions in interface OptionHandler
    
    Overrides:
    
    setOptions in class DataGenerator
    
    Parameters:
    
    options - the options
    
    Throws:
    
    java.lang.Exception - if invalid option
  - getOptions
```
public java.lang.String[] getOptions()
```
    Gets the current settings of the classifier.
    
    Specified by:
    
    getOptions in interface OptionHandler
    
    Overrides:
    
    getOptions in class DataGenerator
    
    Returns:
    
    an array of strings suitable for passing to setOptions
    
    See Also:
    
    DataGenerator.removeBlacklist(String[])
  - defaultNumAttributes
```
protected int defaultNumAttributes()
```
    returns the default number of attributes
    
    Returns:
    
    the default number of attributes
  - setNumAttributes
```
public void setNumAttributes(int numAttributes)
```
    Sets the number of attributes the dataset should have.
    
    Parameters:
    
    numAttributes - the new number of attributes
  - getNumAttributes
```
public int getNumAttributes()
```
    Gets the number of attributes that should be produced.
    
    Returns:
    
    the number of attributes that should be produced
  - numAttributesTipText
```
public java.lang.String numAttributesTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setClassFlag
```
public void setClassFlag(boolean classFlag)
```
    Sets the class flag, if class flag is set, the cluster is listed as class atrribute in an extra attribute.
    
    Parameters:
    
    classFlag - the new class flag
  - getClassFlag
```
public boolean getClassFlag()
```
    Gets the class flag.
    
    Returns:
    
    the class flag
  - classFlagTipText
```
public java.lang.String classFlagTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setBooleanIndices
```
public void setBooleanIndices(java.lang.String rangeList)
```
    Sets which attributes are boolean
    
    Parameters:
    
    rangeList - a string representing the list of attributes. Since the string will typically come from a user, attributes are indexed from 1.
    eg: first-3,5,6-last
    
    Throws:
    
    java.lang.IllegalArgumentException - if an invalid range list is supplied
  - setBooleanCols
```
public void setBooleanCols(Range value)
```
    Sets which attributes are boolean.
    
    Parameters:
    
    value - the range to use
  - getBooleanCols
```
public Range getBooleanCols()
```
    returns the range of boolean attributes.
    
    Returns:
    
    the range of boolean attributes
  - booleanColsTipText
```
public java.lang.String booleanColsTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setNominalIndices
```
public void setNominalIndices(java.lang.String rangeList)
```
    Sets which attributes are nominal
    
    Parameters:
    
    rangeList - a string representing the list of attributes. Since the string will typically come from a user, attributes are indexed from 1.
    eg: first-3,5,6-last
    
    Throws:
    
    java.lang.IllegalArgumentException - if an invalid range list is supplied
  - setNominalCols
```
public void setNominalCols(Range value)
```
    Sets which attributes are nominal.
    
    Parameters:
    
    value - the range to use
  - getNominalCols
```
public Range getNominalCols()
```
    returns the range of nominal attributes
    
    Returns:
    
    the range of nominal attributes
  - nominalColsTipText
```
public java.lang.String nominalColsTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - checkIndices
```
protected java.lang.String checkIndices()
```
    check if attribute types are not contradicting
    
    Returns:
    
    empty string if no problem, otherwise error message

Class ClusterGenerator

Field Summary

Fields inherited from class weka.datagenerators.DataGenerator

Constructor Summary

Method Summary

Methods inherited from class weka.datagenerators.DataGenerator

Methods inherited from class java.lang.Object

Methods inherited from interface weka.core.RevisionHandler

Field Detail

m_NumAttributes

m_ClassFlag

m_booleanCols

m_nominalCols

Constructor Detail

ClusterGenerator

Method Detail

listOptions

setOptions

getOptions

defaultNumAttributes

setNumAttributes

getNumAttributes

numAttributesTipText

setClassFlag

getClassFlag

classFlagTipText

setBooleanIndices

setBooleanCols

getBooleanCols

booleanColsTipText

setNominalIndices

setNominalCols

getNominalCols

nominalColsTipText

checkIndices