A B C D E F G H I L M N O P Q R S T U V W X

A

ACRONYM - Static variable in class simplenlg.features.InternalFeature

This feature determines if the element is an acronym.

ACRONYM_OF - Static variable in class simplenlg.features.LexicalFeature

This feature is used to map an acronym element to the full forms of the acronym.

ACRONYMS - Static variable in class simplenlg.features.LexicalFeature

This feature is used to map a word to its acronyms.

addComplement(NLGElement) - Method in class simplenlg.framework.CoordinatedPhraseElement

Adds a new complement to the phrase element.

addComplement(String) - Method in class simplenlg.framework.CoordinatedPhraseElement

Adds a new complement to the phrase element.

addComplement(NLGElement) - Method in class simplenlg.framework.PhraseElement

Adds a new complement to the phrase element.

addComplement(String) - Method in class simplenlg.framework.PhraseElement

Adds a new complement to the phrase element.

addComplement(NLGElement) - Method in class simplenlg.phrasespec.SPhraseSpec

addComplement(String) - Method in class simplenlg.phrasespec.SPhraseSpec

addComponent(NLGElement) - Method in class simplenlg.framework.DocumentElement

Add a single child component to the current list of child components.

addComponent(NLGElement) - Method in class simplenlg.framework.ListElement

Adds the given component to the list element.

addComponents(List<?>) - Method in class simplenlg.framework.DocumentElement

Adds a collection of NLGElements to the list of child components.

addComponents(List<NLGElement>) - Method in class simplenlg.framework.ListElement

Adds the given components to the list element.

addCoordinate(Object) - Method in class simplenlg.framework.CoordinatedPhraseElement

Adds a new coordinate to this coordination.

addFinalLexicon(Lexicon) - Method in class simplenlg.lexicon.MultipleLexicon

add lexicon at end of list (is searched last)

addFrontModifier(NLGElement) - Method in class simplenlg.framework.PhraseElement

Adds a new front modifier to the phrase element.

addFrontModifier(String) - Method in class simplenlg.framework.PhraseElement

Adds a new front modifier to the phrase element.

addInflectionalVariant(Inflection, String, String) - Method in class simplenlg.framework.WordElement

Add an inflectional variant to this word element.

addInflectionalVariant(Inflection) - Method in class simplenlg.framework.WordElement

Specify that this word has an inflectional variant (e.g.

addInitialLexicon(Lexicon) - Method in class simplenlg.lexicon.MultipleLexicon

add lexicon at beginning of list (is searched first)

addModifier(Object) - Method in class simplenlg.framework.PhraseElement

Add a modifier to a phrase Use heuristics to decide where it goes

addModifier(Object) - Method in class simplenlg.phrasespec.NPPhraseSpec

Add a modifier to an NP Use heuristics to decide where it goes

addModifier(Object) - Method in class simplenlg.phrasespec.SPhraseSpec

Add a modifier to a clause Use heuristics to decide where it goes

addModifier(Object) - Method in class simplenlg.phrasespec.VPPhraseSpec

Add a modifier to a verb phrase Use heuristics to decide where it goes

addPhrase(NLGElement) - Method in class simplenlg.aggregation.PhraseSet

Add a phrase

addPhrases(Collection<NLGElement>) - Method in class simplenlg.aggregation.PhraseSet

Add a collection of phrases.

addPostModifier(NLGElement) - Method in class simplenlg.framework.CoordinatedPhraseElement

Adds a new post-modifier to the phrase element.

addPostModifier(String) - Method in class simplenlg.framework.CoordinatedPhraseElement

Adds a new post-modifier to the phrase element.

addPostModifier(NLGElement) - Method in class simplenlg.framework.PhraseElement

Adds a new post-modifier to the phrase element.

addPostModifier(String) - Method in class simplenlg.framework.PhraseElement

Adds a new post-modifier to the phrase element.

addPreModifier(NLGElement) - Method in class simplenlg.framework.CoordinatedPhraseElement

Adds a new pre-modifier to the phrase element.

addPreModifier(String) - Method in class simplenlg.framework.CoordinatedPhraseElement

Adds a new pre-modifier to the phrase element.

addPreModifier(NLGElement) - Method in class simplenlg.framework.PhraseElement

Adds a new pre-modifier to the phrase element.

addPreModifier(String) - Method in class simplenlg.framework.PhraseElement

Adds a new pre-modifier to the phrase element.

addPreModifier(NLGElement) - Method in class simplenlg.phrasespec.SPhraseSpec

addRecord(XmlDocumentElement, String) - Method in class simplenlg.xmlrealiser.Recording

Adds a record to this recording.

addRule(AggregationRule) - Method in class simplenlg.aggregation.Aggregator

Add a rule to this aggregator.

ADJECTIVE_ORDERING - Static variable in class simplenlg.features.Feature

This feature determines if the adjectives should be reordered.

adjectiveordering - Variable in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

AdjPhraseSpec - Class in simplenlg.phrasespec

This class defines a adjective phrase.

AdjPhraseSpec(NLGFactory) - Constructor for class simplenlg.phrasespec.AdjPhraseSpec

AdvPhraseSpec - Class in simplenlg.phrasespec

This class defines a adverbial phrase.

AdvPhraseSpec(NLGFactory) - Constructor for class simplenlg.phrasespec.AdvPhraseSpec

AGGREGATE_AUXILIARY - Static variable in class simplenlg.features.Feature

This feature determines if the auxiliary verbs in a clause should be aggregated.

aggregateauxiliary - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

aggregateauxiliary - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

AggregationHelper - Class in simplenlg.aggregation

AggregationHelper() - Constructor for class simplenlg.aggregation.AggregationHelper

AggregationRule - Class in simplenlg.aggregation

This class represents an aggregation rule.

AggregationRule() - Constructor for class simplenlg.aggregation.AggregationRule

Creates a new instance of AggregationRule

Aggregator - Class in simplenlg.aggregation

An Aggregator performs aggregation on clauses, by applying a set of prespecified rules on them and returning the result.

Aggregator() - Constructor for class simplenlg.aggregation.Aggregator

Creates an instance of Aggregator

allActive(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check whether all sentences are active

allPassive(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check whether all sentences are passive

apply(List<NLGElement>) - Method in class simplenlg.aggregation.AggregationRule

Performs aggregation on an arbitrary number of elements in a list.

apply(NLGElement) - Method in class simplenlg.aggregation.AggregationRule

Perform aggregation on a single phrase.

apply(NLGElement, NLGElement) - Method in class simplenlg.aggregation.AggregationRule

Performs aggregation on a pair of sentences.

apply(NLGElement, NLGElement) - Method in class simplenlg.aggregation.BackwardConjunctionReductionRule

Applies backward conjunction reduction to two NLGElements e1 and e2, succeeding only if they are clauses (that is, e1.getCategory() == e2.getCategory == PhraseCategory.CLAUSE).

apply(NLGElement, NLGElement) - Method in class simplenlg.aggregation.ClauseCoordinationRule

Applies aggregation to two NLGElements e1 and e2, succeeding only if they are clauses (that is, e1.getCategory() == e2.getCategory == PhraseCategory.CLAUSE).

apply(NLGElement, NLGElement) - Method in class simplenlg.aggregation.ForwardConjunctionReductionRule

Applies forward conjunction reduction to two NLGElements e1 and e2, succeeding only if they are clauses (that is, e1.getCategory() == e2.getCategory == PhraseCategory.CLAUSE) and the clauses are not passive.

APPOSITIVE - Static variable in class simplenlg.features.Feature

An appositive is a type of postmodifying phrase which is quasi-synonymous with, or a possible replacement of, the phrase it modifies.

appositive - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

appositive - Variable in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

B

BackwardConjunctionReductionRule - Class in simplenlg.aggregation

Implementation of the backward conjunction reduction rule.

BackwardConjunctionReductionRule() - Constructor for class simplenlg.aggregation.BackwardConjunctionReductionRule

Creates a new BackwardConjunctionReduction.

base - Variable in class simplenlg.xmlrealiser.wrapper.XmlWordElement

BASE_FORM - Static variable in class simplenlg.features.LexicalFeature

This feature is used to define the base form for phrases and words.

BASE_WORD - Static variable in class simplenlg.features.InternalFeature

This feature is used to reference the base word element as created by the lexicon.

C

canned - Variable in class simplenlg.xmlrealiser.wrapper.XmlWordElement

cat - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

cat - Variable in class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

cat - Variable in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

cat - Variable in class simplenlg.xmlrealiser.wrapper.XmlWordElement

checkIfPlural() - Method in class simplenlg.framework.CoordinatedPhraseElement

child - Variable in class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

CLASSIFYING - Static variable in class simplenlg.features.LexicalFeature

This feature is used for determining the position of adjectives.

CLAUSE_STATUS - Static variable in class simplenlg.features.InternalFeature

This feature determines the status of a sentence.

ClauseCoordinationRule - Class in simplenlg.aggregation

Implementation of a clausal coordination rule.

ClauseCoordinationRule() - Constructor for class simplenlg.aggregation.ClauseCoordinationRule

Constructs an instance of the ClauseCoordinationRule

ClauseStatus - Enum in simplenlg.features

This is an enumeration of the two different types of clauses used in the SimplNLG package.

clausestatus - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

clearAllFeatures() - Method in class simplenlg.framework.NLGElement

Deletes all the features in the map.

clearComplements() - Method in class simplenlg.framework.PhraseElement

Removes all existing complements on the phrase.

clearComponents() - Method in class simplenlg.framework.DocumentElement

Removes all the child components from this element.

clearCoordinates() - Method in class simplenlg.framework.CoordinatedPhraseElement

Clears the existing coordinates in this coordination.

close() - Method in class simplenlg.lexicon.Lexicon

close the lexicon (if necessary) if lexicon does not need to be closed, this does nothing

close() - Method in class simplenlg.lexicon.MultipleLexicon

close() - Method in class simplenlg.lexicon.NIHDBLexicon

collectFunctionalPairs(NLGElement, NLGElement) - Static method in class simplenlg.aggregation.AggregationHelper

COLOUR - Static variable in class simplenlg.features.LexicalFeature

This feature is used for determining the position of adjectives.

COMPARATIVE - Static variable in class simplenlg.features.LexicalFeature

This feature gives the comparative form for adjectives and adverbs.

compl - Variable in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

COMPLEMENTISER - Static variable in class simplenlg.features.Feature

The complementiser is the word that joins a subordinate clause to the parent clause.

complementiser - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

COMPLEMENTS - Static variable in class simplenlg.features.InternalFeature

This feature refers to the list of complements for the phrase.

COMPONENTS - Static variable in class simplenlg.features.InternalFeature

This feature refers to the list of components in a ListElement.

conj - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

CONJUNCTION - Static variable in class simplenlg.features.Feature

This feature represents the word (or phrase) used for linking coordinated phrases together.

CONJUNCTION_TYPE - Static variable in class simplenlg.features.Feature

This feature represents the type of conjunction this coordination represents.

conjunctiontype - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

coord - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

CoordinatedPhraseElement - Class in simplenlg.framework

This class defines coordination between two or more phrases.

CoordinatedPhraseElement() - Constructor for class simplenlg.framework.CoordinatedPhraseElement

Creates a blank coordinated phrase ready for new coordinates to be added.

CoordinatedPhraseElement(Object, Object) - Constructor for class simplenlg.framework.CoordinatedPhraseElement

Creates a coordinated phrase linking the two phrase together.

COORDINATES - Static variable in class simplenlg.features.InternalFeature

This feature is the list of coordinated phrases in a CoordinatedPhraseElement.

createAdjectivePhrase() - Method in class simplenlg.framework.NLGFactory

Creates a blank adjective phrase with no base adjective set.

createAdjectivePhrase(Object) - Method in class simplenlg.framework.NLGFactory

Creates an adjective phrase wrapping the given adjective.

createAdverbPhrase() - Method in class simplenlg.framework.NLGFactory

Creates a blank adverb phrase that has no adverb.

createAdverbPhrase(String) - Method in class simplenlg.framework.NLGFactory

Creates an adverb phrase wrapping the given adverb.

createClause() - Method in class simplenlg.framework.NLGFactory

Creates a blank clause with no subject, verb or objects.

createClause(Object, Object) - Method in class simplenlg.framework.NLGFactory

Creates a clause with the given subject and verb but no objects.

createClause(Object, Object, Object) - Method in class simplenlg.framework.NLGFactory

Creates a clause with the given subject, verb or verb phrase and direct object but no indirect object.

createCoordinatedPhrase() - Method in class simplenlg.framework.NLGFactory

Creates a new (empty) coordinated phrase

createCoordinatedPhrase(Object, Object) - Method in class simplenlg.framework.NLGFactory

Creates a new coordinated phrase with two elements (initially)

createDocument() - Method in class simplenlg.framework.NLGFactory

Creates a new document element with no title.

createDocument(String) - Method in class simplenlg.framework.NLGFactory

Creates a new document element with the given title.

createDocument(String, List<DocumentElement>) - Method in class simplenlg.framework.NLGFactory

Creates a new document element with the given title and adds all of the given components in the list

createDocument(String, NLGElement) - Method in class simplenlg.framework.NLGFactory

Creates a new document element with the given title and adds the given component.

createDocumentRealisation() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of DocumentRealisation

createEnumeratedList() - Method in class simplenlg.framework.NLGFactory

Creates a new enumerated list element with no components.

createEnumeratedList(List<DocumentElement>) - Method in class simplenlg.framework.NLGFactory

Creates a new enumerated list element and adds all of the given components in the list

createEnumeratedList(NLGElement) - Method in class simplenlg.framework.NLGFactory

Creates a new section element with the given title and adds the given component.

createInflectedWord(Object, LexicalCategory) - Method in class simplenlg.framework.NLGFactory

Create an inflected word element.

createList() - Method in class simplenlg.framework.NLGFactory

Creates a new list element with no components.

createList(List<DocumentElement>) - Method in class simplenlg.framework.NLGFactory

Creates a new list element and adds all of the given components in the list

createList(NLGElement) - Method in class simplenlg.framework.NLGFactory

Creates a new section element with the given title and adds the given component.

createListItem() - Method in class simplenlg.framework.NLGFactory

Creates a list item for adding to a list element.

createListItem(NLGElement) - Method in class simplenlg.framework.NLGFactory

Creates a list item for adding to a list element.

createNLGElement(Object, LexicalCategory) - Method in class simplenlg.framework.NLGFactory

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

createNLGElement(Object) - Method in class simplenlg.framework.NLGFactory

create an NLGElement from the element, no default lexical category

createNLGSpec() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of NLGSpec

createNounPhrase() - Method in class simplenlg.framework.NLGFactory

Creates a blank noun phrase with no subject or specifier.

createNounPhrase(Object) - Method in class simplenlg.framework.NLGFactory

Creates a noun phrase with the given subject but no specifier.

createNounPhrase(Object, Object) - Method in class simplenlg.framework.NLGFactory

Creates a noun phrase with the given specifier and subject.

createParagraph() - Method in class simplenlg.framework.NLGFactory

Creates a new paragraph element with no components.

createParagraph(List<DocumentElement>) - Method in class simplenlg.framework.NLGFactory

Creates a new paragraph element and adds all of the given components in the list

createParagraph(NLGElement) - Method in class simplenlg.framework.NLGFactory

Creates a new paragraph element and adds the given component

createPrepositionPhrase() - Method in class simplenlg.framework.NLGFactory

Creates a blank preposition phrase with no preposition or complements.

createPrepositionPhrase(Object) - Method in class simplenlg.framework.NLGFactory

Creates a preposition phrase with the given preposition.

createPrepositionPhrase(Object, Object) - Method in class simplenlg.framework.NLGFactory

Creates a preposition phrase with the given preposition and complement.

createRecordSet() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of RecordSet

createRequestType() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of RequestType

createSection() - Method in class simplenlg.framework.NLGFactory

Creates a new section element.

createSection(String) - Method in class simplenlg.framework.NLGFactory

Creates a new section element with the given title.

createSection(String, List<DocumentElement>) - Method in class simplenlg.framework.NLGFactory

Creates a new section element with the given title and adds all of the given components in the list

createSection(String, NLGElement) - Method in class simplenlg.framework.NLGFactory

Creates a new section element with the given title and adds the given component.

createSentence() - Method in class simplenlg.framework.NLGFactory

Creates a new sentence element with no components.

createSentence(List<NLGElement>) - Method in class simplenlg.framework.NLGFactory

Creates a new sentence element and adds all of the given components.

createSentence(NLGElement) - Method in class simplenlg.framework.NLGFactory

Creates a new sentence element

createSentence(Object, Object) - Method in class simplenlg.framework.NLGFactory

Creates a sentence with the given subject and verb.

createSentence(Object, Object, Object) - Method in class simplenlg.framework.NLGFactory

Creates a sentence with the given subject, verb and direct object.

createSentence(String) - Method in class simplenlg.framework.NLGFactory

Creates a new sentence with the given canned text.

createStringElement() - Method in class simplenlg.framework.NLGFactory

Creates a blank canned text phrase with no text.

createStringElement(String) - Method in class simplenlg.framework.NLGFactory

Creates a canned text phrase with the given text.

createVerbPhrase() - Method in class simplenlg.framework.NLGFactory

Creates a blank verb phrase with no main verb.

createVerbPhrase(Object) - Method in class simplenlg.framework.NLGFactory

Creates a verb phrase wrapping the main verb given.

createWord(Object, LexicalCategory) - Method in class simplenlg.framework.NLGFactory

Creates a new element representing a word.

createWord(String, LexicalCategory) - Method in class simplenlg.lexicon.Lexicon

create a default WordElement.

createWord(String) - Method in class simplenlg.lexicon.Lexicon

create a default WordElement.

createXmlAdjPhraseSpec() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlAdjPhraseSpec

createXmlAdvPhraseSpec() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlAdvPhraseSpec

createXmlCoordinatedPhraseElement() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlCoordinatedPhraseElement

createXmlDocumentElement() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlDocumentElement

createXmlNPPhraseSpec() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlNPPhraseSpec

createXmlPPPhraseSpec() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlPPPhraseSpec

createXmlSPhraseSpec() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlSPhraseSpec

createXmlStringElement() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlStringElement

createXmlVPPhraseSpec() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlVPPhraseSpec

createXmlWordElement() - Method in class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create an instance of XmlWordElement

CUE_PHRASE - Static variable in class simplenlg.features.Feature

This feature represents the cue phrase of a sentence.

cuePhrase - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

D

DEFAULT_INFL - Static variable in class simplenlg.features.LexicalFeature

This feature is used to specify, for a given word, what its default inflectional variant is, if more than one is possible.

DEFAULT_SPELL - Static variable in class simplenlg.features.LexicalFeature

This feature is used to specify the default spelling variant of a word, if it has more than one.

DeterminerAgrHelper - Class in simplenlg.morphology.english

This class is used to parse numbers that are passed as figures, to determine whether they should take "a" or "an" as determiner.

DeterminerAgrHelper() - Constructor for class simplenlg.morphology.english.DeterminerAgrHelper

DISCOURSE_FUNCTION - Static variable in class simplenlg.features.InternalFeature

This feature defines the role each element plays in the structure of the text.

DiscourseFunction - Enum in simplenlg.features

An enumeration representing the grammatical function that an element might take.

discourseFunction - Variable in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

DITRANSITIVE - Static variable in class simplenlg.features.LexicalFeature

This feature determines if a verb is ditransitive, meaning that it can have a subject, direct object and indirect object.

doAdjectiveMorphology(InflectedWordElement, WordElement) - Static method in class simplenlg.morphology.english.MorphologyRules

This method performs the morphology for adjectives.

doAdverbMorphology(InflectedWordElement, WordElement) - Static method in class simplenlg.morphology.english.MorphologyRules

This method performs the morphology for adverbs.

document - Variable in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

document - Variable in class simplenlg.xmlrealiser.wrapper.RequestType

DocumentCategory - Enum in simplenlg.framework

This enumerated type defines the different types of components found in the structure of text.

DocumentElement - Class in simplenlg.framework

DocumentElement is a convenient extension of the base NLGElement class.

DocumentElement() - Constructor for class simplenlg.framework.DocumentElement

The blank constructor.

DocumentElement(DocumentCategory, String) - Constructor for class simplenlg.framework.DocumentElement

Creates a new DocumentElement with the given category and title.

DocumentRealisation - Class in simplenlg.xmlrealiser.wrapper

Java class for DocumentRealisation complex type.

DocumentRealisation() - Constructor for class simplenlg.xmlrealiser.wrapper.DocumentRealisation

doDeterminerMorphology(NLGElement, String) - Static method in class simplenlg.morphology.english.MorphologyRules

This method performs the morphology for determiners.

doNounMorphology(InflectedWordElement, WordElement) - Static method in class simplenlg.morphology.english.MorphologyRules

This method performs the morphology for nouns.

doPronounMorphology(InflectedWordElement) - Static method in class simplenlg.morphology.english.MorphologyRules

This method performs the morphology for pronouns.

doRealisation(Reader) - Method in class simplenlg.server.RealisationRequest

doVerbMorphology(InflectedWordElement, WordElement) - Static method in class simplenlg.morphology.english.MorphologyRules

This method performs the morphology for verbs.

downALevel() - Method in class simplenlg.format.english.NumberedPrefix

This method removes a level from the prefix (e.g., 0 if current is a plain number, say, 7, or 2.4, if current is 2.4.1).

E

ElementCategory - Interface in simplenlg.framework

This is the base interface for defining categories for the sub classes of NLGElement.

ELIDED - Static variable in class simplenlg.features.Feature

This features determines if the phrase is elided.

elided - Variable in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

elideLeftMost() - Method in class simplenlg.aggregation.FunctionalSet

elideLeftmost() - Method in class simplenlg.aggregation.PhraseSet

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

elideRightMost() - Method in class simplenlg.aggregation.FunctionalSet

elideRightmost() - Method in class simplenlg.aggregation.PhraseSet

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

equals(String) - Method in class simplenlg.framework.NLGElement

Determines if this element has its realisation equal to the given string.

equals(Object) - Method in class simplenlg.framework.NLGElement

An NLG element is equal to some object if the object is an NLGElement, they have the same category and the same features.

equals(Object) - Method in class simplenlg.framework.StringElement

equals(Object) - Method in class simplenlg.framework.WordElement

Check if this WordElement is equal to an object.

equalTo(Object) - Method in enum simplenlg.framework.DocumentCategory

Checks to see if the given object is equal to this document category.

equalTo(Object) - Method in interface simplenlg.framework.ElementCategory

Checks to see if this supplied object matches this particular category.

equalTo(Object) - Method in enum simplenlg.framework.LexicalCategory

Checks to see if the given object is equal to this lexical category.

equalTo(Object) - Method in enum simplenlg.framework.PhraseCategory

Checks to see if the given object is equal to this phrase category.

EXCLAMATORY - Static variable in class simplenlg.features.Feature

This features determines if the phrase should end with with a exclamatory or not.

exit() - Method in class simplenlg.server.SimpleServer

Exit the program without error.

exit(int) - Method in class simplenlg.server.SimpleServer

Exit the program signalling an error code.

EXPLETIVE_SUBJECT - Static variable in class simplenlg.features.LexicalFeature

This feature determines if the pronoun is an expletive or not.

expletivesubject - Variable in class simplenlg.xmlrealiser.wrapper.XmlWordElement

expletiveSubjects(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check whether these sentences have expletive subjects (there, it etc)

F

factory - Variable in class simplenlg.aggregation.AggregationRule

Feature - Class in simplenlg.features

This class defines a list of features which can be set up users of SimpleNLG.

features - Variable in class simplenlg.framework.NLGElement

The features of this element.

finish() - Method in class simplenlg.xmlrealiser.Recording

Ends processing for this recording and writes it to an XML file.

FORM - Static variable in class simplenlg.features.Feature

This feature dictates the form that a verb takes.

Form - Enum in simplenlg.features

An enumeration representing the different forms a verb and its associated phrase can take.

form - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

form - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

formIdentical() - Method in class simplenlg.aggregation.FunctionalSet

formIdentical() - Method in class simplenlg.aggregation.PhraseSet

Check whether the phrases in this set are identical in form.

ForwardConjunctionReductionRule - Class in simplenlg.aggregation

Implementation of the forward conjunction rule.

ForwardConjunctionReductionRule() - Constructor for class simplenlg.aggregation.ForwardConjunctionReductionRule

Creates a new ForwardConjunctionReduction.

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlClauseStatus

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlDiscourseFunction

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlDocumentCategory

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlForm

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlGender

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlInflection

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlInterrogativeType

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlLexicalCategory

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlNumberAgreement

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlPerson

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlPhraseCategory

fromValue(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlTense

FRONT_MODIFIERS - Static variable in class simplenlg.features.InternalFeature

This feature tracks any front modifiers in sentences.

frontMod - Variable in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

FunctionalSet - Class in simplenlg.aggregation

FUNCTIONS - Static variable in class simplenlg.aggregation.AggregationHelper

G

Gender - Enum in simplenlg.features

An enumeration representing the gender of the subject of a noun phrase, or the object or subject of a verb phrase.

GENDER - Static variable in class simplenlg.features.LexicalFeature

This feature determines whether a noun is masculine, feminine or neuter in nature.

gender - Variable in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

getAdjective() - Method in class simplenlg.phrasespec.AdjPhraseSpec

getAdverb() - Method in class simplenlg.phrasespec.AdvPhraseSpec

getAllFeatureNames() - Method in class simplenlg.framework.NLGElement

Retrieves the set of features currently contained in the feature map.

getAllFeatures() - Method in class simplenlg.framework.NLGElement

Retrieves the map containing all the features for this element.

getBase() - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Gets the value of the base property.

getBaseForm() - Method in class simplenlg.framework.InflectedWordElement

Retrieves the base form for this element.

getBaseForm() - Method in class simplenlg.framework.WordElement

getBaseWord() - Method in class simplenlg.framework.InflectedWordElement

Retrieves the base word for this element.

getCat() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the cat property.

getCat() - Method in class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

Gets the value of the cat property.

getCat() - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Gets the value of the cat property.

getCat() - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Gets the value of the cat property.

getCategory() - Method in class simplenlg.aggregation.FunctionalSet

getCategory() - Method in class simplenlg.framework.NLGElement

Retrieves the category for this element.

getChild() - Method in class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

Gets the value of the child property.

getChildren() - Method in class simplenlg.framework.CoordinatedPhraseElement

getChildren() - Method in class simplenlg.framework.DocumentElement

Child elements of a DocumentElement are the components.

getChildren() - Method in class simplenlg.framework.InflectedWordElement

This method returns null as the inflected word has no child components.

getChildren() - Method in class simplenlg.framework.ListElement

getChildren() - Method in class simplenlg.framework.NLGElement

Retrieves the children for this element.

getChildren() - Method in class simplenlg.framework.PhraseElement

This method retrieves the child components of this phrase.

getChildren() - Method in class simplenlg.framework.StringElement

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

getChildren() - Method in class simplenlg.framework.WordElement

This method returns an empty List as words do not have child elements.

getCLAUSESTATUS() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the clausestatus property.

getCompl() - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Gets the value of the compl property.

getCOMPLEMENTISER() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the complementiser property.

getComplements() - Method in class simplenlg.framework.CoordinatedPhraseElement

Retrieves the list of complements currently associated with this coordination.

getComponents() - Method in class simplenlg.aggregation.FunctionalSet

getComponents() - Method in class simplenlg.framework.DocumentElement

Retrieves the child components of this element.

getConj() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the conj property.

getConjunction() - Method in class simplenlg.framework.CoordinatedPhraseElement

getCONJUNCTIONTYPE() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the conjunctiontype property.

getCoord() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the coord property.

getCuePhrase() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the cuePhrase property.

getDefaultInflectionalVariant() - Method in class simplenlg.framework.WordElement

getDefaultLexicon() - Static method in class simplenlg.lexicon.Lexicon

returns the default built-in lexicon

getDefaultSpellingVariant() - Method in class simplenlg.framework.WordElement

Convenience method, equivalent to getFeatureAsString(LexicalFeature.DEFAULT_SPELL).

getDeterminer() - Method in class simplenlg.phrasespec.NPPhraseSpec

getDeterminer - Convenience method for when a person tries to get a determiner (e.g.

getDiscourseFunction() - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Gets the value of the discourseFunction property.

getDocument() - Method in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

Gets the value of the document property.

getDocument() - Method in class simplenlg.xmlrealiser.wrapper.RequestType

Gets the value of the document property.

getFactory() - Method in class simplenlg.aggregation.AggregationRule

getFactory() - Method in class simplenlg.framework.NLGElement

getFeature(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature.

getFeature(String) - Method in class simplenlg.phrasespec.SPhraseSpec

getFeatureAsBoolean(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a Boolean.

getFeatureAsDouble(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a Double.

getFeatureAsElement(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a NLGElement.

getFeatureAsElementList(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a list of elements.

getFeatureAsFloat(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a Float.

getFeatureAsInteger(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as an Integer.

getFeatureAsList(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a list of java objects.

getFeatureAsLong(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a Long.

getFeatureAsString(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a string.

getFeatureAsStringList(String) - Method in class simplenlg.framework.NLGElement

Retrieves the value of the feature as a list of strings.

getFirst() - Method in class simplenlg.framework.ListElement

Retrieves the first component in the list.

getFORM() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the form property.

getFORM() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the form property.

getFrontMod() - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Gets the value of the frontMod property.

getFrontModifiers() - Method in class simplenlg.framework.PhraseElement

Retrieves the current list of frony modifiers for the phrase.

getFunction() - Method in class simplenlg.aggregation.FunctionalSet

getFunction() - Method in class simplenlg.aggregation.PhraseSet

getGENDER() - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Gets the value of the gender property.

getHead() - Method in class simplenlg.framework.PhraseElement

Retrieves the current head of this phrase.

getHead() - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Gets the value of the head property.

getId() - Method in class simplenlg.framework.WordElement

getId() - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Gets the value of the id property.

getIndirectObject() - Method in class simplenlg.phrasespec.SPhraseSpec

Returns the indirect object of a clause (assumes there is only one)

getIndirectObject() - Method in class simplenlg.phrasespec.VPPhraseSpec

Returns the indirect object of a clause (assumes there is only one)

getInflCode(String) - Static method in enum simplenlg.features.Inflection

convenience method: parses an inflectional code such as "irreg|woman|women" to retrieve the first element, which is the code itself, then maps it to the value of Inflection.

getInflectionalFeatures(ElementCategory) - Static method in class simplenlg.features.LexicalFeature

Return those features related to a word's inflection, depending on its category, that is, the constants for PAST, PAST_PARTICIPLE, PLURAl, PRESENT_PARTICIPLE, PRESENT3S, COMPARATIVE or SUPERLATIVE.

getInflectionalVariants() - Method in class simplenlg.framework.WordElement

Convenience method to get all the inflectional forms of the word.

getINTERROGATIVETYPE() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the interrogativetype property.

getLastCoordinate() - Method in class simplenlg.framework.CoordinatedPhraseElement

A convenience method for retrieving the last coordinate in this coordination.

getLexicon() - Method in class simplenlg.framework.NLGModule

Retrieves the lexicon currently being used by this module.

getMODAL() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the modal property.

getMODAL() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the modal property.

getMODAL() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the modal property.

getName() - Method in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

Gets the value of the name property.

getName() - Method in class simplenlg.xmlrealiser.wrapper.RecordSet

Gets the value of the name property.

getNLGSpec(Reader) - Static method in class simplenlg.xmlrealiser.UnWrapper

Create wrapper objects from xml for a request to realise, or the xml for a recording.

getNoun() - Method in class simplenlg.phrasespec.NPPhraseSpec

getNUMBER() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the number property.

getNUMBER() - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Gets the value of the number property.

getObject() - Method in class simplenlg.phrasespec.PPPhraseSpec

getObject() - Method in class simplenlg.phrasespec.SPhraseSpec

Returns the direct object of a clause (assumes there is only one)

getObject() - Method in class simplenlg.phrasespec.VPPhraseSpec

Returns the direct object of a clause (assumes there is only one)

getParent() - Method in class simplenlg.framework.NLGElement

Retrieves the parent of this element.

getPeriphery() - Method in class simplenlg.aggregation.FunctionalSet

getPERSON() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the person property.

getPERSON() - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Gets the value of the person property.

getPERSON() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the person property.

getPERSON() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the person property.

getPostMod() - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Gets the value of the postMod property.

getPostModifiers() - Method in class simplenlg.framework.CoordinatedPhraseElement

Retrieves the list of post-modifiers currently associated with this coordination.

getPostModifiers() - Method in class simplenlg.framework.PhraseElement

Retrieves the current list of post modifiers for the phrase.

getPrefix() - Method in class simplenlg.format.english.NumberedPrefix

getPreMod() - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Gets the value of the preMod property.

getPreModifiers() - Method in class simplenlg.framework.CoordinatedPhraseElement

Retrieves the list of pre-modifiers currently associated with this coordination.

getPreModifiers() - Method in class simplenlg.framework.PhraseElement

Retrieves the current list of pre-modifiers for the phrase.

getPreposition() - Method in class simplenlg.phrasespec.PPPhraseSpec

getRealisation() - Method in class simplenlg.framework.NLGElement

Retrieves the final realisation of this element.

getRealisation() - Method in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

Gets the value of the realisation property.

getRecord() - Method in class simplenlg.xmlrealiser.wrapper.RecordSet

Gets the value of the record property.

getRecording() - Method in class simplenlg.xmlrealiser.wrapper.NLGSpec

Gets the value of the recording property.

getRecording(Reader) - Static method in class simplenlg.xmlrealiser.XMLRealiser

Gets the recording.

GetRecordingFile() - Method in class simplenlg.xmlrealiser.Recording

Gets the recording file.

getRequest() - Method in class simplenlg.xmlrealiser.wrapper.NLGSpec

Gets the value of the request property.

getRequest(Reader) - Static method in class simplenlg.xmlrealiser.XMLRealiser

Gets the request.

getRules() - Method in class simplenlg.aggregation.Aggregator

Get the rules in this aggregator.

getSpec() - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Gets the value of the spec property.

getSpecifier() - Method in class simplenlg.phrasespec.NPPhraseSpec

getString() - Method in enum simplenlg.features.InterrogativeType

Convenience method to return the String corresponding to the question word.

getSubj() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the subj property.

getSubject() - Method in class simplenlg.phrasespec.SPhraseSpec

Returns the subject of a clause (assumes there is only one)

getTense() - Method in class simplenlg.framework.NLGElement

Deprecated.

getTENSE() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the tense property.

getTENSE() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the tense property.

getTENSE() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the tense property.

getTitle() - Method in class simplenlg.framework.DocumentElement

Retrieves the title of this element.

getTitle() - Method in class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

Gets the value of the title property.

getVal() - Method in class simplenlg.xmlrealiser.wrapper.XmlStringElement

Gets the value of the val property.

getVar() - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Gets the value of the var property.

getVerb() - Method in class simplenlg.phrasespec.SPhraseSpec

Returns the verb of a clause

getVerb() - Method in class simplenlg.phrasespec.VPPhraseSpec

getVerbPhrase() - Method in class simplenlg.phrasespec.SPhraseSpec

getVp() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the vp property.

getWord(String, LexicalCategory) - Method in class simplenlg.lexicon.Lexicon

get a WordElement which has the specified base form and category

getWord(String) - Method in class simplenlg.lexicon.Lexicon

get a WordElement which has the specified base form (of any category)

getWordByID(String) - Method in class simplenlg.lexicon.Lexicon

get a WordElement with the specified ID

getWordFromVariant(String, LexicalCategory) - Method in class simplenlg.lexicon.Lexicon

returns a WordElement which has the specified inflected form and/or spelling variant that matches the specified variant, of the specified category

getWordFromVariant(String) - Method in class simplenlg.lexicon.Lexicon

returns a WordElement which has the specified inflected form and/or spelling variant that matches the specified variant, of any category.

getWords(String, LexicalCategory) - Method in class simplenlg.lexicon.Lexicon

returns all Words which have the specified base form and category

getWords(String) - Method in class simplenlg.lexicon.Lexicon

returns all Words which have the specified base form

getWords(String, LexicalCategory) - Method in class simplenlg.lexicon.MultipleLexicon

getWords(String, LexicalCategory) - Method in class simplenlg.lexicon.NIHDBLexicon

getWords(String, LexicalCategory) - Method in class simplenlg.lexicon.XMLLexicon

getWordsByID(String) - Method in class simplenlg.lexicon.Lexicon

returns a List of WordElement which have this ID.

getWordsByID(String) - Method in class simplenlg.lexicon.MultipleLexicon

getWordsByID(String) - Method in class simplenlg.lexicon.NIHDBLexicon

getWordsByID(String) - Method in class simplenlg.lexicon.XMLLexicon

getWordsFromVariant(String, LexicalCategory) - Method in class simplenlg.lexicon.Lexicon

returns Words which have an inflected form and/or spelling variant that matches the specified variant, and are in the specified category.

getWordsFromVariant(String) - Method in class simplenlg.lexicon.Lexicon

returns Words which have an inflected form and/or spelling variant that matches the specified variant, of any category.

getWordsFromVariant(String, LexicalCategory) - Method in class simplenlg.lexicon.MultipleLexicon

getWordsFromVariant(String, LexicalCategory) - Method in class simplenlg.lexicon.NIHDBLexicon

getWordsFromVariant(String, LexicalCategory) - Method in class simplenlg.lexicon.XMLLexicon

H

handleClient(Socket) - Method in class simplenlg.server.SimpleServer

Handle the incoming client connection by constructing a RealisationRequest and starting it in a thread.

hasFeature(String) - Method in class simplenlg.framework.NLGElement

Checks the feature map to see if the named feature is present in the map.

hasInflectionalVariant(Inflection) - Method in class simplenlg.framework.WordElement

Check whether this word has a particular inflectional variant

hasSubPart(ElementCategory) - Method in enum simplenlg.framework.DocumentCategory

This method determines if the supplied elementCategory forms an immediate sub-part of this category.

hasWord(String, LexicalCategory) - Method in class simplenlg.lexicon.Lexicon

return true if the lexicon contains a WordElement which has the specified base form and category

hasWord(String) - Method in class simplenlg.lexicon.Lexicon

return true if the lexicon contains a WordElement which has the specified base form (in any category)

hasWordByID(String) - Method in class simplenlg.lexicon.Lexicon

return true if the lexicon contains a WordElement which the specified ID

hasWordFromVariant(String, LexicalCategory) - Method in class simplenlg.lexicon.Lexicon

return true if the lexicon contains a WordElement which matches the specified variant form and category

hasWordFromVariant(String) - Method in class simplenlg.lexicon.Lexicon

return true if the lexicon contains a WordElement which matches the specified variant form (in any category)

haveSameVoice(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that the sentences supplied are either all active or all passive.

HEAD - Static variable in class simplenlg.features.InternalFeature

This feature points to the head element in a phrase.

head - Variable in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

HTMLFormatter - Class in simplenlg.format.english

This processing module adds some simple plain HTML formatting to the SimpleNLG output.

HTMLFormatter() - Constructor for class simplenlg.format.english.HTMLFormatter

I

id - Variable in class simplenlg.xmlrealiser.wrapper.XmlWordElement

IGNORE_MODAL - Static variable in class simplenlg.features.InternalFeature

This flag is used to determine if the modal should be included in the verb phrase.

increment() - Method in class simplenlg.format.english.NumberedPrefix

InflectedWordElement - Class in simplenlg.framework

This class defines the NLGElement that is used to represent an word that requires inflection by the morphology.

InflectedWordElement(String, LexicalCategory) - Constructor for class simplenlg.framework.InflectedWordElement

Constructs a new inflected word using the giving word as the base form.

InflectedWordElement(WordElement) - Constructor for class simplenlg.framework.InflectedWordElement

Constructs a new inflected word from a WordElement

Inflection - Enum in simplenlg.features

An enumeration representing the different types of morphology patterns used by the basic morphology processor included with SimpleNLG.

initialise() - Method in class simplenlg.aggregation.Aggregator

Performs one-time initialisation of the module.

initialise() - Method in class simplenlg.aggregation.NewAggregator

initialise() - Method in class simplenlg.format.english.HTMLFormatter

initialise() - Method in class simplenlg.format.english.TextFormatter

initialise() - Method in class simplenlg.framework.NLGModule

Performs one-time initialisation of the module.

initialise() - Method in class simplenlg.morphology.english.MorphologyProcessor

initialise() - Method in class simplenlg.orthography.english.OrthographyProcessor

initialise() - Method in class simplenlg.realiser.english.Realiser

initialise() - Method in class simplenlg.syntax.english.SyntaxProcessor

INTENSIFIER - Static variable in class simplenlg.features.LexicalFeature

This flag determines if an adverb is an intensifier, such as very.

InternalFeature - Class in simplenlg.features

This class defines a list of features internally used within the SimpleNLG system.

INTERROGATIVE - Static variable in class simplenlg.features.InternalFeature

This flag determines if the sentence is interrogative or not.

INTERROGATIVE_TYPE - Static variable in class simplenlg.features.Feature

This feature determines the type of interrogative (question) used for the clause.

InterrogativeType - Enum in simplenlg.features

An enumeration representing the different types of interrogatives or questions that SimpleNLG can realise.

interrogativetype - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

INTRANSITIVE - Static variable in class simplenlg.features.LexicalFeature

This flag highlights a verb that can only take a subject and no objects.

IS_COMPARATIVE - Static variable in class simplenlg.features.Feature

This flag determines if the Adjective or Adverb should be inflected into the comparative form.

IS_SUPERLATIVE - Static variable in class simplenlg.features.Feature

This flag determines if the Adjective or Adverb should be inflected into the superlative form.

isA(ElementCategory) - Method in class simplenlg.framework.NLGElement

isADJECTIVEORDERING() - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Gets the value of the adjectiveordering property.

isAGGREGATEAUXILIARY() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the aggregateauxiliary property.

isAGGREGATEAUXILIARY() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the aggregateauxiliary property.

isAlwaysSearchAll() - Method in class simplenlg.lexicon.MultipleLexicon

isAPPOSITIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the appositive property.

isAppositive() - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Gets the value of the appositive property.

isCanned() - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Gets the value of the canned property.

isCommaSepCuephrase() - Method in class simplenlg.orthography.english.OrthographyProcessor

Check whether this processor separates cue phrases from a matrix phrase using a comma.

isCommaSepCuephrase() - Method in class simplenlg.realiser.english.Realiser

Check whether this processor separates cue phrases from the matrix clause using a comma.

isCommaSepPremodifiers() - Method in class simplenlg.orthography.english.OrthographyProcessor

Check whether this processor separates premodifiers using a comma.

isCommaSepPremodifiers() - Method in class simplenlg.realiser.english.Realiser

Check whether this processor separates premodifiers using a comma.

iscomparative - Variable in class simplenlg.xmlrealiser.wrapper.XmlAdjPhraseSpec

iscomparative - Variable in class simplenlg.xmlrealiser.wrapper.XmlAdvPhraseSpec

isELIDED() - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Gets the value of the elided property.

isEXPLETIVESUBJECT() - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Gets the value of the expletivesubject property.

isIndirectObject(Object) - Static method in enum simplenlg.features.InterrogativeType

A method to determine if the InterrogativeType is a question concerning an element with the discourse function of an indirect object.

isISCOMPARATIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlAdjPhraseSpec

Gets the value of the iscomparative property.

isISCOMPARATIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlAdvPhraseSpec

Gets the value of the iscomparative property.

isISSUPERLATIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlAdjPhraseSpec

Gets the value of the issuperlative property.

isISSUPERLATIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlAdvPhraseSpec

Gets the value of the issuperlative property.

isKeepStandardInflections() - Method in class simplenlg.lexicon.NIHDBLexicon

reports whether Words include standard (derivable) inflections

isNegated() - Method in class simplenlg.framework.NLGElement

Deprecated.

isNEGATED() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the negated property.

isNEGATED() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the negated property.

isNEGATED() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the negated property.

isObject(Object) - Static method in enum simplenlg.features.InterrogativeType

A method to determine if the InterrogativeType is a question concerning an element with the discourse function of an object.

isPASSIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the passive property.

isPASSIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the passive property.

isPERFECT() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the perfect property.

isPERFECT() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the perfect property.

isPlural() - Method in class simplenlg.framework.NLGElement

Determines if this element is to be treated as a plural.

isPOSSESSIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the possessive property.

isPOSSESSIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Gets the value of the possessive property.

isPROGRESSIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the progressive property.

isPROGRESSIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the progressive property.

isPROGRESSIVE() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the progressive property.

isPRONOMINAL() - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Gets the value of the pronominal property.

isPROPER() - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Gets the value of the proper property.

isRAISESPECIFIER() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the raisespecifier property.

issuperlative - Variable in class simplenlg.xmlrealiser.wrapper.XmlAdjPhraseSpec

issuperlative - Variable in class simplenlg.xmlrealiser.wrapper.XmlAdvPhraseSpec

isSUPPRESSGENITIVEINGERUND() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the suppressgenitiveingerund property.

isSUPPRESSGENITIVEINGERUND() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the suppressgenitiveingerund property.

isSUPRESSEDCOMPLEMENTISER() - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Gets the value of the supressedcomplementiser property.

isSUPRESSEDCOMPLEMENTISER() - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Gets the value of the supressedcomplementiser property.

isSUPRESSEDCOMPLEMENTISER() - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Gets the value of the supressedcomplementiser property.

L

leftPeriphery(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Collect a list of pairs of constituents with the same syntactic function from the left periphery of two sentences.

lemmaIdentical() - Method in class simplenlg.aggregation.FunctionalSet

lemmaIdentical() - Method in class simplenlg.aggregation.PhraseSet

Check whether the phrases are lemma identical.

LexicalCategory - Enum in simplenlg.framework

This enumeration defines the different lexical components.

LexicalFeature - Class in simplenlg.features

This class defines a list of constant values used by SimpleNLG lexicons.

lexicon - Variable in class simplenlg.framework.NLGModule

The lexicon that is to be used by this module.

Lexicon - Class in simplenlg.lexicon

This is the generic abstract class for a Lexicon.

Lexicon() - Constructor for class simplenlg.lexicon.Lexicon

LexiconInterface - Interface in simplenlg.lexicon

ListElement - Class in simplenlg.framework

ListElement is used to define elements that can be grouped together and treated in a similar manner.

ListElement() - Constructor for class simplenlg.framework.ListElement

Creates a new list element with no components.

ListElement(List<NLGElement>) - Constructor for class simplenlg.framework.ListElement

Creates a new list element containing the given components.

ListElement(NLGElement) - Constructor for class simplenlg.framework.ListElement

Creates a new list element containing the given component.

lookupWord(String, LexicalCategory) - Method in class simplenlg.lexicon.Lexicon

General word lookup method, tries base form, variant, ID (in this order) Creates new word if can't find existing word

lookupWord(String) - Method in class simplenlg.lexicon.Lexicon

General word lookup method, tries base form, variant, ID (in this order) Creates new word if can't find existing word

M

main(String[]) - Static method in class simplenlg.lexicon.util.NIHLexiconXMLDumpUtil

This main method reads a list of CSV words and POS tags and looks up against the NIHDB Lexicon for a corresponding entry.

main(String[]) - Static method in class simplenlg.server.SimpleServer

The main method that starts the server.

main(Object[]) - Static method in class simplenlg.xmlrealiser.XMLRealiser

The main method to perform realisation.

MODAL - Static variable in class simplenlg.features.Feature

The modal represents the modal auxiliary verb that is used in a verb phrase to express mood or tense.

modal - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

modal - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

modal - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

MorphologyProcessor - Class in simplenlg.morphology.english

This is the processor for handling morphology within the SimpleNLG.

MorphologyProcessor() - Constructor for class simplenlg.morphology.english.MorphologyProcessor

MorphologyRules - Class in simplenlg.morphology.english

This abstract class contains a number of rules for doing simple inflection.

MorphologyRules() - Constructor for class simplenlg.morphology.english.MorphologyRules

MultipleLexicon - Class in simplenlg.lexicon

This class contains a set of lexicons, which are searched in order for the specified word

MultipleLexicon() - Constructor for class simplenlg.lexicon.MultipleLexicon

create an empty multi lexicon

MultipleLexicon(Lexicon...) - Constructor for class simplenlg.lexicon.MultipleLexicon

create a multi lexicon with the specified lexicons

N

name - Variable in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

name - Variable in class simplenlg.xmlrealiser.wrapper.RecordSet

NEGATED - Static variable in class simplenlg.features.Feature

The flag determines if the corresponding verb phrase should be negated.

negated - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

negated - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

negated - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

NewAggregator - Class in simplenlg.aggregation

NewAggregator() - Constructor for class simplenlg.aggregation.NewAggregator

newInstance(DiscourseFunction, ElementCategory, Periphery, NLGElement...) - Static method in class simplenlg.aggregation.FunctionalSet

NIHDBLexicon - Class in simplenlg.lexicon

This class gets Words from the NIH Specialist Lexicon

NIHDBLexicon(String) - Constructor for class simplenlg.lexicon.NIHDBLexicon

set up lexicon using file which contains downloaded lexAccess HSQL DB and default passwords

NIHDBLexicon(String, String, String, String) - Constructor for class simplenlg.lexicon.NIHDBLexicon

set up lexicon using general DB parameters; DB must be NIH specialist lexicon from lexAccess

NIHLexiconXMLDumpUtil - Class in simplenlg.lexicon.util

This class reads in a CSV word list, looks up the words in the NIH lexicon, and writes the XML words into an output file.

NIHLexiconXMLDumpUtil() - Constructor for class simplenlg.lexicon.util.NIHLexiconXMLDumpUtil

NLGElement - Class in simplenlg.framework

NLGElement is the base class that all elements extend from.

NLGElement() - Constructor for class simplenlg.framework.NLGElement

NLGFactory - Class in simplenlg.framework

This class contains methods for creating syntactic phrases.

NLGFactory() - Constructor for class simplenlg.framework.NLGFactory

Creates a new phrase factory with no associated lexicon.

NLGFactory(Lexicon) - Constructor for class simplenlg.framework.NLGFactory

Creates a new phrase factory with the associated lexicon.

NLGModule - Class in simplenlg.framework

NLGModule is the base class that all processing modules extend from.

NLGModule() - Constructor for class simplenlg.framework.NLGModule

NLGSpec - Class in simplenlg.xmlrealiser.wrapper

Java class for anonymous complex type.

NLGSpec() - Constructor for class simplenlg.xmlrealiser.wrapper.NLGSpec

NON_MORPH - Static variable in class simplenlg.features.InternalFeature

nonePassive(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that no element of a give array of sentences is passive.

NPPhraseSpec - Class in simplenlg.phrasespec

This class defines a noun phrase.

NPPhraseSpec(NLGFactory) - Constructor for class simplenlg.phrasespec.NPPhraseSpec

NUMBER - Static variable in class simplenlg.features.Feature

This feature is used to determine if the element is to be represented in singular or plural form.

number - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

number - Variable in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

NumberAgreement - Enum in simplenlg.features

An enumeration representing the different types of number agreement.

NumberedPrefix - Class in simplenlg.format.english

This class keeps track of the prefix for numbered lists.

NumberedPrefix() - Constructor for class simplenlg.format.english.NumberedPrefix

O

ObjectFactory - Class in simplenlg.xmlrealiser.wrapper

This object contains factory methods for each Java content interface and Java element interface generated in the simplenlg.xmlrealiser.wrapper package.

ObjectFactory() - Constructor for class simplenlg.xmlrealiser.wrapper.ObjectFactory

Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: simplenlg.xmlrealiser.wrapper

OrthographyProcessor - Class in simplenlg.orthography.english

This processing module deals with punctuation when applied to DocumentElements.

OrthographyProcessor() - Constructor for class simplenlg.orthography.english.OrthographyProcessor

P

PARTICLE - Static variable in class simplenlg.features.Feature

This feature represents a particle used in conjunction with a verb.

PASSIVE - Static variable in class simplenlg.features.Feature

This flag shows if the phrase or clause should be written in the passive form.

passive - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

passive - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

PAST - Static variable in class simplenlg.features.LexicalFeature

This feature gives the past tense form of a verb.

PAST_PARTICIPLE - Static variable in class simplenlg.features.LexicalFeature

This feature gives the past participle tense form of a verb.

PERFECT - Static variable in class simplenlg.features.Feature

This flag shows if the phrase or clause should be written in the perfect form.

perfect - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

perfect - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Periphery - Enum in simplenlg.aggregation

PERSON - Static variable in class simplenlg.features.Feature

This feature represents the first-person, second-person or third-person nature of the phrase.

Person - Enum in simplenlg.features

This is an enumeration used to represent the point of view of the narrative.

person - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

person - Variable in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

person - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

person - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

PhraseCategory - Enum in simplenlg.framework

This enumeration defines the different syntactical phrases.

PhraseChecker - Class in simplenlg.aggregation

This class contains a number of utility methods for checking and collecting sentence components during the process of aggregation.

PhraseChecker() - Constructor for class simplenlg.aggregation.PhraseChecker

PhraseElement - Class in simplenlg.framework

This class defines a phrase.

PhraseElement(PhraseCategory) - Constructor for class simplenlg.framework.PhraseElement

Creates a new phrase of the given type.

PhraseSet - Class in simplenlg.aggregation

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.

PhraseSet(DiscourseFunction, NLGElement...) - Constructor for class simplenlg.aggregation.PhraseSet

Construct a set of compatible phrases and their function

PLURAL - Static variable in class simplenlg.features.LexicalFeature

This feature gives the plural form of a noun.

POSSESSIVE - Static variable in class simplenlg.features.Feature

This flag shows if the noun phrase should be written in the possessive form.

possessive - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

possessive - Variable in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

postMod - Variable in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

POSTMODIFIERS - Static variable in class simplenlg.features.InternalFeature

This feature represents the list of post-modifier elements.

PPPhraseSpec - Class in simplenlg.phrasespec

This class defines a prepositional phrase.

PPPhraseSpec(NLGFactory) - Constructor for class simplenlg.phrasespec.PPPhraseSpec

PREDICATIVE - Static variable in class simplenlg.features.LexicalFeature

This flag is set on adjectives that can also be used as a predicate.

preMod - Variable in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

PREMODIFIERS - Static variable in class simplenlg.features.InternalFeature

This feature represents the list of premodifier elements.

PRESENT3S - Static variable in class simplenlg.features.LexicalFeature

This feature gives the present third person singular form of a verb.

PRESENT_PARTICIPLE - Static variable in class simplenlg.features.LexicalFeature

This feature gives the present participle form of a verb.

printTree(String) - Method in class simplenlg.framework.CoordinatedPhraseElement

printTree(String) - Method in class simplenlg.framework.DocumentElement

printTree(String) - Method in class simplenlg.framework.InflectedWordElement

printTree(String) - Method in class simplenlg.framework.ListElement

printTree(String) - Method in class simplenlg.framework.NLGElement

printTree(String) - Method in class simplenlg.framework.PhraseElement

printTree(String) - Method in class simplenlg.framework.StringElement

printTree(String) - Method in class simplenlg.framework.WordElement

PROGRESSIVE - Static variable in class simplenlg.features.Feature

This flag determines if the verb phrase should be constructed in the progressive form.

progressive - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

progressive - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

progressive - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

PRONOMINAL - Static variable in class simplenlg.features.Feature

This flag can be set for noun phrases where it is desirable to overwrite the subject with a suitable pronoun.

pronominal - Variable in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

PROPER - Static variable in class simplenlg.features.LexicalFeature

This flag is used to determine whether a noun is a proper noun, such as a person's name.

proper - Variable in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Q

QUALITATIVE - Static variable in class simplenlg.features.LexicalFeature

This feature is used for determining the position of adjectives.

R

RAISE_SPECIFIER - Static variable in class simplenlg.features.Feature

This flag can be set when specifiers in a coordinated phrase should be raised.

RAISED - Static variable in class simplenlg.features.InternalFeature

This flag is used to define whether a noun phrase has had its specifier raised.

raisespecifier - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

realisation - Variable in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

RealisationRequest - Class in simplenlg.server

This class handles one realisation request.

RealisationRequest(Socket) - Constructor for class simplenlg.server.RealisationRequest

realise(NLGElement) - Method in class simplenlg.aggregation.Aggregator

Apply aggregation to a single phrase.

realise(List<NLGElement>) - Method in class simplenlg.aggregation.Aggregator

Apply aggregation to a list of elements.

realise(List<NLGElement>) - Method in class simplenlg.aggregation.NewAggregator

realise(NLGElement) - Method in class simplenlg.aggregation.NewAggregator

realise(NLGElement, NLGElement) - Method in class simplenlg.aggregation.NewAggregator

realise(NLGElement) - Method in class simplenlg.format.english.HTMLFormatter

realise(List<NLGElement>) - Method in class simplenlg.format.english.HTMLFormatter

realise(NLGElement) - Method in class simplenlg.format.english.TextFormatter

realise(List<NLGElement>) - Method in class simplenlg.format.english.TextFormatter

realise(NLGElement) - Method in class simplenlg.framework.NLGModule

Realises the given element.

realise(List<NLGElement>) - Method in class simplenlg.framework.NLGModule

Realises a List of NLGElements usually by iteratively calling the realise(NLGElement) method on each element in the list and adding the result into a new a List

realise(NLGElement) - Method in class simplenlg.morphology.english.MorphologyProcessor

realise(List<NLGElement>) - Method in class simplenlg.morphology.english.MorphologyProcessor

realise(NLGElement) - Method in class simplenlg.orthography.english.OrthographyProcessor

realise(List<NLGElement>) - Method in class simplenlg.orthography.english.OrthographyProcessor

realise(NLGElement) - Method in class simplenlg.realiser.english.Realiser

realise(List<NLGElement>) - Method in class simplenlg.realiser.english.Realiser

realise(NLGElement) - Method in class simplenlg.syntax.english.SyntaxProcessor

realise(List<NLGElement>) - Method in class simplenlg.syntax.english.SyntaxProcessor

realise(XmlDocumentElement) - Static method in class simplenlg.xmlrealiser.XMLRealiser

Realise.

REALISE_AUXILIARY - Static variable in class simplenlg.features.InternalFeature

This flag determines if auxiliary verbs should be realised in coordinated verb phrases.

Realiser - Class in simplenlg.realiser.english

Realiser() - Constructor for class simplenlg.realiser.english.Realiser

create a realiser (no lexicon)

Realiser(Lexicon) - Constructor for class simplenlg.realiser.english.Realiser

Create a realiser with a lexicon (should match lexicon used for NLGFactory)

realiseSentence(NLGElement) - Method in class simplenlg.realiser.english.Realiser

Convenience class to realise any NLGElement as a sentence

record - Variable in class simplenlg.xmlrealiser.wrapper.RecordSet

Recording - Class in simplenlg.xmlrealiser

A recording is a utility class that holds xml objects for testing the xmlrealiser.

Recording(String) - Constructor for class simplenlg.xmlrealiser.Recording

Instantiate a Recording from an XML file.

recording - Variable in class simplenlg.xmlrealiser.wrapper.NLGSpec

RecordingOn() - Method in class simplenlg.xmlrealiser.Recording

Recording on.

RecordSet - Class in simplenlg.xmlrealiser.wrapper

Java class for RecordSet complex type.

RecordSet() - Constructor for class simplenlg.xmlrealiser.wrapper.RecordSet

RECURSIVE - Static variable in class simplenlg.aggregation.AggregationHelper

REFLEXIVE - Static variable in class simplenlg.features.LexicalFeature

This flag is set if a pronoun is written in the reflexive form.

removeComponent(NLGElement) - Method in class simplenlg.framework.DocumentElement

Removes the specified component from the list of child components.

removeFeature(String) - Method in class simplenlg.framework.NLGElement

Deletes the named feature from the map.

request - Variable in class simplenlg.xmlrealiser.wrapper.NLGSpec

RequestType - Class in simplenlg.xmlrealiser.wrapper

Java class for RequestType complex type.

RequestType() - Constructor for class simplenlg.xmlrealiser.wrapper.RequestType

requiresAn(String) - Static method in class simplenlg.morphology.english.DeterminerAgrHelper

Check whether this string starts with a number that needs "an" (e.g.

rightPeriphery(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Collect a list of pairs of constituents with the same syntactic function from the right periphery of two sentences.

run() - Method in class simplenlg.server.RealisationRequest

run() - Method in class simplenlg.server.SimpleServer

Start the server.

S

sameFrontMods(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that the sentences supplied have identical front modifiers

samePostMods(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that some phrases have the same postmodifiers

sameSentences(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that the sentences supplied are identical

sameSubjects(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that the sentences supplied have identical subjects

sameSurfaceSubjects(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check whether the sentences have the same surface subjects, that is, they are either all active and have the same subjects, or all passive and have the same passive raising subjects.

sameVP(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that the sentences supplied have identical verb phrases

sameVPArgs(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that the sentences supplied have the same complements at VP level.

sameVPHead(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

Check that a list of sentences have the same verb

sameVPModifiers(NLGElement...) - Static method in class simplenlg.aggregation.PhraseChecker

check that the phrases supplied are sentences and have the same VP premodifiers and postmodifiers

SENTENCE_MODIFIER - Static variable in class simplenlg.features.LexicalFeature

This feature is used to define whether an adverb can be used as a clause modifier, which are normally applied at the beginning of clauses.

setAdjective(Object) - Method in class simplenlg.phrasespec.AdjPhraseSpec

sets the adjective (head) of the phrase

setADJECTIVEORDERING(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Sets the value of the adjectiveordering property.

setAdverb(Object) - Method in class simplenlg.phrasespec.AdvPhraseSpec

sets the adverb (head) of the phrase

setAGGREGATEAUXILIARY(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the aggregateauxiliary property.

setAGGREGATEAUXILIARY(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the aggregateauxiliary property.

setAlwaysSearchAll(boolean) - Method in class simplenlg.lexicon.MultipleLexicon

setAPPOSITIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the appositive property.

setAppositive(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Sets the value of the appositive property.

setBase(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Sets the value of the base property.

setBaseForm(String) - Method in class simplenlg.framework.WordElement

setBaseWord(WordElement) - Method in class simplenlg.framework.InflectedWordElement

Sets the base word for this element.

setCanned(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Sets the value of the canned property.

setCat(XmlPhraseCategory) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the cat property.

setCat(XmlDocumentCategory) - Method in class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

Sets the value of the cat property.

setCat(XmlPhraseCategory) - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Sets the value of the cat property.

setCat(XmlLexicalCategory) - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Sets the value of the cat property.

setCategory(ElementCategory) - Method in class simplenlg.framework.NLGElement

Sets the category of this element.

setCLAUSESTATUS(XmlClauseStatus) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the clausestatus property.

setCommaSepCuephrase(boolean) - Method in class simplenlg.orthography.english.OrthographyProcessor

If set to true, separates a cue phrase from the matrix phrase using a comma.

setCommaSepCuephrase(boolean) - Method in class simplenlg.realiser.english.Realiser

Set whether to separate cue phrases from the host phrase using a comma.

setCommaSepPremodifiers(boolean) - Method in class simplenlg.orthography.english.OrthographyProcessor

Set whether to separate premodifiers using a comma.

setCommaSepPremodifiers(boolean) - Method in class simplenlg.realiser.english.Realiser

Set whether to separate premodifiers using a comma.

setComplement(NLGElement) - Method in class simplenlg.framework.PhraseElement

Sets a complement of the phrase element.

setComplement(String) - Method in class simplenlg.framework.PhraseElement

Sets the complement to the phrase element.

setCOMPLEMENTISER(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the complementiser property.

setComponents(List<NLGElement>) - Method in class simplenlg.framework.DocumentElement

Replaces the existing components with the supplied list of components.

setComponents(List<NLGElement>) - Method in class simplenlg.framework.ListElement

Replaces the current components in the list element with the given list.

setConj(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the conj property.

setConjunction(String) - Method in class simplenlg.framework.CoordinatedPhraseElement

set the conjunction to be used in a coordinatedphraseelement

setCONJUNCTIONTYPE(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the conjunctiontype property.

setCuePhrase(XmlNLGElement) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the cuePhrase property.

setDebugMode(boolean) - Method in class simplenlg.realiser.english.Realiser

setDefaultInflectionalVariant(Inflection) - Method in class simplenlg.framework.WordElement

Set the default inflectional variant of a word.

setDefaultSpellingVariant(String) - Method in class simplenlg.framework.WordElement

Convenience method to set the default spelling variant of a word.

setDeterminer(Object) - Method in class simplenlg.framework.PhraseElement

Deprecated.

Use NPPhraseSpec.setSpecifier(Object) directly

setDeterminer(Object) - Method in class simplenlg.phrasespec.NPPhraseSpec

setDeterminer - Convenience method for when a person tries to set a determiner (e.g.

setDiscourseFunction(XmlDiscourseFunction) - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Sets the value of the discourseFunction property.

setDocument(XmlDocumentElement) - Method in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

Sets the value of the document property.

setDocument(XmlDocumentElement) - Method in class simplenlg.xmlrealiser.wrapper.RequestType

Sets the value of the document property.

setELIDED(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Sets the value of the elided property.

setEXPLETIVESUBJECT(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Sets the value of the expletivesubject property.

setFactory(NLGFactory) - Method in class simplenlg.aggregation.AggregationRule

Set the factory that the rule should use to create phrases.

setFactory(NLGFactory) - Method in class simplenlg.aggregation.Aggregator

Set the factory that this aggregator should use to create phrases.

setFactory(NLGFactory) - Method in class simplenlg.framework.NLGElement

setFeature(String, Object) - Method in class simplenlg.framework.NLGElement

Adds a feature to the feature map.

setFeature(String, boolean) - Method in class simplenlg.framework.NLGElement

A convenience method for setting boolean features.

setFeature(String, int) - Method in class simplenlg.framework.NLGElement

A convenience method for setting integer features.

setFeature(String, long) - Method in class simplenlg.framework.NLGElement

A convenience method for setting long integer features.

setFeature(String, float) - Method in class simplenlg.framework.NLGElement

A convenience method for setting floating point number features.

setFeature(String, double) - Method in class simplenlg.framework.NLGElement

A convenience method for setting double precision floating point number features.

setFeature(String, Object) - Method in class simplenlg.phrasespec.SPhraseSpec

adds a feature, possibly to the underlying VP as well as the SPhraseSpec itself

setFeature(String, boolean) - Method in class simplenlg.phrasespec.SPhraseSpec

setFeatures(WordElement) - Method in class simplenlg.framework.WordElement

Sets Features from another existing WordElement into this WordElement.

setFORM(XmlForm) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the form property.

setFORM(XmlForm) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the form property.

setFormatter(NLGModule) - Method in class simplenlg.realiser.english.Realiser

setFrontModifier(String) - Method in class simplenlg.framework.PhraseElement

Set the frontmodifier for this phrase.

setFrontModifier(NLGElement) - Method in class simplenlg.framework.PhraseElement

Set the front modifier for this phrase.

setGENDER(XmlGender) - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Sets the value of the gender property.

setHead(Object) - Method in class simplenlg.framework.PhraseElement

Sets the head, or main component, of this current phrase.

setHead(Object) - Method in class simplenlg.phrasespec.NPPhraseSpec

setHead(XmlWordElement) - Method in class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

Sets the value of the head property.

setId(String) - Method in class simplenlg.framework.WordElement

setId(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Sets the value of the id property.

setIndirectObject(Object) - Method in class simplenlg.phrasespec.SPhraseSpec

Set the indirect object of a clause (assumes this is the only direct indirect object)

setIndirectObject(Object) - Method in class simplenlg.phrasespec.VPPhraseSpec

Set the indirect object of a clause (assumes this is the only direct indirect object)

setINTERROGATIVETYPE(XmlInterrogativeType) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the interrogativetype property.

setISCOMPARATIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlAdjPhraseSpec

Sets the value of the iscomparative property.

setISCOMPARATIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlAdvPhraseSpec

Sets the value of the iscomparative property.

setISSUPERLATIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlAdjPhraseSpec

Sets the value of the issuperlative property.

setISSUPERLATIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlAdvPhraseSpec

Sets the value of the issuperlative property.

setKeepStandardInflections(boolean) - Method in class simplenlg.lexicon.NIHDBLexicon

set whether Words should include standard (derivable) inflections

setLexicon(Lexicon) - Method in class simplenlg.framework.NLGFactory

Sets the lexicon to be used by this factory.

setLexicon(Lexicon) - Method in class simplenlg.framework.NLGModule

Sets the lexicon to be used by this module.

setLexicon(Lexicon) - Method in class simplenlg.realiser.english.Realiser

setLexicon(XMLRealiser.LexiconType, String) - Static method in class simplenlg.xmlrealiser.XMLRealiser

Sets the lexicon.

setMODAL(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the modal property.

setMODAL(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the modal property.

setMODAL(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the modal property.

setName(String) - Method in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

Sets the value of the name property.

setName(String) - Method in class simplenlg.xmlrealiser.wrapper.RecordSet

Sets the value of the name property.

setNegated(boolean) - Method in class simplenlg.framework.NLGElement

Deprecated.

setNEGATED(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the negated property.

setNEGATED(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the negated property.

setNEGATED(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the negated property.

setNoun(Object) - Method in class simplenlg.phrasespec.NPPhraseSpec

sets the noun (head) of a noun phrase

setNUMBER(XmlNumberAgreement) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the number property.

setNUMBER(XmlNumberAgreement) - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Sets the value of the number property.

setObject(Object) - Method in class simplenlg.phrasespec.PPPhraseSpec

Sets the object of a PP

setObject(Object) - Method in class simplenlg.phrasespec.SPhraseSpec

Sets the direct object of a clause (assumes this is the only direct object)

setObject(Object) - Method in class simplenlg.phrasespec.VPPhraseSpec

Sets the direct object of a clause (assumes this is the only direct object)

setParent(NLGElement) - Method in class simplenlg.framework.NLGElement

Sets the parent element of this element.

setPASSIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the passive property.

setPASSIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the passive property.

setPERFECT(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the perfect property.

setPERFECT(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the perfect property.

setPERSON(XmlPerson) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the person property.

setPERSON(XmlPerson) - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Sets the value of the person property.

setPERSON(XmlPerson) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the person property.

setPERSON(XmlPerson) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the person property.

setPlural(boolean) - Method in class simplenlg.framework.NLGElement

Sets the number agreement on this element.

setPOSSESSIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the possessive property.

setPOSSESSIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Sets the value of the possessive property.

setPostModifier(String) - Method in class simplenlg.framework.PhraseElement

Set the postmodifier for this phrase.

setPostModifier(NLGElement) - Method in class simplenlg.framework.PhraseElement

Set the postmodifier for this phrase.

setPreModifier(String) - Method in class simplenlg.framework.PhraseElement

Set the premodifier for this phrase.

setPreModifier(NLGElement) - Method in class simplenlg.framework.PhraseElement

Set the premodifier for this phrase.

setPreposition(Object) - Method in class simplenlg.phrasespec.PPPhraseSpec

sets the preposition (head) of a prepositional phrase

setPROGRESSIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the progressive property.

setPROGRESSIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the progressive property.

setPROGRESSIVE(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the progressive property.

setPRONOMINAL(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Sets the value of the pronominal property.

setPROPER(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Sets the value of the proper property.

setRAISESPECIFIER(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the raisespecifier property.

setRealisation(String) - Method in class simplenlg.framework.NLGElement

Sets the realisation of this element.

setRealisation(String) - Method in class simplenlg.xmlrealiser.wrapper.DocumentRealisation

Sets the value of the realisation property.

setRecording(RecordSet) - Method in class simplenlg.xmlrealiser.wrapper.NLGSpec

Sets the value of the recording property.

setRequest(RequestType) - Method in class simplenlg.xmlrealiser.wrapper.NLGSpec

Sets the value of the request property.

setSpec(XmlNLGElement) - Method in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

Sets the value of the spec property.

setSpecifier(Object) - Method in class simplenlg.phrasespec.NPPhraseSpec

sets the specifier of a noun phrase.

setSubject(Object) - Method in class simplenlg.phrasespec.SPhraseSpec

Sets the subject of a clause (assumes this is the only subject)

setSUPPRESSGENITIVEINGERUND(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the suppressgenitiveingerund property.

setSUPPRESSGENITIVEINGERUND(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the suppressgenitiveingerund property.

setSUPRESSEDCOMPLEMENTISER(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the supressedcomplementiser property.

setSUPRESSEDCOMPLEMENTISER(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the supressedcomplementiser property.

setSUPRESSEDCOMPLEMENTISER(Boolean) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the supressedcomplementiser property.

setTense(Tense) - Method in class simplenlg.framework.NLGElement

Deprecated.

setTENSE(XmlTense) - Method in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

Sets the value of the tense property.

setTENSE(XmlTense) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the tense property.

setTENSE(XmlTense) - Method in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

Sets the value of the tense property.

setTitle(String) - Method in class simplenlg.framework.DocumentElement

Sets the title of this element.

setTitle(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

Sets the value of the title property.

setVal(String) - Method in class simplenlg.xmlrealiser.wrapper.XmlStringElement

Sets the value of the val property.

setVar(XmlInflection) - Method in class simplenlg.xmlrealiser.wrapper.XmlWordElement

Sets the value of the var property.

setVerb(Object) - Method in class simplenlg.phrasespec.SPhraseSpec

Set the verb of a clause

setVerb(Object) - Method in class simplenlg.phrasespec.VPPhraseSpec

sets the verb (head) of a verb phrase.

setVerbPhrase(NLGElement) - Method in class simplenlg.phrasespec.SPhraseSpec

setVp(XmlNLGElement) - Method in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

Sets the value of the vp property.

shutdown() - Method in class simplenlg.server.SimpleServer

Perform shutdown routines.

simplenlg.aggregation - package simplenlg.aggregation

simplenlg.features - package simplenlg.features

simplenlg.format.english - package simplenlg.format.english

simplenlg.framework - package simplenlg.framework

simplenlg.lexicon - package simplenlg.lexicon

simplenlg.lexicon.util - package simplenlg.lexicon.util

simplenlg.morphology.english - package simplenlg.morphology.english

simplenlg.orthography.english - package simplenlg.orthography.english

simplenlg.phrasespec - package simplenlg.phrasespec

simplenlg.realiser.english - package simplenlg.realiser.english

simplenlg.server - package simplenlg.server

simplenlg.syntax.english - package simplenlg.syntax.english

simplenlg.xmlrealiser - package simplenlg.xmlrealiser

simplenlg.xmlrealiser.wrapper - package simplenlg.xmlrealiser.wrapper

SimpleServer - Class in simplenlg.server

SimpleServer is a program that realises xml requests.

SimpleServer(int) - Constructor for class simplenlg.server.SimpleServer

Construct a new server.

SimpleServer(ServerSocket) - Constructor for class simplenlg.server.SimpleServer

Construct a server with a pre-allocated socket.

size() - Method in class simplenlg.framework.ListElement

Retrieves the number of components in this list element.

spec - Variable in class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

SPECIFIER - Static variable in class simplenlg.features.InternalFeature

This feature contains the specifier for a noun phrase.

SPELL_VARS - Static variable in class simplenlg.features.LexicalFeature

This feature is used to specify the spelling variants of a word.

SPhraseSpec - Class in simplenlg.phrasespec

This class defines a clause (sentence-like phrase).

SPhraseSpec(NLGFactory) - Constructor for class simplenlg.phrasespec.SPhraseSpec

create an empty clause

start() - Method in class simplenlg.xmlrealiser.Recording

Start.

startRecording(String) - Static method in class simplenlg.xmlrealiser.XMLRealiser

Start recording.

stopRecording() - Static method in class simplenlg.xmlrealiser.XMLRealiser

Stop recording.

StringElement - Class in simplenlg.framework

This class defines an element for representing canned text within the SimpleNLG library.

StringElement(String) - Constructor for class simplenlg.framework.StringElement

Constructs a new string element representing some canned text.

subj - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

SUBJECTS - Static variable in class simplenlg.features.InternalFeature

This feature represents the list of subjects in a clause.

SUPERLATIVE - Static variable in class simplenlg.features.LexicalFeature

This feature gives the superlative form for adjectives and adverbs.

SUPPRESS_GENITIVE_IN_GERUND - Static variable in class simplenlg.features.Feature

This flag is set when it is necessary to suppress the genitive when dealing with gerund forms.

suppressgenitiveingerund - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

suppressgenitiveingerund - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

SUPRESSED_COMPLEMENTISER - Static variable in class simplenlg.features.Feature

This flag determines if complementisers in subordinating clauses should be suppressed.

supressedcomplementiser - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

supressedcomplementiser - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

supressedcomplementiser - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

SyntaxProcessor - Class in simplenlg.syntax.english

This is the processor for handling syntax within the SimpleNLG.

SyntaxProcessor() - Constructor for class simplenlg.syntax.english.SyntaxProcessor

T

TENSE - Static variable in class simplenlg.features.Feature

This flag represents the tense or temporal quality of a verb.

Tense - Enum in simplenlg.features

An enumeration representing the different types of temporal sense that can be applied to a verb.

tense - Variable in class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

tense - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

tense - Variable in class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

terminate() - Method in class simplenlg.server.SimpleServer

Terminate the server.

TextFormatter - Class in simplenlg.format.english

This processing module adds some simple plain text formatting to the SimpleNLG output.

TextFormatter() - Constructor for class simplenlg.format.english.TextFormatter

title - Variable in class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

toString() - Method in class simplenlg.aggregation.FunctionalSet

toString() - Method in class simplenlg.framework.InflectedWordElement

toString() - Method in class simplenlg.framework.ListElement

toString() - Method in class simplenlg.framework.NLGElement

toString() - Method in class simplenlg.framework.StringElement

toString() - Method in class simplenlg.framework.WordElement

toXML() - Method in class simplenlg.framework.WordElement

TRANSITIVE - Static variable in class simplenlg.features.LexicalFeature

This flag highlights a verb that can only take a subject and an object.

U

UnwrapCoordinatePhraseSpec(XmlNLGElement) - Method in class simplenlg.xmlrealiser.UnWrapper

Unwraps a coordinate phrase.

UnwrapDocumentElement(XmlDocumentElement) - Method in class simplenlg.xmlrealiser.UnWrapper

Create simplenlg objects from wrapper objects.

UnwrapNLGElement(XmlNLGElement) - Method in class simplenlg.xmlrealiser.UnWrapper

Unwrap a simplenlg.xmlrealiser.wrapper.NLGElement and map it to a simplenlg.framework.NLGElement

UnWrapper - Class in simplenlg.xmlrealiser

UnWrapper maps from classes generated by xjc from RealizerSchema.xsd to SimpleNLG classes.

UnWrapper(Lexicon) - Constructor for class simplenlg.xmlrealiser.UnWrapper

Initialise an UnWrapper with a lexicon.

UnwrapPhraseComponents(PhraseElement, XmlNLGElement) - Method in class simplenlg.xmlrealiser.UnWrapper

Unwrap the common phrase components (premodifiers, postmodifiers etc) that any simplenlg.xmlrealiser.wrapper.NLGElement can have, and map it to a simplenlg.framework.NLGElement

upALevel() - Method in class simplenlg.format.english.NumberedPrefix

This method starts a new level to the prefix (e.g., 1.1 if the current is 1, 2.3.1 if current is 2.3, or 1 if the current is 0).

V

val - Variable in class simplenlg.xmlrealiser.wrapper.XmlStringElement

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlClauseStatus

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlDiscourseFunction

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlDocumentCategory

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlForm

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlGender

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlInflection

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlInterrogativeType

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlLexicalCategory

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlNumberAgreement

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlPerson

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlPhraseCategory

value() - Method in enum simplenlg.xmlrealiser.wrapper.XmlTense

valueOf(String) - Static method in enum simplenlg.aggregation.Periphery

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.ClauseStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.DiscourseFunction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.Form

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.Gender

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.Inflection

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.InterrogativeType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.NumberAgreement

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.Person

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.features.Tense

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.framework.DocumentCategory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.framework.LexicalCategory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.framework.PhraseCategory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlClauseStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlDiscourseFunction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlDocumentCategory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlForm

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlGender

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlInflection

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlInterrogativeType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlLexicalCategory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlNumberAgreement

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlPerson

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlPhraseCategory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.wrapper.XmlTense

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.XMLRealiser.LexiconType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum simplenlg.xmlrealiser.XMLRealiser.OpCode

Returns the enum constant of this type with the specified name.

values() - Static method in enum simplenlg.aggregation.Periphery

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.ClauseStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.DiscourseFunction

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.Form

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.Gender

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.Inflection

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.InterrogativeType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.NumberAgreement

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.Person

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.features.Tense

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.framework.DocumentCategory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.framework.LexicalCategory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.framework.PhraseCategory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlClauseStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlDiscourseFunction

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlDocumentCategory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlForm

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlGender

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlInflection

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlInterrogativeType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlLexicalCategory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlNumberAgreement

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlPerson

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlPhraseCategory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.wrapper.XmlTense

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.XMLRealiser.LexiconType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum simplenlg.xmlrealiser.XMLRealiser.OpCode

Returns an array containing the constants of this enum type, in the order they are declared.

var - Variable in class simplenlg.xmlrealiser.wrapper.XmlWordElement

VERB_MODIFIER - Static variable in class simplenlg.features.LexicalFeature

This feature is used to define whether an adverb can be used as a verb modifier, which are normally added in a phrase before the verb itself.

VERB_PHRASE - Static variable in class simplenlg.features.InternalFeature

This feature represents the verb phrase in a clause.

vp - Variable in class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

VPPhraseSpec - Class in simplenlg.phrasespec

This class defines a verb phrase.

VPPhraseSpec(NLGFactory) - Constructor for class simplenlg.phrasespec.VPPhraseSpec

create an empty clause

W

WordElement - Class in simplenlg.framework

This is the class for a lexical entry (ie, a word).

WordElement() - Constructor for class simplenlg.framework.WordElement

empty constructor

WordElement(String) - Constructor for class simplenlg.framework.WordElement

create a WordElement with the specified baseForm (no category or ID specified)

WordElement(String, LexicalCategory) - Constructor for class simplenlg.framework.WordElement

create a WordElement with the specified baseForm and category

WordElement(String, LexicalCategory, String) - Constructor for class simplenlg.framework.WordElement

create a WordElement with the specified baseForm, category, ID

WordElement(WordElement) - Constructor for class simplenlg.framework.WordElement

creates a duplicate WordElement from an existing WordElement

writeRecording(RecordSet, OutputStream) - Static method in class simplenlg.xmlrealiser.Recording

Write recording.

X

XmlAdjPhraseSpec - Class in simplenlg.xmlrealiser.wrapper

Java class for AdjPhraseSpec complex type.

XmlAdjPhraseSpec() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlAdjPhraseSpec

XmlAdvPhraseSpec - Class in simplenlg.xmlrealiser.wrapper

Java class for AdvPhraseSpec complex type.

XmlAdvPhraseSpec() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlAdvPhraseSpec

XmlClauseStatus - Enum in simplenlg.xmlrealiser.wrapper

Java class for clauseStatus.

XmlCoordinatedPhraseElement - Class in simplenlg.xmlrealiser.wrapper

Java class for CoordinatedPhraseElement complex type.

XmlCoordinatedPhraseElement() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlCoordinatedPhraseElement

XmlDiscourseFunction - Enum in simplenlg.xmlrealiser.wrapper

Java class for discourseFunction.

XmlDocumentCategory - Enum in simplenlg.xmlrealiser.wrapper

Java class for documentCategory.

XmlDocumentElement - Class in simplenlg.xmlrealiser.wrapper

Java class for DocumentElement complex type.

XmlDocumentElement() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlDocumentElement

XmlForm - Enum in simplenlg.xmlrealiser.wrapper

Java class for form.

XmlGender - Enum in simplenlg.xmlrealiser.wrapper

Java class for gender.

XmlInflection - Enum in simplenlg.xmlrealiser.wrapper

Java class for inflection.

XmlInterrogativeType - Enum in simplenlg.xmlrealiser.wrapper

Java class for interrogativeType.

XmlLexicalCategory - Enum in simplenlg.xmlrealiser.wrapper

Java class for lexicalCategory.

XMLLexicon - Class in simplenlg.lexicon

This class loads words from an XML lexicon.

XMLLexicon(String) - Constructor for class simplenlg.lexicon.XMLLexicon

Load an XML Lexicon from a named file

XMLLexicon(File) - Constructor for class simplenlg.lexicon.XMLLexicon

Load an XML Lexicon from a File

XMLLexicon(URI) - Constructor for class simplenlg.lexicon.XMLLexicon

Load an XML Lexicon from a URI

XMLLexicon() - Constructor for class simplenlg.lexicon.XMLLexicon

XmlNLGElement - Class in simplenlg.xmlrealiser.wrapper

Java class for NLGElement complex type.

XmlNLGElement() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlNLGElement

XmlNPPhraseSpec - Class in simplenlg.xmlrealiser.wrapper

Java class for NPPhraseSpec complex type.

XmlNPPhraseSpec() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlNPPhraseSpec

XmlNumberAgreement - Enum in simplenlg.xmlrealiser.wrapper

Java class for numberAgreement.

XmlPerson - Enum in simplenlg.xmlrealiser.wrapper

Java class for person.

XmlPhraseCategory - Enum in simplenlg.xmlrealiser.wrapper

Java class for phraseCategory.

XmlPhraseElement - Class in simplenlg.xmlrealiser.wrapper

Java class for PhraseElement complex type.

XmlPhraseElement() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlPhraseElement

XmlPPPhraseSpec - Class in simplenlg.xmlrealiser.wrapper

Java class for PPPhraseSpec complex type.

XmlPPPhraseSpec() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlPPPhraseSpec

XMLRealiser - Class in simplenlg.xmlrealiser

The Class XMLRealiser.

XMLRealiser() - Constructor for class simplenlg.xmlrealiser.XMLRealiser

XMLRealiser.LexiconType - Enum in simplenlg.xmlrealiser

The Enum LexiconType.

XMLRealiser.OpCode - Enum in simplenlg.xmlrealiser

The Enum OpCode.

XMLRealiserException - Class in simplenlg.xmlrealiser

This class represents an exception thrown by the xml realiser framework.

XMLRealiserException() - Constructor for class simplenlg.xmlrealiser.XMLRealiserException

Instantiates a new xML realiser exception.

XMLRealiserException(String) - Constructor for class simplenlg.xmlrealiser.XMLRealiserException

Instantiates a new xML realiser exception.

XMLRealiserException(Throwable) - Constructor for class simplenlg.xmlrealiser.XMLRealiserException

Instantiates a new xML realiser exception.

XMLRealiserException(String, Throwable) - Constructor for class simplenlg.xmlrealiser.XMLRealiserException

Instantiates a new xML realiser exception.

XmlSPhraseSpec - Class in simplenlg.xmlrealiser.wrapper

Java class for SPhraseSpec complex type.

XmlSPhraseSpec() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlSPhraseSpec

XmlStringElement - Class in simplenlg.xmlrealiser.wrapper

Java class for StringElement complex type.

XmlStringElement() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlStringElement

XmlTense - Enum in simplenlg.xmlrealiser.wrapper

Java class for tense.

XmlVPPhraseSpec - Class in simplenlg.xmlrealiser.wrapper

Java class for VPPhraseSpec complex type.

XmlVPPhraseSpec() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlVPPhraseSpec

XmlWordElement - Class in simplenlg.xmlrealiser.wrapper

Java class for WordElement complex type.

XmlWordElement() - Constructor for class simplenlg.xmlrealiser.wrapper.XmlWordElement

A B C D E F G H I L M N O P Q R S T U V W X