org.maltparser.core.options.option

Class Option

java.lang.Object

org.maltparser.core.options.option.Option

All Implemented Interfaces:

java.lang.Comparable<Option>

Direct Known Subclasses:

BoolOption, ClassOption, EnumOption, IntegerOption, StringEnumOption, StringOption, UnaryOption

public abstract class Option
extends java.lang.Object
implements java.lang.Comparable<Option>

Abstract class that contains description of an option that are the same over all option types.

Since:

1.0

Author:

Johan Hall

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTH The option is relevant both during learning and processing (parsing)
static int	NONE
static int	PROCESS The option is only relevant during processing (parsing)
static int	SAVE The option is saved during learning and cannot be overloaded during processing (parsing)
static int	TRAIN The option is only relevant during learning

Constructor Summary

Constructors

Constructor and Description
Option(OptionGroup group, java.lang.String name, java.lang.String shortDescription, java.lang.String flag, java.lang.String usage) Creates an option description

Method Summary

Modifier and Type	Method and Description
int	compareTo(Option o)
abstract java.lang.Object	getDefaultValueObject() Returns the object for the default value for option.
abstract java.lang.String	getDefaultValueString() Returns a string representation of the default value.
java.lang.String	getFlag() Returns a character that is used as a flag for the command line input
OptionGroup	getGroup() Returns a reference to a option group.
java.lang.String	getName() Returns the name of the option.
java.lang.String	getShortDescription() Returns a short description of the option
abstract java.lang.String	getStringRepresentation(java.lang.Object value) Returns a string representation of the option value.
int	getUsage() Returns the usage of the option.
abstract java.lang.Object	getValueObject(java.lang.String value) Returns the corresponding object for the option value (specified as a string value).
boolean	isAmbiguous() Returns true if the option name is ambiguous over all option groups, otherwise false.
void	setAmbiguous(boolean ambiguous) Sets true if the option name is ambiguous over all option groups, otherwise false.
abstract void	setDefaultValue(java.lang.String defaultValue) Sets the default value for the option.
void	setFlag(java.lang.String flag) Sets a character that is used as a flag for the command line input
void	setUsage(int usage) Sets the usage of the option.
void	setUsage(java.lang.String usage) Sets the usage of the option.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NONE

public static final int NONE

See Also:

Constant Field Values

TRAIN

public static final int TRAIN

The option is only relevant during learning

See Also:

Constant Field Values

PROCESS

public static final int PROCESS

The option is only relevant during processing (parsing)

See Also:

Constant Field Values

BOTH

public static final int BOTH

The option is relevant both during learning and processing (parsing)

See Also:

Constant Field Values

SAVE

public static final int SAVE

The option is saved during learning and cannot be overloaded during processing (parsing)

See Also:

Constant Field Values

Constructor Detail

Option

public Option(OptionGroup group,
              java.lang.String name,
              java.lang.String shortDescription,
              java.lang.String flag,
              java.lang.String usage)
       throws MaltChainedException

Creates an option description

Parameters:

group - a reference to the option group.

name - the name of the option.

shortDescription - a short description of the option.

flag - a flag that can be used in the command line.

usage - a string that explains the usage of the option.

Throws:

OptionException

MaltChainedException

Method Detail

getValueObject

public abstract java.lang.Object getValueObject(java.lang.String value)
                                         throws MaltChainedException

Returns the corresponding object for the option value (specified as a string value).

Parameters:

value - the string option value

Returns:

the corresponding object for the option value (specified as a string value).

Throws:

OptionException

MaltChainedException

getDefaultValueObject

public abstract java.lang.Object getDefaultValueObject()
                                                throws MaltChainedException

Returns the object for the default value for option.

Returns:

the object for the default value for option.

Throws:

OptionException

MaltChainedException

getDefaultValueString

public abstract java.lang.String getDefaultValueString()

Returns a string representation of the default value.

Returns:

a string representation of the default value

setDefaultValue

public abstract void setDefaultValue(java.lang.String defaultValue)
                              throws MaltChainedException

Sets the default value for the option.

Parameters:

defaultValue - the string default value

Throws:

OptionException

MaltChainedException

getStringRepresentation

public abstract java.lang.String getStringRepresentation(java.lang.Object value)

Returns a string representation of the option value.

Parameters:

value - an option value object

Returns:

a string representation of the option value, if the option value could not be found null is returned.

getGroup

public OptionGroup getGroup()

Returns a reference to a option group.

Returns:

a reference to a option group.

getName

public java.lang.String getName()

Returns the name of the option.

Returns:

the name of the option.

getShortDescription

public java.lang.String getShortDescription()

Returns a short description of the option

Returns:

a short description of the option

getFlag

public java.lang.String getFlag()

Returns a character that is used as a flag for the command line input

Returns:

a character that is used as a flag for the command line input

setFlag

public void setFlag(java.lang.String flag)
             throws MaltChainedException

Sets a character that is used as a flag for the command line input

Parameters:

flag - a character that is used as a flag for the command line input

Throws:

OptionException

MaltChainedException

getUsage

public int getUsage()

Returns the usage of the option.

Returns:

the usage of the option.

setUsage

public void setUsage(java.lang.String usage)
              throws MaltChainedException

Sets the usage of the option.

Parameters:

usage - the usage of the option.

Throws:

OptionException

MaltChainedException

setUsage

public void setUsage(int usage)
              throws MaltChainedException

Sets the usage of the option.

Parameters:

usage - the usage of the option.

Throws:

OptionException

MaltChainedException

isAmbiguous

public boolean isAmbiguous()

Returns true if the option name is ambiguous over all option groups, otherwise false.

Returns:

true if the option name is ambiguous over all option groups, otherwise false.

setAmbiguous

public void setAmbiguous(boolean ambiguous)

Sets true if the option name is ambiguous over all option groups, otherwise false.

Parameters:

ambiguous - true if the option name is ambiguous over all option groups, otherwise false.

compareTo

public int compareTo(Option o)

Specified by:

compareTo in interface java.lang.Comparable<Option>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object