org.maltparser.core.options

Class OptionDescriptions

java.lang.Object

org.maltparser.core.options.OptionDescriptions

public class OptionDescriptions
extends java.lang.Object

Organizes all the option descriptions. Option descriptions can be loaded from the application data /appdata/options.xml, but also from a plugin option description file (always with the name plugin.xml).

Since:

1.0

Author:

Johan Hall

Constructor Summary

Constructors

Constructor and Description
OptionDescriptions() Creates the Option Descriptions

Method Summary

Modifier and Type	Method and Description
void	generateMaps() Creates several option maps for fast access to individual options.
Option	getOption(java.lang.String optionflag) Returns an option based on the option flag
Option	getOption(java.lang.String optiongroup, java.lang.String optionname) Returns an option based on the option name and/or the option group name
protected java.util.Collection<Option>	getOptionGroupList(java.lang.String groupname) Returns a collection of option that are member of an option group
java.util.TreeSet<java.lang.String>	getOptionGroupNameSet() Return a sorted set of option group names
java.util.Set<Option>	getSaveOptionSet() Returns a set of option that are marked as SAVEOPTION
boolean	hasOptions()
void	parseOptionDescriptionXMLfile(java.net.URL url) Parse a XML file that contains the options used for controlling the application.
java.lang.String	toString()
java.lang.String	toStringMaps() Returns a string representation that contains printable information of several options maps
java.lang.String	toStringOptionGroup(java.lang.String groupname) Returns a string representation of a option group without the option group name in the string.

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionDescriptions

public OptionDescriptions()

Creates the Option Descriptions

Method Detail

getOption

public Option getOption(java.lang.String optiongroup,
                        java.lang.String optionname)
                 throws MaltChainedException

Returns an option based on the option name and/or the option group name

Parameters:

optiongroup - the name of the option group

optionname - the option name

Returns:

an option based on the option name and/or the option group name

Throws:

MaltChainedException

getOption

public Option getOption(java.lang.String optionflag)
                 throws MaltChainedException

Returns an option based on the option flag

Parameters:

optionflag - the option flag

Returns:

an option based on the option flag

Throws:

MaltChainedException

getSaveOptionSet

public java.util.Set<Option> getSaveOptionSet()

Returns a set of option that are marked as SAVEOPTION

Returns:

a set of option that are marked as SAVEOPTION

getOptionGroupNameSet

public java.util.TreeSet<java.lang.String> getOptionGroupNameSet()

Return a sorted set of option group names

Returns:

a sorted set of option group names

getOptionGroupList

protected java.util.Collection<Option> getOptionGroupList(java.lang.String groupname)

Returns a collection of option that are member of an option group

Parameters:

groupname - the name of the option group

Returns:

a collection of option that are member of an option group

parseOptionDescriptionXMLfile

public void parseOptionDescriptionXMLfile(java.net.URL url)
                                   throws MaltChainedException

Parse a XML file that contains the options used for controlling the application. The method calls the parseOptionGroups to parse the set of option groups in the DOM tree.

Parameters:

url - The path to a XML file that explains the options used in the application.

Throws:

OptionException

MaltChainedException

hasOptions

public boolean hasOptions()

generateMaps

public void generateMaps()
                  throws MaltChainedException

Creates several option maps for fast access to individual options.

Throws:

OptionException

MaltChainedException

toStringMaps

public java.lang.String toStringMaps()

Returns a string representation that contains printable information of several options maps

Returns:

a string representation that contains printable information of several options maps

toStringOptionGroup

public java.lang.String toStringOptionGroup(java.lang.String groupname)

Returns a string representation of a option group without the option group name in the string.

Parameters:

groupname - The option group name

Returns:

a string representation of a option group

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object