simplenlg.syntax.english.CoordinatedPhraseHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of SimpleNLG Show documentation
Show all versions of SimpleNLG Show documentation
Java API for Natural Language Generation
The newest version!
/*
* The contents of this file are subject to the Mozilla Public License
* Version 2.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* https://www.mozilla.org/en-US/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 Westwater, Roman Kutlak, Margaret Mitchell, and Saad Mahamood.
*/
package simplenlg.syntax.english;
import java.util.List;
import simplenlg.features.DiscourseFunction;
import simplenlg.features.Feature;
import simplenlg.features.InternalFeature;
import simplenlg.features.LexicalFeature;
import simplenlg.framework.*;
/**
*
* This class contains static methods to help the syntax processor realise
* coordinated phrases.
*
*
* @author D. Westwater, University of Aberdeen.
* @version 4.0
*/
abstract class CoordinatedPhraseHelper {
/**
* The main method for realising coordinated phrases.
*
* @param parent the SyntaxProcessor that called this method.
* @param phrase the CoordinatedPhrase to be realised.
* @return the realised NLGElement.
*/
static NLGElement realise(SyntaxProcessor parent, CoordinatedPhraseElement phrase) {
ListElement realisedElement = null;
if(phrase != null) {
realisedElement = new ListElement();
PhraseHelper.realiseList(parent, realisedElement, phrase.getPreModifiers(), DiscourseFunction.PRE_MODIFIER);
CoordinatedPhraseElement coordinated = new CoordinatedPhraseElement();
List children = phrase.getChildren();
String conjunction = phrase.getFeatureAsString(Feature.CONJUNCTION);
coordinated.setFeature(Feature.CONJUNCTION, conjunction);
coordinated.setFeature(Feature.CONJUNCTION_TYPE, phrase.getFeature(Feature.CONJUNCTION_TYPE));
InflectedWordElement conjunctionElement = null;
if(children != null && children.size() > 0) {
if(phrase.getFeatureAsBoolean(Feature.RAISE_SPECIFIER).booleanValue()) {
raiseSpecifier(children);
}
NLGElement child = phrase.getLastCoordinate();
child.setFeature(Feature.POSSESSIVE, phrase.getFeature(Feature.POSSESSIVE));
child = children.get(0);
setChildFeatures(phrase, child);
coordinated.addCoordinate(parent.realise(child));
for(int index = 1; index < children.size(); index++) {
child = children.get(index);
setChildFeatures(phrase, child);
if(phrase.getFeatureAsBoolean(Feature.AGGREGATE_AUXILIARY).booleanValue()) {
child.setFeature(InternalFeature.REALISE_AUXILIARY, false);
}
if(child.isA(PhraseCategory.CLAUSE)) {
child.setFeature(Feature.SUPRESSED_COMPLEMENTISER,
phrase.getFeature(Feature.SUPRESSED_COMPLEMENTISER));
}
//skip conjunction if it's null or empty string
if(conjunction != null && conjunction.length() > 0) {
conjunctionElement = new InflectedWordElement(conjunction, LexicalCategory.CONJUNCTION);
conjunctionElement.setFeature(InternalFeature.DISCOURSE_FUNCTION,
DiscourseFunction.CONJUNCTION);
coordinated.addCoordinate(conjunctionElement);
}
coordinated.addCoordinate(parent.realise(child));
}
realisedElement.addComponent(coordinated);
}
PhraseHelper.realiseList(parent,
realisedElement,
phrase.getPostModifiers(),
DiscourseFunction.POST_MODIFIER);
PhraseHelper.realiseList(parent, realisedElement, phrase.getComplements(), DiscourseFunction.COMPLEMENT);
}
return realisedElement;
}
/**
* Sets the common features from the phrase to the child element.
*
* @param phrase the CoordinatedPhraseElement
* @param child a single coordinated NLGElement within the
* coordination.
*/
private static void setChildFeatures(CoordinatedPhraseElement phrase, NLGElement child) {
if(phrase.hasFeature(Feature.PROGRESSIVE)) {
child.setFeature(Feature.PROGRESSIVE, phrase.getFeature(Feature.PROGRESSIVE));
}
if(phrase.hasFeature(Feature.PERFECT)) {
child.setFeature(Feature.PERFECT, phrase.getFeature(Feature.PERFECT));
}
if(phrase.hasFeature(InternalFeature.SPECIFIER)) {
child.setFeature(InternalFeature.SPECIFIER, phrase.getFeature(InternalFeature.SPECIFIER));
}
if(phrase.hasFeature(LexicalFeature.GENDER)) {
child.setFeature(LexicalFeature.GENDER, phrase.getFeature(LexicalFeature.GENDER));
}
if(phrase.hasFeature(Feature.NUMBER)) {
child.setFeature(Feature.NUMBER, phrase.getFeature(Feature.NUMBER));
}
if(phrase.hasFeature(Feature.TENSE)) {
child.setFeature(Feature.TENSE, phrase.getFeature(Feature.TENSE));
}
if(phrase.hasFeature(Feature.PERSON)) {
child.setFeature(Feature.PERSON, phrase.getFeature(Feature.PERSON));
}
if(phrase.hasFeature(Feature.NEGATED)) {
child.setFeature(Feature.NEGATED, phrase.getFeature(Feature.NEGATED));
}
if(phrase.hasFeature(Feature.MODAL)) {
child.setFeature(Feature.MODAL, phrase.getFeature(Feature.MODAL));
}
if(phrase.hasFeature(InternalFeature.DISCOURSE_FUNCTION)) {
child.setFeature(InternalFeature.DISCOURSE_FUNCTION, phrase.getFeature(InternalFeature.DISCOURSE_FUNCTION));
}
if(phrase.hasFeature(Feature.FORM)) {
child.setFeature(Feature.FORM, phrase.getFeature(Feature.FORM));
}
if(phrase.hasFeature(InternalFeature.CLAUSE_STATUS)) {
child.setFeature(InternalFeature.CLAUSE_STATUS, phrase.getFeature(InternalFeature.CLAUSE_STATUS));
}
if(phrase.hasFeature(Feature.INTERROGATIVE_TYPE)) {
child.setFeature(InternalFeature.IGNORE_MODAL, true);
}
}
/**
* Checks to see if the specifier can be raised and then raises it. In order
* to be raised the specifier must be the same on all coordinates. For
* example, the cat and the dog will be realised as
* the cat and dog while the cat and any dog will remain
* the cat and any dog.
*
* @param children the List of coordinates in the
* CoordinatedPhraseElement
*/
private static void raiseSpecifier(List children) {
boolean allMatch = true;
NLGElement child = children.get(0);
NLGElement specifier = null;
String test = null;
if(child != null) {
specifier = child.getFeatureAsElement(InternalFeature.SPECIFIER);
if(specifier != null) {
// AG: this assumes the specifier is an InflectedWordElement or
// phrase.
// it could be a Wordelement, in which case, we want the
// baseform
test = (specifier instanceof WordElement) ? ((WordElement) specifier).getBaseForm() :
specifier.getFeatureAsString(LexicalFeature.BASE_FORM);
}
if(test != null) {
int index = 1;
while(index < children.size() && allMatch) {
child = children.get(index);
if(child == null) {
allMatch = false;
} else {
specifier = child.getFeatureAsElement(InternalFeature.SPECIFIER);
String childForm =
(specifier instanceof WordElement) ? ((WordElement) specifier).getBaseForm() :
specifier.getFeatureAsString(LexicalFeature.BASE_FORM);
if(!test.equals(childForm)) {
allMatch = false;
}
}
index++;
}
if(allMatch) {
for(int eachChild = 1; eachChild < children.size(); eachChild++) {
child = children.get(eachChild);
child.setFeature(InternalFeature.RAISED, true);
}
}
}
}
}
}