CoordinatedPhraseElement (SimpleNLG 4.5.0 API)

java.lang.Object
- simplenlg.framework.NLGElement
- - simplenlg.framework.CoordinatedPhraseElement

```
public class CoordinatedPhraseElement
extends NLGElement
```
This class defines coordination between two or more phrases. Coordination involves the linking of phrases together through the use of key words such as and or but.

The class does not perform any ordering on the coordinates and when realised they appear in the same order they were added to the coordination.

As this class appears similar to the PhraseElement class from an API point of view, it could have extended from the PhraseElement class. However, they are fundamentally different in their nature and thus form two distinct classes with similar APIs.

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
`CoordinatedPhraseElement()` Creates a blank coordinated phrase ready for new coordinates to be added.
`CoordinatedPhraseElement(Object coordinate1, Object coordinate2)` Creates a coordinated phrase linking the two phrase together.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addComplement(NLGElement newComplement)` Adds a new complement to the phrase element.
`void`	`addComplement(String newComplement)` Adds a new complement to the phrase element.
`void`	`addCoordinate(Object newCoordinate)` Adds a new coordinate to this coordination.
`void`	`addPostModifier(NLGElement newPostModifier)` Adds a new post-modifier to the phrase element.
`void`	`addPostModifier(String newPostModifier)` Adds a new post-modifier to the phrase element.
`void`	`addPreModifier(NLGElement newPreModifier)` Adds a new pre-modifier to the phrase element.
`void`	`addPreModifier(String newPreModifier)` Adds a new pre-modifier to the phrase element.
`boolean`	`checkIfPlural()`
`void`	`clearCoordinates()` Clears the existing coordinates in this coordination.
`List<NLGElement>`	`getChildren()` Retrieves the children for this element.
`List<NLGElement>`	`getComplements()` Retrieves the list of complements currently associated with this coordination.
`String`	`getConjunction()`
`NLGElement`	`getLastCoordinate()` A convenience method for retrieving the last coordinate in this coordination.
`List<NLGElement>`	`getPostModifiers()` Retrieves the list of post-modifiers currently associated with this coordination.
`List<NLGElement>`	`getPreModifiers()` Retrieves the list of pre-modifiers currently associated with this coordination.
`String`	`printTree(String indent)`
`void`	`setConjunction(String conjunction)` set the conjunction to be used in a coordinatedphraseelement

Methods inherited from class simplenlg.framework.NLGElement
clearAllFeatures, equals, 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, toString

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

- Constructor Detail
  - CoordinatedPhraseElement
```
public CoordinatedPhraseElement()
```
    Creates a blank coordinated phrase ready for new coordinates to be added. The default conjunction used is and.
  - CoordinatedPhraseElement
```
public CoordinatedPhraseElement(Object coordinate1,
                                Object coordinate2)
```
    Creates a coordinated phrase linking the two phrase together. The default conjunction used is and.
    
    Parameters:
    
    coordinate1 - the first coordinate.
    
    coordinate2 - the second coordinate.
- Method Detail
  - addCoordinate
```
public void addCoordinate(Object newCoordinate)
```
    Adds a new coordinate to this coordination. If the new coordinate is a NLGElement then it is added directly to the coordination. If the new coordinate is a String a StringElement is created and added to the coordination. StringElements will have their complementisers suppressed by default. In the case of clauses, complementisers will be suppressed if the clause is not the first element in the coordination.
    
    Parameters:
    
    newCoordinate - the new coordinate to be added.
  - getChildren
```
public List<NLGElement> getChildren()
```
    Description copied from class: NLGElement
    
    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.
    
    Specified by:
    
    getChildren in class NLGElement
    
    Returns:
    
    a List of NLGElements representing the children of this element.
  - clearCoordinates
```
public void clearCoordinates()
```
    Clears the existing coordinates in this coordination. It performs exactly the same as removeFeature(Feature.COORDINATES).
  - addPreModifier
```
public void addPreModifier(NLGElement newPreModifier)
```
    Adds a new pre-modifier to the phrase element. Pre-modifiers will be realised in the syntax before the coordinates.
    
    Parameters:
    
    newPreModifier - the new pre-modifier as an NLGElement.
  - addPreModifier
```
public void addPreModifier(String newPreModifier)
```
    Adds a new pre-modifier to the phrase element. Pre-modifiers will be realised in the syntax before the coordinates.
    
    Parameters:
    
    newPreModifier - the new pre-modifier as a String. It is used to create a StringElement.
  - getPreModifiers
```
public List<NLGElement> getPreModifiers()
```
    Retrieves the list of pre-modifiers currently associated with this coordination.
    
    Returns:
    
    a List of NLGElements.
  - getComplements
```
public List<NLGElement> getComplements()
```
    Retrieves the list of complements currently associated with this coordination.
    
    Returns:
    
    a List of NLGElements.
  - addPostModifier
```
public void addPostModifier(NLGElement newPostModifier)
```
    Adds a new post-modifier to the phrase element. Post-modifiers will be realised in the syntax after the coordinates.
    
    Parameters:
    
    newPostModifier - the new post-modifier as an NLGElement.
  - addPostModifier
```
public void addPostModifier(String newPostModifier)
```
    Adds a new post-modifier to the phrase element. Post-modifiers will be realised in the syntax after the coordinates.
    
    Parameters:
    
    newPostModifier - the new post-modifier as a String. It is used to create a StringElement.
  - getPostModifiers
```
public List<NLGElement> getPostModifiers()
```
    Retrieves the list of post-modifiers currently associated with this coordination.
    
    Returns:
    
    a List of NLGElements.
  - printTree
```
public String printTree(String indent)
```
    Overrides:
    
    printTree in class NLGElement
  - addComplement
```
public void addComplement(NLGElement newComplement)
```
    Adds a new complement to the phrase element. Complements will be realised in the syntax after the coordinates. Complements differ from post-modifiers in that complements are crucial to the understanding of a phrase whereas post-modifiers are optional.
    
    Parameters:
    
    newComplement - the new complement as an NLGElement.
  - addComplement
```
public void addComplement(String newComplement)
```
    Adds a new complement to the phrase element. Complements will be realised in the syntax after the coordinates. Complements differ from post-modifiers in that complements are crucial to the understanding of a phrase whereas post-modifiers are optional.
    
    Parameters:
    
    newComplement - the new complement as a String. It is used to create a StringElement.
  - getLastCoordinate
```
public NLGElement getLastCoordinate()
```
    A convenience method for retrieving the last coordinate in this coordination.
    
    Returns:
    
    the last coordinate as represented by a NLGElement
  - setConjunction
```
public void setConjunction(String conjunction)
```
    set the conjunction to be used in a coordinatedphraseelement
  - getConjunction
```
public String getConjunction()
```
    Returns:
    
    conjunction used in coordinatedPhraseElement
  - checkIfPlural
```
public boolean checkIfPlural()
```
    Returns:
    
    true if this coordinate is plural in a syntactic sense

Class CoordinatedPhraseElement

Field Summary

Fields inherited from class simplenlg.framework.NLGElement

Constructor Summary

Method Summary

Methods inherited from class simplenlg.framework.NLGElement

Methods inherited from class java.lang.Object

Constructor Detail

CoordinatedPhraseElement

CoordinatedPhraseElement

Method Detail

addCoordinate

getChildren

clearCoordinates

addPreModifier

addPreModifier

getPreModifiers

getComplements

addPostModifier

addPostModifier

getPostModifiers

printTree

addComplement

addComplement

getLastCoordinate

setConjunction

getConjunction

checkIfPlural