simplenlg.framework.PhraseCategory Maven / Gradle / Ivy
Show all versions of SimpleNLG Show documentation
/*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
* License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is "Simplenlg".
*
* The Initial Developer of the Original Code is Ehud Reiter, Albert Gatt and Dave Westwater.
* Portions created by Ehud Reiter, Albert Gatt and Dave Westwater are Copyright (C) 2010-11 The University of Aberdeen. All Rights Reserved.
*
* Contributor(s): Ehud Reiter, Albert Gatt, Dave Wewstwater, Roman Kutlak, Margaret Mitchell.
*/
package simplenlg.framework;
/**
*
* 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.
*
*
*
* @author A. Gatt and D. Westwater, University of Aberdeen.
* @version 4.0
*
*/
public enum PhraseCategory implements ElementCategory {
/**
* A grammatical clause, the simplest form of which consists of a subject
* (noun or noun phrase) and a verb (or verb phrase).
*/
CLAUSE,
/** A phrase relating to an adjective. */
ADJECTIVE_PHRASE,
/** A phrase relating to an adverb. */
ADVERB_PHRASE,
/** A phrase relating to a noun. */
NOUN_PHRASE,
/** A phrase relating to a preposition. */
PREPOSITIONAL_PHRASE,
/** A phrase relating to a verb. */
VERB_PHRASE,
/** A phrase relating to a pre-formed string that is not altered in anyway. */
CANNED_TEXT;
/**
*
* 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.
*/
public boolean equalTo(Object checkObject) {
boolean match = false;
if (checkObject != null) {
if (checkObject instanceof DocumentCategory) {
match = this.equals(checkObject);
} else {
match = this.toString()
.equalsIgnoreCase(checkObject.toString());
}
}
return match;
}
}