MOA 12.03
Real Time Analytics for Data Streams
moa.options.Option Interface Reference

Interface representing an option or parameter. More...

Inheritance diagram for moa.options.Option:
Collaboration diagram for moa.options.Option:

List of all members.

Public Member Functions

String getName ()
 Gets the name of this option.
char getCLIChar ()
 Gets the Command Line Interface text of this option.
String getPurpose ()
 Gets the purpose of this option.
String getDefaultCLIString ()
 Gets the Command Line Interface text.
void setValueViaCLIString (String s)
 Sets value of this option via the Command Line Interface text.
String getValueAsCLIString ()
 Gets the value of a Command Line Interface text as a string.
void resetToDefault ()
 Resets this option to the default value.
String getStateString ()
 Gets the state of this option in human readable form.
Option copy ()
 Gets a copy of this option.
JComponent getEditComponent ()
 Gets the GUI component to edit.

Detailed Description

Interface representing an option or parameter.

Author:
Richard Kirkby (rkirkby@cs.waikato.ac.nz)
Version:
Revision:
7

Definition at line 32 of file Option.java.


Member Function Documentation

Option moa.options.Option.copy ( )

Gets a copy of this option.

Returns:
the copy of this option

Implements moa.MOAObject.

Implemented in moa.options.AbstractOption.

Referenced by moa.options.ListOption.cliStringToOptionArray(), moa.options.AbstractOption.copy(), and moa.options.ListOption.setList().

Here is the caller graph for this function:

char moa.options.Option.getCLIChar ( )

Gets the Command Line Interface text of this option.

Returns:
the Command Line Interface text

Implemented in moa.options.AbstractOption.

Referenced by moa.options.Options.addOption().

Here is the caller graph for this function:

String moa.options.Option.getDefaultCLIString ( )

Gets the Command Line Interface text.

Returns:
the Command Line Interface text

Implemented in moa.options.AbstractClassOption, moa.options.FlagOption, moa.options.FloatOption, moa.options.IntOption, moa.options.ListOption, moa.options.MultiChoiceOption, and moa.options.StringOption.

Referenced by moa.options.AbstractOption.resetToDefault().

Here is the caller graph for this function:

JComponent moa.options.Option.getEditComponent ( )
String moa.options.Option.getName ( )

Gets the name of this option.

Returns:
the name of this option

Implemented in moa.options.AbstractOption.

Referenced by moa.options.Options.addOption().

Here is the caller graph for this function:

String moa.options.Option.getPurpose ( )

Gets the purpose of this option.

Returns:
the purpose of this option

Implemented in moa.options.AbstractOption.

String moa.options.Option.getStateString ( )

Gets the state of this option in human readable form.

Returns:
the string with state of this option in human readable form

Implemented in moa.options.AbstractOption, and moa.options.FlagOption.

String moa.options.Option.getValueAsCLIString ( )

Gets the value of a Command Line Interface text as a string.

Returns:
the string with the value of the Command Line Interface text

Implemented in moa.options.AbstractClassOption, moa.options.ClassOption, moa.options.FlagOption, moa.options.FloatOption, moa.options.IntOption, moa.options.ListOption, moa.options.MultiChoiceOption, moa.options.StringOption, and moa.options.WEKAClassOption.

Referenced by moa.options.AbstractOption.getStateString(), and moa.gui.StringOptionEditComponent.StringOptionEditComponent().

Here is the caller graph for this function:

void moa.options.Option.resetToDefault ( )

Resets this option to the default value.

Implemented in moa.options.AbstractOption.


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