weka.datagenerators

Class ClusterDefinition

java.lang.Object

weka.datagenerators.ClusterDefinition

All Implemented Interfaces:

Serializable, OptionHandler, RevisionHandler

Direct Known Subclasses:

SubspaceClusterDefinition

public abstract class ClusterDefinition
extends Object
implements Serializable, OptionHandler, RevisionHandler

Ancestor to all ClusterDefinitions, i.e., subclasses that handle their own parameters that the cluster generator only passes on.

Version:

$Revision: 10203 $

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClusterDefinition() initializes the cluster, without a parent cluster (necessary for GOE)
ClusterDefinition(ClusterGenerator parent) initializes the cluster

Method Summary

Modifier and Type	Method and Description
abstract String[]	getOptions() Gets the current settings of the datagenerator BIRCHCluster.
ClusterGenerator	getParent() returns the parent datagenerator this cluster belongs to
String	globalInfo() Returns a string describing this data generator.
abstract Enumeration<Option>	listOptions() Returns an enumeration describing the available options.
String	parentTipText() Returns the tip text for this property
abstract void	setOptions(String[] options) Parses a list of options for this object.
void	setParent(ClusterGenerator parent) sets the parent datagenerator this cluster belongs to
String	toString() returns a string representation of the cluster

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface weka.core.OptionHandler

makeCopy

Methods inherited from interface weka.core.RevisionHandler

getRevision

Constructor Detail

ClusterDefinition

public ClusterDefinition()

initializes the cluster, without a parent cluster (necessary for GOE)

ClusterDefinition

public ClusterDefinition(ClusterGenerator parent)

initializes the cluster

Parameters:

parent - the datagenerator this cluster belongs to

Method Detail

globalInfo

public String globalInfo()

Returns a string describing this data generator.

Returns:

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

listOptions

public abstract Enumeration<Option> listOptions()

Returns an enumeration describing the available options.

Specified by:

listOptions in interface OptionHandler

Returns:

an enumeration of all the available options

setOptions

public abstract 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 abstract String[] getOptions()

Gets the current settings of the datagenerator BIRCHCluster.

Specified by:

getOptions in interface OptionHandler

Returns:

an array of strings suitable for passing to setOptions

getParent

public ClusterGenerator getParent()

returns the parent datagenerator this cluster belongs to

Returns:

the parent this cluster belongs to

setParent

public void setParent(ClusterGenerator parent)

sets the parent datagenerator this cluster belongs to

Parameters:

parent - the parent datagenerator

parentTipText

public String parentTipText()

Returns the tip text for this property

Returns:

tip text for this property suitable for displaying in the explorer/experimenter gui

toString

public String toString()

returns a string representation of the cluster

Overrides:

toString in class Object

Returns:

the cluster definition as string