edu.ucla.sspace.mains

Class OptionDescriptions

java.lang.Object

edu.ucla.sspace.mains.OptionDescriptions

public final class OptionDescriptions
extends Object

A utility class that contains string descriptions of differnt command line options. Classes that are designed to execute a SemanticSpace algorithm are encouraged to use this class to generate option descriptions for their help messages.

All return strings are formatted to fit in under 80 columns of text and are not terminated with a newline. The descriptions do not contain any option specification (e.g. -g, --compoundWords) themselves; the calling code will need to specify how these behaviors are invoked.

See Also:

GenericMain

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPOUND_WORDS_DESCRIPTION A description of the file used to specify compound words.
static String	FILE_FORMAT_DESCRIPTION A description of the output file format produced by SemanticSpaceIO
static String	HELP_DESCRIPTION A description of who to contact for bugs
static String	SVD_DESCRIPTION A description of the configuration SVD algorithm
static String	TOKEN_FILTER_DESCRIPTION A description of the use of a TokenFilter.
static String	TOKEN_STEMMING_DESCRIPTION A description of the use of a Stemmer.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

COMPOUND_WORDS_DESCRIPTION

public static final String COMPOUND_WORDS_DESCRIPTION

A description of the file used to specify compound words.

See Also:

Constant Field Values

TOKEN_FILTER_DESCRIPTION

public static final String TOKEN_FILTER_DESCRIPTION

A description of the use of a TokenFilter.

See Also:

Constant Field Values

TOKEN_STEMMING_DESCRIPTION

public static final String TOKEN_STEMMING_DESCRIPTION

A description of the use of a Stemmer.

See Also:

Constant Field Values

FILE_FORMAT_DESCRIPTION

public static final String FILE_FORMAT_DESCRIPTION

A description of the output file format produced by SemanticSpaceIO

See Also:

Constant Field Values

HELP_DESCRIPTION

public static final String HELP_DESCRIPTION

A description of who to contact for bugs

See Also:

Constant Field Values

SVD_DESCRIPTION

public static final String SVD_DESCRIPTION

A description of the configuration SVD algorithm