NLGElement (SimpleNLG 4.5.0 API)

java.lang.Object
- simplenlg.framework.NLGElement

Direct Known Subclasses:

CoordinatedPhraseElement, DocumentElement, InflectedWordElement, ListElement, PhraseElement, StringElement, WordElement
```
public abstract class NLGElement
extends Object
```
NLGElement is the base class that all elements extend from. This is abstract and cannot therefore be instantiated itself. The additional element classes should be used to correctly identify the type of element required.

Realisation in SimpleNLG revolves around a tree structure. Each node in the tree is represented by a NLGElement, which in turn may have child nodes. The job of the processors is to replace various types of elements with other elements. The eventual goal, once all the processors have been run, is to produce a single string element representing the final realisation.

The features are stored in a Map of String (the feature name) and Object (the value of the feature).

Version:

4.0

Author:

D. Westwater, University of Aberdeen.

Field Summary

Fields
Modifier and Type Field and Description

protected HashMap<String,Object> features
The features of this element.

Fields
Modifier and Type	Field and Description
`protected HashMap<String,Object>`	`features` The features of this element.

Constructor Summary

Constructors
Constructor and Description

NLGElement()

Constructors
Constructor and Description
`NLGElement()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearAllFeatures()` Deletes all the features in the map.
`boolean`	`equals(Object o)` An NLG element is equal to some object if the object is an NLGElement, they have the same category and the same features.
`boolean`	`equals(String elementRealisation)` Determines if this element has its realisation equal to the given string.
`Set<String>`	`getAllFeatureNames()` Retrieves the set of features currently contained in the feature map.
`Map<String,Object>`	`getAllFeatures()` Retrieves the map containing all the features for this element.
`ElementCategory`	`getCategory()` Retrieves the category for this element.
`abstract List<NLGElement>`	`getChildren()` Retrieves the children for this element.
`NLGFactory`	`getFactory()`
`Object`	`getFeature(String featureName)` Retrieves the value of the feature.
`Boolean`	`getFeatureAsBoolean(String featureName)` Retrieves the value of the feature as a `Boolean`.
`Double`	`getFeatureAsDouble(String featureName)` Retrieves the value of the feature as a `Double`.
`NLGElement`	`getFeatureAsElement(String featureName)` Retrieves the value of the feature as a `NLGElement`.
`List<NLGElement>`	`getFeatureAsElementList(String featureName)` Retrieves the value of the feature as a list of elements.
`Float`	`getFeatureAsFloat(String featureName)` Retrieves the value of the feature as a `Float`.
`Integer`	`getFeatureAsInteger(String featureName)` Retrieves the value of the feature as an `Integer`.
`List<Object>`	`getFeatureAsList(String featureName)` Retrieves the value of the feature as a list of java objects.
`Long`	`getFeatureAsLong(String featureName)` Retrieves the value of the feature as a `Long`.
`String`	`getFeatureAsString(String featureName)` Retrieves the value of the feature as a string.
`List<String>`	`getFeatureAsStringList(String featureName)` Retrieves the value of the feature as a list of strings.
`NLGElement`	`getParent()` Retrieves the parent of this element.
`String`	`getRealisation()` Retrieves the final realisation of this element.
`Tense`	`getTense()` Deprecated.
`boolean`	`hasFeature(String featureName)` Checks the feature map to see if the named feature is present in the map.
`boolean`	`isA(ElementCategory checkCategory)`
`boolean`	`isNegated()` Deprecated.
`boolean`	`isPlural()` Determines if this element is to be treated as a plural.
`String`	`printTree(String indent)`
`void`	`removeFeature(String featureName)` Deletes the named feature from the map.
`void`	`setCategory(ElementCategory newCategory)` Sets the category of this element.
`void`	`setFactory(NLGFactory factory)`
`void`	`setFeature(String featureName, boolean featureValue)` A convenience method for setting boolean features.
`void`	`setFeature(String featureName, double featureValue)` A convenience method for setting double precision floating point number features.
`void`	`setFeature(String featureName, float featureValue)` A convenience method for setting floating point number features.
`void`	`setFeature(String featureName, int featureValue)` A convenience method for setting integer features.
`void`	`setFeature(String featureName, long featureValue)` A convenience method for setting long integer features.
`void`	`setFeature(String featureName, Object featureValue)` Adds a feature to the feature map.
`void`	`setNegated(boolean isNegated)` Deprecated.
`void`	`setParent(NLGElement newParent)` Sets the parent element of this element.
`void`	`setPlural(boolean isPlural)` Sets the number agreement on this element.
`void`	`setRealisation(String realised)` Sets the realisation of this element.
`void`	`setTense(Tense newTense)` Deprecated.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - features
```
protected HashMap<String,Object> features
```
    The features of this element.
- Constructor Detail
  - NLGElement
```
public NLGElement()
```
- Method Detail
  - setCategory
```
public void setCategory(ElementCategory newCategory)
```
    Sets the category of this element.
    
    Parameters:
    
    newCategory - the new ElementCategory for this element.
  - getCategory
```
public ElementCategory getCategory()
```
    Retrieves the category for this element.
    
    Returns:
    
    the category as a ElementCategory.
  - setFeature
```
public void setFeature(String featureName,
                       Object featureValue)
```
    Adds a feature to the feature map. If the feature already exists then it is given the new value. If the value provided is null the feature is removed from the map.
    
    Parameters:
    
    featureName - the name of the feature.
    
    featureValue - the new value of the feature or null if the feature is to be removed.
  - setFeature
```
public void setFeature(String featureName,
                       boolean featureValue)
```
    A convenience method for setting boolean features.
    
    Parameters:
    
    featureName - the name of the feature.
    
    featureValue - the boolean value of the feature.
  - setFeature
```
public void setFeature(String featureName,
                       int featureValue)
```
    A convenience method for setting integer features.
    
    Parameters:
    
    featureName - the name of the feature.
    
    featureValue - the int value of the feature.
  - setFeature
```
public void setFeature(String featureName,
                       long featureValue)
```
    A convenience method for setting long integer features.
    
    Parameters:
    
    featureName - the name of the feature.
    
    featureValue - the long value of the feature.
  - setFeature
```
public void setFeature(String featureName,
                       float featureValue)
```
    A convenience method for setting floating point number features.
    
    Parameters:
    
    featureName - the name of the feature.
    
    featureValue - the float value of the feature.
  - setFeature
```
public void setFeature(String featureName,
                       double featureValue)
```
    A convenience method for setting double precision floating point number features.
    
    Parameters:
    
    featureName - the name of the feature.
    
    featureValue - the double value of the feature.
  - getFeature
```
public Object getFeature(String featureName)
```
    Retrieves the value of the feature.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the Object value of the feature.
  - getFeatureAsString
```
public String getFeatureAsString(String featureName)
```
    Retrieves the value of the feature as a string. If the feature doesn't exist then null is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the String representation of the value. This is taken by calling the object's toString() method.
  - getFeatureAsElementList
```
public List<NLGElement> getFeatureAsElementList(String featureName)
```
    Retrieves the value of the feature as a list of elements. If the feature is a single NLGElement then it is wrapped in a list. If the feature is a Collection then each object in the collection is checked and only NLGElements are returned in the list.
    
    If the feature does not exist then an empty list is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the List of NLGElements
  - getFeatureAsList
```
public List<Object> getFeatureAsList(String featureName)
```
    Retrieves the value of the feature as a list of java objects. If the feature is a single element, the list contains only this element. If the feature is a Collection each object in the collection is returned in the list.
    
    If the feature does not exist then an empty list is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the List of Objects
  - getFeatureAsStringList
```
public List<String> getFeatureAsStringList(String featureName)
```
    Retrieves the value of the feature as a list of strings. If the feature is a single element, then its toString() value is wrapped in a list. If the feature is a Collection then the toString() value of each object in the collection is returned in the list.
    
    If the feature does not exist then an empty list is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the List of Strings
  - getFeatureAsInteger
```
public Integer getFeatureAsInteger(String featureName)
```
    Retrieves the value of the feature as an Integer. If the feature does not exist or cannot be converted to an integer then null is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the Integer representation of the value. Numbers are converted to integers while Strings are parsed for integer values. Any other type will return null.
  - getFeatureAsLong
```
public Long getFeatureAsLong(String featureName)
```
    Retrieves the value of the feature as a Long. If the feature does not exist or cannot be converted to a long then null is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the Long representation of the value. Numbers are converted to longs while Strings are parsed for long values. Any other type will return null.
  - getFeatureAsFloat
```
public Float getFeatureAsFloat(String featureName)
```
    Retrieves the value of the feature as a Float. If the feature does not exist or cannot be converted to a float then null is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the Float representation of the value. Numbers are converted to floats while Strings are parsed for float values. Any other type will return null.
  - getFeatureAsDouble
```
public Double getFeatureAsDouble(String featureName)
```
    Retrieves the value of the feature as a Double. If the feature does not exist or cannot be converted to a double then null is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the Double representation of the value. Numbers are converted to doubles while Strings are parsed for double values. Any other type will return null.
  - getFeatureAsBoolean
```
public Boolean getFeatureAsBoolean(String featureName)
```
    Retrieves the value of the feature as a Boolean. If the feature does not exist or is not a boolean then Boolean.FALSE is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the Boolean representation of the value. Any non-Boolean type will return Boolean.FALSE.
  - getFeatureAsElement
```
public NLGElement getFeatureAsElement(String featureName)
```
    Retrieves the value of the feature as a NLGElement. If the value is a string then it is wrapped in a StringElement. If the feature does not exist or is of any other type then null is returned.
    
    Parameters:
    
    featureName - the name of the feature.
    
    Returns:
    
    the NLGElement.
  - getAllFeatures
```
public Map<String,Object> getAllFeatures()
```
    Retrieves the map containing all the features for this element.
    
    Returns:
    
    a Map of String, Object.
  - hasFeature
```
public boolean hasFeature(String featureName)
```
    Checks the feature map to see if the named feature is present in the map.
    
    Parameters:
    
    featureName - the name of the feature to look for.
    
    Returns:
    
    true if the feature exists, false otherwise.
  - removeFeature
```
public void removeFeature(String featureName)
```
    Deletes the named feature from the map.
    
    Parameters:
    
    featureName - the name of the feature to be removed.
  - clearAllFeatures
```
public void clearAllFeatures()
```
    Deletes all the features in the map.
  - setParent
```
public void setParent(NLGElement newParent)
```
    Sets the parent element of this element.
    
    Parameters:
    
    newParent - the NLGElement that is the parent of this element.
  - getParent
```
public NLGElement getParent()
```
    Retrieves the parent of this element.
    
    Returns:
    
    the NLGElement that is the parent of this element.
  - setRealisation
```
public void setRealisation(String realised)
```
    Sets the realisation of this element.
    
    Parameters:
    
    realised - the String representing the final realisation for this element.
  - getRealisation
```
public String getRealisation()
```
    Retrieves the final realisation of this element.
    
    Returns:
    
    the String representing the final realisation for this element.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isA
```
public boolean isA(ElementCategory checkCategory)
```
  - getChildren
```
public abstract List<NLGElement> getChildren()
```
    Retrieves the children for this element. This method needs to be overridden for each specific type of element. Each type of element will have its own way of determining the child elements.
    
    Returns:
    
    a List of NLGElements representing the children of this element.
  - getAllFeatureNames
```
public Set<String> getAllFeatureNames()
```
    Retrieves the set of features currently contained in the feature map.
    
    Returns:
    
    a Set of Strings representing the feature names. The set is unordered.
  - printTree
```
public String printTree(String indent)
```
  - equals
```
public boolean equals(String elementRealisation)
```
    Determines if this element has its realisation equal to the given string.
    
    Parameters:
    
    elementRealisation - the string to check against.
    
    Returns:
    
    true if the string matches the element's realisation, false otherwise.
  - setPlural
```
public void setPlural(boolean isPlural)
```
    Sets the number agreement on this element. This method is added for convenience and not all element types will make use of the number agreement feature. The method is identical to calling setFeature(Feature.NUMBER, NumberAgreement.PLURAL) for plurals or setFeature(Feature.NUMBER, NumberAgreement.SINGULAR) for the singular.
    
    Parameters:
    
    isPlural - true if this element is to be treated as a plural, false otherwise.
  - isPlural
```
public boolean isPlural()
```
    Determines if this element is to be treated as a plural. This is a convenience method and not all element types make use of number agreement.
    
    Returns:
    
    true if the Feature.NUMBER feature has the value NumberAgreement.PLURAL, false otherwise.
  - getTense
```
@Deprecated
public Tense getTense()
```
    Deprecated.
    
    Retrieves the tense for this element. The method is identical to calling getFeature(Feature.TENSE) and casting the result as Tense. * WARNING: You should use getFeature(Feature.TENSE) getTense will be dropped from simplenlg at some point
    Returns: the Tense of this element.
  setTense @Deprecated public void setTense(Tense newTense) Deprecated. Sets the tense on this element. The method is identical to calling setFeature(Feature.TENSE, newTense). WARNING: You should use setTense(Feature.TENSE, tense) setTense will be dropped from simplenlg at some point Parameters: newTense - the new tense for this element. setNegated @Deprecated public void setNegated(boolean isNegated) Deprecated. Sets the negation on this element. The method is identical to calling setFeature(Feature.NEGATED, isNegated). WARNING: You should use setFeature(Feature.NEGATED, isNegated) setNegated will be dropped from simplenlg at some point Parameters: isNegated - true if the element is to be negated, false otherwise. isNegated @Deprecated public boolean isNegated() Deprecated. Determines if this element is to be treated as a negation. This method just examines the value of the NEGATED feature WARNING: You should use getFeature(Feature.NEGATED) getNegated will be dropped from simplenlg at some point Returns: true if the Feature.NEGATED feature exists and has the value Boolean.TRUE, false is returned otherwise. getFactory public NLGFactory getFactory() Returns: the NLG factory setFactory public void setFactory(NLGFactory factory) Parameters: factory - the NLG factory to set equals public boolean equals(Object o) An NLG element is equal to some object if the object is an NLGElement, they have the same category and the same features. Overrides: equals in class Object

Class NLGElement

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

features

Constructor Detail

NLGElement

Method Detail

setCategory

getCategory

setFeature

setFeature

setFeature

setFeature

setFeature

setFeature

getFeature

getFeatureAsString

getFeatureAsElementList

getFeatureAsList

getFeatureAsStringList

getFeatureAsInteger

getFeatureAsLong

getFeatureAsFloat

getFeatureAsDouble

getFeatureAsBoolean

getFeatureAsElement

getAllFeatures

hasFeature

removeFeature

clearAllFeatures

setParent

getParent

setRealisation

getRealisation

toString

isA

getChildren

getAllFeatureNames

printTree

equals

setPlural

isPlural

getTense

setTense

setNegated

isNegated

getFactory

setFactory

equals