simplenlg.framework

Enum PhraseCategory

java.lang.Object

java.lang.Enum<PhraseCategory>

simplenlg.framework.PhraseCategory

All Implemented Interfaces:

Serializable, Comparable<PhraseCategory>, ElementCategory

public enum PhraseCategory
extends Enum<PhraseCategory>
implements ElementCategory

This enumeration defines the different syntactical phrases. The categories define the well understood roles for each typue of phrase in language. For example, the dog is a noun phrase, the dog chases Mary is a clause, beautiful is an adjective phrase, and so on.

Version:

4.0

Author:

A. Gatt and D. Westwater, University of Aberdeen.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADJECTIVE_PHRASE A phrase relating to an adjective.
ADVERB_PHRASE A phrase relating to an adverb.
CANNED_TEXT A phrase relating to a pre-formed string that is not altered in anyway.
CLAUSE A grammatical clause, the simplest form of which consists of a subject (noun or noun phrase) and a verb (or verb phrase).
NOUN_PHRASE A phrase relating to a noun.
PREPOSITIONAL_PHRASE A phrase relating to a preposition.
VERB_PHRASE A phrase relating to a verb.

Method Summary

Modifier and Type	Method and Description
boolean	equalTo(Object checkObject) Checks to see if the given object is equal to this phrase category.
static PhraseCategory	valueOf(String name) Returns the enum constant of this type with the specified name.
static PhraseCategory[]	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

CLAUSE

public static final PhraseCategory CLAUSE

A grammatical clause, the simplest form of which consists of a subject (noun or noun phrase) and a verb (or verb phrase).

ADJECTIVE_PHRASE

public static final PhraseCategory ADJECTIVE_PHRASE

A phrase relating to an adjective.

ADVERB_PHRASE

public static final PhraseCategory ADVERB_PHRASE

A phrase relating to an adverb.

NOUN_PHRASE

public static final PhraseCategory NOUN_PHRASE

A phrase relating to a noun.

PREPOSITIONAL_PHRASE

public static final PhraseCategory PREPOSITIONAL_PHRASE

A phrase relating to a preposition.

VERB_PHRASE

public static final PhraseCategory VERB_PHRASE

A phrase relating to a verb.

CANNED_TEXT

public static final PhraseCategory CANNED_TEXT

A phrase relating to a pre-formed string that is not altered in anyway.

Method Detail

values

public static PhraseCategory[] 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 (PhraseCategory c : PhraseCategory.values())
    System.out.println(c);

Returns:

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

valueOf

public static PhraseCategory valueOf(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:

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

NullPointerException - if the argument is null

equalTo

public boolean equalTo(Object checkObject)

Checks to see if the given object is equal to this phrase category. This is done by checking the enumeration if the object is of the type PhraseCategory or by converting the object and this category to strings and comparing the strings.

For example, PhraseCategory.CLAUSE will match another PhraseCategory.CLAUSE but will also match the string "clause" as well.

Specified by:

equalTo in interface ElementCategory

Parameters:

checkObject - the object to be checked against.

Returns:

true if the object matches, false otherwise.