simplenlg.framework

Class StringElement

java.lang.Object

simplenlg.framework.NLGElement

simplenlg.framework.StringElement

public class StringElement
extends NLGElement

This class defines an element for representing canned text within the SimpleNLG library. Once assigned a value, the string element should not be changed by any other processors.

Version:

4.0

Author:

D. Westwater, University of Aberdeen.

Field Summary

Fields inherited from class simplenlg.framework.NLGElement

features

Constructor Summary

Constructors

Constructor and Description
StringElement(String value) Constructs a new string element representing some canned text.

Method Summary

Modifier and Type	Method and Description
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.
List<NLGElement>	getChildren() The string element contains no children so this method will always return an empty list.
String	printTree(String indent)
String	toString()

Methods inherited from class simplenlg.framework.NLGElement

clearAllFeatures, equals, getAllFeatureNames, getAllFeatures, getCategory, getFactory, getFeature, getFeatureAsBoolean, getFeatureAsDouble, getFeatureAsElement, getFeatureAsElementList, getFeatureAsFloat, getFeatureAsInteger, getFeatureAsList, getFeatureAsLong, getFeatureAsString, getFeatureAsStringList, getParent, getRealisation, getTense, hasFeature, isA, isNegated, isPlural, removeFeature, setCategory, setFactory, setFeature, setFeature, setFeature, setFeature, setFeature, setFeature, setNegated, setParent, setPlural, setRealisation, setTense

Methods inherited from class java.lang.Object

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

Constructor Detail

StringElement

public StringElement(String value)

Constructs a new string element representing some canned text.

Parameters:

value - the text for this string element.

Method Detail

getChildren

public List<NLGElement> getChildren()

The string element contains no children so this method will always return an empty list.

Specified by:

getChildren in class NLGElement

Returns:

a List of NLGElements representing the children of this element.

toString

public String toString()

Overrides:

toString in class NLGElement

equals

public boolean equals(Object o)

Description copied from class: NLGElement

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 NLGElement

printTree

public String printTree(String indent)

Overrides:

printTree in class NLGElement