NLGFactory (SimpleNLG 4.5.0 API)

java.lang.Object
- simplenlg.framework.NLGFactory

```
public class NLGFactory
extends Object
```
This class contains methods for creating syntactic phrases. These methods should be used instead of directly invoking new on SPhraseSpec, etc.
The phrase factory should be linked to s lexicon if possible (although it will work without one)

Version:

4.0

Author:

D. Westwater, University of Aberdeen.

Constructor Summary

Constructors
Constructor and Description
`NLGFactory()` Creates a new phrase factory with no associated lexicon.
`NLGFactory(Lexicon newLexicon)` Creates a new phrase factory with the associated lexicon.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdjPhraseSpec`	`createAdjectivePhrase()` Creates a blank adjective phrase with no base adjective set.
`AdjPhraseSpec`	`createAdjectivePhrase(Object adjective)` Creates an adjective phrase wrapping the given adjective.
`AdvPhraseSpec`	`createAdverbPhrase()` Creates a blank adverb phrase that has no adverb.
`AdvPhraseSpec`	`createAdverbPhrase(String adverb)` Creates an adverb phrase wrapping the given adverb.
`SPhraseSpec`	`createClause()` Creates a blank clause with no subject, verb or objects.
`SPhraseSpec`	`createClause(Object subject, Object verb)` Creates a clause with the given subject and verb but no objects.
`SPhraseSpec`	`createClause(Object subject, Object verb, Object directObject)` Creates a clause with the given subject, verb or verb phrase and direct object but no indirect object.
`CoordinatedPhraseElement`	`createCoordinatedPhrase()` Creates a new (empty) coordinated phrase
`CoordinatedPhraseElement`	`createCoordinatedPhrase(Object coord1, Object coord2)` Creates a new coordinated phrase with two elements (initially)
`DocumentElement`	`createDocument()` Creates a new document element with no title.
`DocumentElement`	`createDocument(String title)` Creates a new document element with the given title.
`DocumentElement`	`createDocument(String title, List<DocumentElement> components)` Creates a new document element with the given title and adds all of the given components in the list
`DocumentElement`	`createDocument(String title, NLGElement component)` Creates a new document element with the given title and adds the given component.
`DocumentElement`	`createEnumeratedList()` Creates a new enumerated list element with no components.
`DocumentElement`	`createEnumeratedList(List<DocumentElement> textComponents)` Creates a new enumerated list element and adds all of the given components in the list
`DocumentElement`	`createEnumeratedList(NLGElement component)` Creates a new section element with the given title and adds the given component.
`NLGElement`	`createInflectedWord(Object word, LexicalCategory category)` Create an inflected word element.
`DocumentElement`	`createList()` Creates a new list element with no components.
`DocumentElement`	`createList(List<DocumentElement> textComponents)` Creates a new list element and adds all of the given components in the list
`DocumentElement`	`createList(NLGElement component)` Creates a new section element with the given title and adds the given component.
`DocumentElement`	`createListItem()` Creates a list item for adding to a list element.
`DocumentElement`	`createListItem(NLGElement component)` Creates a list item for adding to a list element.
`NLGElement`	`createNLGElement(Object element)` create an NLGElement from the element, no default lexical category
`NLGElement`	`createNLGElement(Object element, LexicalCategory category)` this method creates an NLGElement from an object If object is null, return null If the object is already an NLGElement, it is returned unchanged Exception: if it is an InflectedWordElement, return underlying WordElement If it is a String which matches a lexicon entry or pronoun, the relevant WordElement is returned If it is a different String, a wordElement is created if the string is a single word Otherwise a StringElement is returned Otherwise throw an exception
`NPPhraseSpec`	`createNounPhrase()` Creates a blank noun phrase with no subject or specifier.
`NPPhraseSpec`	`createNounPhrase(Object noun)` Creates a noun phrase with the given subject but no specifier.
`NPPhraseSpec`	`createNounPhrase(Object specifier, Object noun)` Creates a noun phrase with the given specifier and subject.
`DocumentElement`	`createParagraph()` Creates a new paragraph element with no components.
`DocumentElement`	`createParagraph(List<DocumentElement> components)` Creates a new paragraph element and adds all of the given components in the list
`DocumentElement`	`createParagraph(NLGElement component)` Creates a new paragraph element and adds the given component
`PPPhraseSpec`	`createPrepositionPhrase()` Creates a blank preposition phrase with no preposition or complements.
`PPPhraseSpec`	`createPrepositionPhrase(Object preposition)` Creates a preposition phrase with the given preposition.
`PPPhraseSpec`	`createPrepositionPhrase(Object preposition, Object complement)` Creates a preposition phrase with the given preposition and complement.
`DocumentElement`	`createSection()` Creates a new section element.
`DocumentElement`	`createSection(String title)` Creates a new section element with the given title.
`DocumentElement`	`createSection(String title, List<DocumentElement> components)` Creates a new section element with the given title and adds all of the given components in the list
`DocumentElement`	`createSection(String title, NLGElement component)` Creates a new section element with the given title and adds the given component.
`DocumentElement`	`createSentence()` Creates a new sentence element with no components.
`DocumentElement`	`createSentence(List<NLGElement> components)` Creates a new sentence element and adds all of the given components.
`DocumentElement`	`createSentence(NLGElement components)` Creates a new sentence element
`DocumentElement`	`createSentence(Object subject, Object verb)` Creates a sentence with the given subject and verb.
`DocumentElement`	`createSentence(Object subject, Object verb, Object complement)` Creates a sentence with the given subject, verb and direct object.
`DocumentElement`	`createSentence(String cannedSentence)` Creates a new sentence with the given canned text.
`NLGElement`	`createStringElement()` Creates a blank canned text phrase with no text.
`NLGElement`	`createStringElement(String text)` Creates a canned text phrase with the given text.
`VPPhraseSpec`	`createVerbPhrase()` Creates a blank verb phrase with no main verb.
`VPPhraseSpec`	`createVerbPhrase(Object verb)` Creates a verb phrase wrapping the main verb given.
`NLGElement`	`createWord(Object word, LexicalCategory category)` Creates a new element representing a word.
`void`	`setLexicon(Lexicon newLexicon)` Sets the lexicon to be used by this factory.

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

- Constructor Detail
  - NLGFactory
```
public NLGFactory()
```
    Creates a new phrase factory with no associated lexicon.
  - NLGFactory
```
public NLGFactory(Lexicon newLexicon)
```
    Creates a new phrase factory with the associated lexicon.
    
    Parameters:
    
    newLexicon - the Lexicon to be used with this factory.
- Method Detail
  - setLexicon
```
public void setLexicon(Lexicon newLexicon)
```
    Sets the lexicon to be used by this factory. Passing a parameter of null will remove any existing lexicon from the factory.
    
    Parameters:
    
    newLexicon - the new Lexicon to be used.
  - createWord
```
public NLGElement createWord(Object word,
                             LexicalCategory category)
```
    Creates a new element representing a word. If the word passed is already an NLGElement then that is returned unchanged. If a String is passed as the word then the factory will look up the Lexicon if one exists and use the details found to create a new WordElement.
    
    Parameters:
    
    word - the base word for the new element. This can be a NLGElement, which is returned unchanged, or a String, which is used to construct a new WordElement.
    
    category - the LexicalCategory for the word.
    
    Returns:
    
    an NLGElement representing the word.
  - createInflectedWord
```
public NLGElement createInflectedWord(Object word,
                                      LexicalCategory category)
```
    Create an inflected word element. InflectedWordElement represents a word that already specifies the morphological and other features that it should exhibit in a realisation. While normally, phrases are constructed using WordElements, and features are set on phrases, it is sometimes desirable to set features directly on words (for example, when one wants to elide a specific word, but not its parent phrase).
    If the object passed is already a WordElement, then a new InflectedWordElement is returned which wraps this WordElement . If the object is a String, then the WordElement representing this String is looked up, and a new InflectedWordElement wrapping this is returned. If no such WordElement is found, the element returned is an InflectedWordElement with the supplied string as baseform and no base WordElement . If an NLGElement is passed, this is returned unchanged.
    Parameters: word - the word category - the category Returns: an InflectedWordElement, or the original supplied object if it is an NLGElement.
  createPrepositionPhrase public PPPhraseSpec createPrepositionPhrase() Creates a blank preposition phrase with no preposition or complements. Returns: a PPPhraseSpec representing this phrase. createPrepositionPhrase public PPPhraseSpec createPrepositionPhrase(Object preposition) Creates a preposition phrase with the given preposition. Parameters: preposition - the preposition to be used. Returns: a PPPhraseSpec representing this phrase. createPrepositionPhrase public PPPhraseSpec createPrepositionPhrase(Object preposition, Object complement) Creates a preposition phrase with the given preposition and complement. An NLGElement representing the preposition is added as the head feature of this phrase while the complement is added as a normal phrase complement. Parameters: preposition - the preposition to be used. complement - the complement of the phrase. Returns: a PPPhraseSpec representing this phrase. createNLGElement public NLGElement createNLGElement(Object element, LexicalCategory category) this method creates an NLGElement from an object If object is null, return null If the object is already an NLGElement, it is returned unchanged Exception: if it is an InflectedWordElement, return underlying WordElement If it is a String which matches a lexicon entry or pronoun, the relevant WordElement is returned If it is a different String, a wordElement is created if the string is a single word Otherwise a StringElement is returned Otherwise throw an exception Parameters: element - - object to look up category - - default lexical category of object Returns: NLGelement createNLGElement public NLGElement createNLGElement(Object element) create an NLGElement from the element, no default lexical category Returns: NLGelement createNounPhrase public NPPhraseSpec createNounPhrase() Creates a blank noun phrase with no subject or specifier. Returns: a NPPhraseSpec representing this phrase. createNounPhrase public NPPhraseSpec createNounPhrase(Object noun) Creates a noun phrase with the given subject but no specifier. Parameters: noun - the subject of the phrase. Returns: a NPPhraseSpec representing this phrase. createNounPhrase public NPPhraseSpec createNounPhrase(Object specifier, Object noun) Creates a noun phrase with the given specifier and subject. Parameters: specifier - the specifier or determiner for the noun phrase. noun - the subject of the phrase. Returns: a NPPhraseSpec representing this phrase. createAdjectivePhrase public AdjPhraseSpec createAdjectivePhrase() Creates a blank adjective phrase with no base adjective set. Returns: a AdjPhraseSpec representing this phrase. createAdjectivePhrase public AdjPhraseSpec createAdjectivePhrase(Object adjective) Creates an adjective phrase wrapping the given adjective. Parameters: adjective - the main adjective for this phrase. Returns: a AdjPhraseSpec representing this phrase. createVerbPhrase public VPPhraseSpec createVerbPhrase() Creates a blank verb phrase with no main verb. Returns: a VPPhraseSpec representing this phrase. createVerbPhrase public VPPhraseSpec createVerbPhrase(Object verb) Creates a verb phrase wrapping the main verb given. If a String is passed in then some parsing is done to see if the verb contains a particle, for example fall down. The first word is taken to be the verb while all other words are assumed to form the particle. Parameters: verb - the verb to be wrapped. Returns: a VPPhraseSpec representing this phrase. createAdverbPhrase public AdvPhraseSpec createAdverbPhrase() Creates a blank adverb phrase that has no adverb. Returns: a AdvPhraseSpec representing this phrase. createAdverbPhrase public AdvPhraseSpec createAdverbPhrase(String adverb) Creates an adverb phrase wrapping the given adverb. Parameters: adverb - the adverb for this phrase. Returns: a AdvPhraseSpec representing this phrase. createClause public SPhraseSpec createClause() Creates a blank clause with no subject, verb or objects. Returns: a SPhraseSpec representing this phrase. createClause public SPhraseSpec createClause(Object subject, Object verb) Creates a clause with the given subject and verb but no objects. Parameters: subject - the subject for the clause as a NLGElement or String. This forms a noun phrase. verb - the verb for the clause as a NLGElement or String. This forms a verb phrase. Returns: a SPhraseSpec representing this phrase. createClause public SPhraseSpec createClause(Object subject, Object verb, Object directObject) Creates a clause with the given subject, verb or verb phrase and direct object but no indirect object. Parameters: subject - the subject for the clause as a NLGElement or String. This forms a noun phrase. verb - the verb for the clause as a NLGElement or String. This forms a verb phrase. directObject - the direct object for the clause as a NLGElement or String. This forms a complement for the clause. Returns: a SPhraseSpec representing this phrase. createStringElement public NLGElement createStringElement() Creates a blank canned text phrase with no text. Returns: a PhraseElement representing this phrase. createStringElement public NLGElement createStringElement(String text) Creates a canned text phrase with the given text. Parameters: text - the canned text. Returns: a PhraseElement representing this phrase. createCoordinatedPhrase public CoordinatedPhraseElement createCoordinatedPhrase() Creates a new (empty) coordinated phrase Returns: empty CoordinatedPhraseElement createCoordinatedPhrase public CoordinatedPhraseElement createCoordinatedPhrase(Object coord1, Object coord2) Creates a new coordinated phrase with two elements (initially) Parameters: coord1 - - first phrase to be coordinated coord2 - = second phrase to be coordinated Returns: CoordinatedPhraseElement for the two given elements createDocument public DocumentElement createDocument() Creates a new document element with no title. Returns: a DocumentElement createDocument public DocumentElement createDocument(String title) Creates a new document element with the given title. Parameters: title - the title for this element. Returns: a DocumentElement. createDocument public DocumentElement createDocument(String title, List<DocumentElement> components) Creates a new document element with the given title and adds all of the given components in the list Parameters: title - the title of this element. components - a List of NLGElements that form the components of this element. Returns: a DocumentElement createDocument public DocumentElement createDocument(String title, NLGElement component) Creates a new document element with the given title and adds the given component. Parameters: title - the title for this element. component - an NLGElement that becomes the first component of this document element. Returns: a DocumentElement createList public DocumentElement createList() Creates a new list element with no components. Returns: a DocumentElement representing the list. createList public DocumentElement createList(List<DocumentElement> textComponents) Creates a new list element and adds all of the given components in the list Parameters: textComponents - a List of NLGElements that form the components of this element. Returns: a DocumentElement representing the list. createList public DocumentElement createList(NLGElement component) Creates a new section element with the given title and adds the given component. Parameters: component - an NLGElement that becomes the first component of this document element. Returns: a DocumentElement representing the section. createEnumeratedList public DocumentElement createEnumeratedList() Creates a new enumerated list element with no components. Returns: a DocumentElement representing the list. createEnumeratedList public DocumentElement createEnumeratedList(List<DocumentElement> textComponents) Creates a new enumerated list element and adds all of the given components in the list Parameters: textComponents - a List of NLGElements that form the components of this element. Returns: a DocumentElement representing the list. createEnumeratedList public DocumentElement createEnumeratedList(NLGElement component) Creates a new section element with the given title and adds the given component. Parameters: component - an NLGElement that becomes the first component of this document element. Returns: a DocumentElement representing the section. createListItem public DocumentElement createListItem() Creates a list item for adding to a list element. Returns: a DocumentElement representing the list item. createListItem public DocumentElement createListItem(NLGElement component) Creates a list item for adding to a list element. The list item has the given component. Returns: a DocumentElement representing the list item. createParagraph public DocumentElement createParagraph() Creates a new paragraph element with no components. Returns: a DocumentElement representing this paragraph createParagraph public DocumentElement createParagraph(List<DocumentElement> components) Creates a new paragraph element and adds all of the given components in the list Parameters: components - a List of NLGElements that form the components of this element. Returns: a DocumentElement representing this paragraph createParagraph public DocumentElement createParagraph(NLGElement component) Creates a new paragraph element and adds the given component Parameters: component - an NLGElement that becomes the first component of this document element. Returns: a DocumentElement representing this paragraph createSection public DocumentElement createSection() Creates a new section element. Returns: a DocumentElement representing the section. createSection public DocumentElement createSection(String title) Creates a new section element with the given title. Parameters: title - the title of the section. Returns: a DocumentElement representing the section. createSection public DocumentElement createSection(String title, List<DocumentElement> components) Creates a new section element with the given title and adds all of the given components in the list Parameters: title - the title of this element. components - a List of NLGElements that form the components of this element. Returns: a DocumentElement representing the section. createSection public DocumentElement createSection(String title, NLGElement component) Creates a new section element with the given title and adds the given component. Parameters: title - the title for this element. component - an NLGElement that becomes the first component of this document element. Returns: a DocumentElement representing the section. createSentence public DocumentElement createSentence() Creates a new sentence element with no components. Returns: a DocumentElement representing this sentence createSentence public DocumentElement createSentence(List<NLGElement> components) Creates a new sentence element and adds all of the given components. Parameters: components - a List of NLGElements that form the components of this element. Returns: a DocumentElement representing this sentence createSentence public DocumentElement createSentence(NLGElement components) Creates a new sentence element Parameters: components - an NLGElement that becomes the first component of this document element. Returns: a DocumentElement representing this sentence createSentence public DocumentElement createSentence(Object subject, Object verb) Creates a sentence with the given subject and verb. The phrase factory is used to construct a clause that then forms the components of the sentence. Parameters: subject - the subject of the sentence. verb - the verb of the sentence. Returns: a DocumentElement representing this sentence createSentence public DocumentElement createSentence(Object subject, Object verb, Object complement) Creates a sentence with the given subject, verb and direct object. The phrase factory is used to construct a clause that then forms the components of the sentence. Parameters: subject - the subject of the sentence. verb - the verb of the sentence. complement - the object of the sentence. Returns: a DocumentElement representing this sentence createSentence public DocumentElement createSentence(String cannedSentence) Creates a new sentence with the given canned text. The canned text is used to form a canned phrase (from the phrase factory) which is then added as the component to sentence element. Parameters: cannedSentence - the canned text as a String. Returns: a DocumentElement representing this sentence

Class NLGFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NLGFactory

NLGFactory

Method Detail

setLexicon

createWord

createInflectedWord

createPrepositionPhrase

createPrepositionPhrase

createPrepositionPhrase

createNLGElement

createNLGElement

createNounPhrase

createNounPhrase

createNounPhrase

createAdjectivePhrase

createAdjectivePhrase

createVerbPhrase

createVerbPhrase

createAdverbPhrase

createAdverbPhrase

createClause

createClause

createClause

createStringElement

createStringElement

createCoordinatedPhrase

createCoordinatedPhrase

createDocument

createDocument

createDocument

createDocument

createList

createList

createList

createEnumeratedList

createEnumeratedList

createEnumeratedList

createListItem

createListItem

createParagraph

createParagraph

createParagraph

createSection

createSection

createSection

createSection

createSentence

createSentence

createSentence

createSentence

createSentence

createSentence