MOA 12.03
Real Time Analytics for Data Streams
moa.options.AbstractOption Class Reference

Abstract option. More...

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

List of all members.

Public Member Functions

 AbstractOption (String name, char cliChar, String purpose)
 Creates a new instance of an abstract option given its class name, command line interface text and its purpose.
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.
void resetToDefault ()
 Resets this option to the default value.
String getStateString ()
 Gets the state of this option in human readable form.
Option copy ()
 This method produces a copy of this object.
void getDescription (StringBuilder sb, int indent)
 Returns a string representation of this object.
JComponent getEditComponent ()
 Gets the GUI component to edit.

Static Public Member Functions

static boolean nameIsLegal (String optionName)
 Gets whether the name is valid or not.

Static Public Attributes

static final char[] illegalNameCharacters
 Array of characters not valid to use in option names.

Protected Attributes

String name
 Name of this option.
char cliChar
 Command line interface text of this option.
String purpose
 Text of the purpose of this option.

Detailed Description

Abstract option.

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

Definition at line 33 of file AbstractOption.java.


Constructor & Destructor Documentation

moa.options.AbstractOption.AbstractOption ( String  name,
char  cliChar,
String  purpose 
)

Creates a new instance of an abstract option given its class name, command line interface text and its purpose.

Parameters:
namethe name of this option
cliCharthe command line interface text
purposethe text describing the purpose of this option

Definition at line 72 of file AbstractOption.java.

Here is the call graph for this function:


Member Function Documentation

Option moa.options.AbstractOption.copy ( )

This method produces a copy of this object.

Returns:
a copy of this object

Reimplemented from moa.AbstractMOAObject.

Definition at line 107 of file AbstractOption.java.

Referenced by moa.gui.MultiChoiceOptionEditComponent.setEditState(), weka.datagenerators.classifiers.classification.MOA.setOptions(), and weka.classifiers.meta.MOA.setOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

char moa.options.AbstractOption.getCLIChar ( )

Gets the Command Line Interface text of this option.

Returns:
the Command Line Interface text

Implements moa.options.Option.

Definition at line 87 of file AbstractOption.java.

void moa.options.AbstractOption.getDescription ( StringBuilder  sb,
int  indent 
)

Returns a string representation of this object.

Used in AbstractMOAObject.toString to give a string representation of the object.

Parameters:
sbthe stringbuilder to add the description
indentthe number of characters to indent

Implements moa.MOAObject.

Definition at line 112 of file AbstractOption.java.

JComponent moa.options.AbstractOption.getEditComponent ( )
String moa.options.AbstractOption.getName ( )
String moa.options.AbstractOption.getPurpose ( )

Gets the purpose of this option.

Returns:
the purpose of this option

Implements moa.options.Option.

Definition at line 92 of file AbstractOption.java.

String moa.options.AbstractOption.getStateString ( )

Gets the state of this option in human readable form.

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

Implements moa.options.Option.

Reimplemented in moa.options.FlagOption.

Definition at line 102 of file AbstractOption.java.

Here is the call graph for this function:

static boolean moa.options.AbstractOption.nameIsLegal ( String  optionName) [static]

Gets whether the name is valid or not.

Parameters:
optionNamethe name of the option
Returns:
true if the name that not contain any illegal character

Definition at line 55 of file AbstractOption.java.

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

Here is the caller graph for this function:

void moa.options.AbstractOption.resetToDefault ( )

Resets this option to the default value.

Implements moa.options.Option.

Definition at line 97 of file AbstractOption.java.

Referenced by moa.options.AbstractClassOption.AbstractClassOption(), moa.options.FloatOption.FloatOption(), moa.options.IntOption.IntOption(), moa.options.ListOption.ListOption(), moa.options.MultiChoiceOption.MultiChoiceOption(), and moa.options.StringOption.StringOption().

Here is the call graph for this function:

Here is the caller graph for this function:


Member Data Documentation

Initial value:
 new char[]{' ', '-',
        '(', ')'}

Array of characters not valid to use in option names.

Definition at line 37 of file AbstractOption.java.

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


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