simplenlg.aggregation

Class PhraseSet

java.lang.Object

simplenlg.aggregation.PhraseSet

public class PhraseSet
extends Object

This class wraps an ordered list of phrases which are constituents of two or more (different) clauses and have the same discourse function in their parent clause. FunctionPairs are used by AggregationRules to collect candidate phrase for elision.

Author:

agatt

Constructor Summary

Constructors

Constructor and Description
PhraseSet(DiscourseFunction function, NLGElement... phrases) Construct a set of compatible phrases and their function

Method Summary

Modifier and Type	Method and Description
void	addPhrase(NLGElement phrase) Add a phrase
void	addPhrases(Collection<NLGElement> phrases) Add a collection of phrases.
void	elideLeftmost() Elide the leftmost consitutents in the phrase list, that is, all phrases except the rightmost.
void	elideRightmost() Elide the rightmost constituents in the phrase list, that is, all phrases except the first.
boolean	formIdentical() Check whether the phrases in this set are identical in form.
DiscourseFunction	getFunction()
boolean	lemmaIdentical() Check whether the phrases are lemma identical.

Methods inherited from class java.lang.Object

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

Constructor Detail

PhraseSet

public PhraseSet(DiscourseFunction function,
                 NLGElement... phrases)

Construct a set of compatible phrases and their function

Parameters:

function - their function

phrases - the list of constituent phrases for the function.

Method Detail

addPhrase

public void addPhrase(NLGElement phrase)

Add a phrase

Parameters:

phrase - the phrase to add

addPhrases

public void addPhrases(Collection<NLGElement> phrases)

Add a collection of phrases.

Parameters:

phrases - the phrases to add

getFunction

public DiscourseFunction getFunction()

Returns:

the function the pair of phrases have in their respective clauses

elideRightmost

public void elideRightmost()

Elide the rightmost constituents in the phrase list, that is, all phrases except the first.

elideLeftmost

public void elideLeftmost()

Elide the leftmost consitutents in the phrase list, that is, all phrases except the rightmost.

lemmaIdentical

public boolean lemmaIdentical()

Check whether the phrases are lemma identical. This method returns true in the following cases:

1. All phrases are NLGElements and they have the same lexical head, irrespective of inflectional variations.

Returns:

true if the pair is lemma identical

formIdentical

public boolean formIdentical()

Check whether the phrases in this set are identical in form. This method returns true if for every pair of phrases p1 and , p1.equals(p2).

Returns:

true if all phrases in the set are form-identical