edu.mit.jmwe.data

Enum MWEPOS

java.lang.Object

java.lang.Enum<MWEPOS>

edu.mit.jmwe.data.MWEPOS

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MWEPOS>

public enum MWEPOS
extends java.lang.Enum<MWEPOS>

Represents the part of speech of a multi-word expression.

Since:

jMWE 1.0.0

Version:

$Id: MWEPOS.java 290 2011-05-05 19:54:11Z markaf $

Author:

Nidhi Kulkarni, M.A. Finlayson

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADJECTIVE
ADVERB
NOUN
OTHER
PROPER_NOUN
VERB

Method Summary

Modifier and Type	Method and Description
static MWEPOS	fromChar(char identifier) This convenience method allows retrieval of the MWEPOS object given the part of speech character.
char	getIdentifier() Returns the character identifier for the part-of-speech.
java.util.Set<java.lang.String>	getPrefixes() Returns the set of prefixes for the part-of-speech.
static MWEPOS	toMWEPOS(java.lang.String tag) This convenience method allows retrieval of the MWEPOS object given the part of speech tag as a String.
static MWEPOS	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MWEPOS[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADJECTIVE

public static final MWEPOS ADJECTIVE

NOUN

public static final MWEPOS NOUN

OTHER

public static final MWEPOS OTHER

PROPER_NOUN

public static final MWEPOS PROPER_NOUN

ADVERB

public static final MWEPOS ADVERB

VERB

public static final MWEPOS VERB

Method Detail

values

public static MWEPOS[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MWEPOS c : MWEPOS.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MWEPOS valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getIdentifier

public char getIdentifier()

Returns the character identifier for the part-of-speech.

Returns:

the character identifier for the part-of-speech.

Since:

jMWE 1.0.0

getPrefixes

public java.util.Set<java.lang.String> getPrefixes()

Returns the set of prefixes for the part-of-speech. Will not return null, but may return an empty set.

Returns:

the non-null, possibly empty set of prefixes for the part-of-speech.

Since:

jMWE 1.0.0

fromChar

public static MWEPOS fromChar(char identifier)

This convenience method allows retrieval of the MWEPOS object given the part of speech character.

Parameters:

identifier - the identifier for which the MWEPOS is needed; if no MWEPOS object corresponds to the specified identifier, this method returns null

Returns:

the MWEPOS corresponding to the specified identifier

Since:

jMWE 1.0.0

toMWEPOS

public static MWEPOS toMWEPOS(java.lang.String tag)

This convenience method allows retrieval of the MWEPOS object given the part of speech tag as a String.

Parameters:

tag - the part-of-speech tag to be converted to an MWEPOS object

Returns:

the MWE part of speech object corresponding to the tag; if no appropriate tag is found, will return the OTHER object; will never return null

Throws:

java.lang.NullPointerException - if the argument is null

java.lang.IllegalArgumentException - if the argument is empty or all whitespace

Since:

jMWE 1.0.0