weka.core.setupgenerator

Class ListParameter

java.lang.Object

weka.core.setupgenerator.AbstractParameter

weka.core.setupgenerator.AbstractPropertyParameter

weka.core.setupgenerator.ListParameter

All Implemented Interfaces:

Serializable, Cloneable, weka.core.OptionHandler

public class ListParameter
extends AbstractPropertyParameter

Container class for search parameters.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListParameter()

Method Summary

Modifier and Type	Method and Description
String	customerDelimiterTipText() Returns the tip text for this property.
Object	evaluate(Object point) Returns the evaluated value.
String	getCustomDelimiter() Get the custom delimiter to use.
String[]	getItems() Splits the list string using the appropriate delimiter.
String	getList() Get the list of values.
String[]	getOptions() returns the options of the current setup.
String	globalInfo() Returns a string describing the object.
Enumeration	listOptions() Gets an enumeration describing the available options.
String	listTipText() Returns the tip text for this property.
void	setCustomDelimiter(String value) Set the custom delimiter to use.
void	setList(String value) Set the list of values.
void	setOptions(String[] options) Parses the options for this object.
SpaceDimension	spaceDimension() Returns the parameter as space dimensions.
String	toString() Returns a string representation of the search parameter.

Methods inherited from class weka.core.setupgenerator.AbstractPropertyParameter

getProperty, propertyTipText, setProperty

Methods inherited from class weka.core.setupgenerator.AbstractParameter

clone

Methods inherited from class java.lang.Object

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

Methods inherited from interface weka.core.OptionHandler

makeCopy

Constructor Detail

ListParameter

public ListParameter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractPropertyParameter

Returns:

a description suitable for displaying in the explorer/experimenter gui

listOptions

public Enumeration listOptions()

Gets an enumeration describing the available options.

Specified by:

listOptions in interface weka.core.OptionHandler

Overrides:

listOptions in class AbstractPropertyParameter

Returns:

an enumeration of all the available options.

getOptions

public String[] getOptions()

returns the options of the current setup.

Specified by:

getOptions in interface weka.core.OptionHandler

Overrides:

getOptions in class AbstractPropertyParameter

Returns:

the current options

setOptions

public void setOptions(String[] options)
                throws Exception

Parses the options for this object.

Specified by:

setOptions in interface weka.core.OptionHandler

Overrides:

setOptions in class AbstractPropertyParameter

Parameters:

options - the options to use

Throws:

Exception - if setting of options fails

customerDelimiterTipText

public String customerDelimiterTipText()

Returns the tip text for this property.

Returns:

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

getCustomDelimiter

public String getCustomDelimiter()

Get the custom delimiter to use.

Returns:

the delimiter.

setCustomDelimiter

public void setCustomDelimiter(String value)

Set the custom delimiter to use.

Parameters:

value - the delimiter.

listTipText

public String listTipText()

Returns the tip text for this property.

Returns:

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

getList

public String getList()

Get the list of values.

Returns:

the list.

setList

public void setList(String value)

Set the list of values.

Parameters:

value - the list of values.

getItems

public String[] getItems()
                  throws Exception

Splits the list string using the appropriate delimiter.

Returns:

the list items

Throws:

Exception - if the splitting fails

spaceDimension

public SpaceDimension spaceDimension()
                              throws Exception

Returns the parameter as space dimensions.

Specified by:

spaceDimension in class AbstractParameter

Returns:

the dimension

Throws:

Exception - if instantiation of dimension fails

evaluate

public Object evaluate(Object point)

Returns the evaluated value.

Specified by:

evaluate in class AbstractParameter

Parameters:

point - the point to evaluate

Returns:

the evaluated value

toString

public String toString()

Returns a string representation of the search parameter.

Overrides:

toString in class AbstractPropertyParameter

Returns:

a string representation