MaltParser 1.4.1

org.maltparser.core.options.option
Class StringEnumOption

java.lang.Object
  extended by org.maltparser.core.options.option.Option
      extended by org.maltparser.core.options.option.StringEnumOption
All Implemented Interfaces:
Comparable<Option>

public class StringEnumOption
extends Option

A string enum type option is an option that can only contain string value that corresponds to another string.

Since:
1.0
Author:
Johan Hall

Field Summary
 
Fields inherited from class org.maltparser.core.options.option.Option
BOTH, NONE, PROCESS, SAVE, TRAIN
 
Constructor Summary
StringEnumOption(OptionGroup group, String name, String shortDescription, String flag, String usage)
          Creates a stringenum type option description
 
Method Summary
 void addLegalValue(String value, String desc, String mapto)
          Adds a legal value that corresponds to another string
 Object getDefaultValueObject()
          Returns the object for the default value for option.
 String getDefaultValueString()
          Returns a string representation of the default value.
 String getLegalValueMapToString(String value)
          Returns the mapped legal value
 String getLegalValueString(String value)
          Returns the legal value identifier name (an enumerate string value)
 String getMapto(String value)
          Returns the mapped legal value that corresponds to the enumerate string value.
 String getStringRepresentation(Object value)
          Returns a string representation of the option value.
 Object getValueObject(String value)
          Returns the corresponding object for the option value (specified as a string value).
 void setDefaultValue(String defaultValue)
          Sets the default value for the option.
 String toString()
           
 
Methods inherited from class org.maltparser.core.options.option.Option
compareTo, getFlag, getGroup, getName, getShortDescription, getUsage, isAmbiguous, setAmbiguous, setFlag, setGroup, setName, setShortDescription, setUsage, setUsage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StringEnumOption

public StringEnumOption(OptionGroup group,
                        String name,
                        String shortDescription,
                        String flag,
                        String usage)
                 throws MaltChainedException
Creates a stringenum type 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 short string 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 Object getValueObject(String value)
                      throws MaltChainedException
Description copied from class: Option
Returns the corresponding object for the option value (specified as a string value).

Specified by:
getValueObject in class Option
Parameters:
value - the string option value
Returns:
the corresponding object for the option value (specified as a string value).
Throws:
OptionException
MaltChainedException

getDefaultValueObject

public Object getDefaultValueObject()
                             throws MaltChainedException
Description copied from class: Option
Returns the object for the default value for option.

Specified by:
getDefaultValueObject in class Option
Returns:
the object for the default value for option.
Throws:
OptionException
MaltChainedException

getLegalValueString

public String getLegalValueString(String value)
                           throws MaltChainedException
Returns the legal value identifier name (an enumerate string value)

Parameters:
value - the mapped legal value
Returns:
the legal value identifier name, null if it could not be found
Throws:
MaltChainedException

getLegalValueMapToString

public String getLegalValueMapToString(String value)
                                throws MaltChainedException
Returns the mapped legal value

Parameters:
value - an enumerate string value
Returns:
the mapped legal value, null if it could not be found
Throws:
MaltChainedException

setDefaultValue

public void setDefaultValue(String defaultValue)
                     throws MaltChainedException
Description copied from class: Option
Sets the default value for the option.

Specified by:
setDefaultValue in class Option
Parameters:
defaultValue - the string default value
Throws:
OptionException
MaltChainedException

getDefaultValueString

public String getDefaultValueString()
Description copied from class: Option
Returns a string representation of the default value.

Specified by:
getDefaultValueString in class Option
Returns:
a string representation of the default value

getMapto

public String getMapto(String value)
Returns the mapped legal value that corresponds to the enumerate string value.

Parameters:
value - an enumerate string value
Returns:
the mapped legal value that corresponds to the enumerate string value.

addLegalValue

public void addLegalValue(String value,
                          String desc,
                          String mapto)
                   throws MaltChainedException
Adds a legal value that corresponds to another string

Parameters:
value - a legal value name
desc - a short description of the legal value
mapto - a mapto string value
Throws:
OptionException
MaltChainedException

getStringRepresentation

public String getStringRepresentation(Object value)
Description copied from class: Option
Returns a string representation of the option value.

Specified by:
getStringRepresentation in class Option
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.

toString

public String toString()
Overrides:
toString in class Option

MaltParser 1.4.1

Copyright 2007-2010 Johan Hall, Jens Nilsson and Joakim Nivre.