simplenlg.realiser.english

Class Realiser

java.lang.Object

simplenlg.framework.NLGModule

simplenlg.realiser.english.Realiser

public class Realiser
extends NLGModule

Author:

D. Westwater, Data2Text Ltd

Field Summary

Fields inherited from class simplenlg.framework.NLGModule

lexicon

Constructor Summary

Constructors

Constructor and Description
Realiser() create a realiser (no lexicon)
Realiser(Lexicon lexicon) Create a realiser with a lexicon (should match lexicon used for NLGFactory)

Method Summary

Modifier and Type	Method and Description
void	initialise() Performs one-time initialisation of the module.
boolean	isCommaSepCuephrase() Check whether this processor separates cue phrases from the matrix clause using a comma.
boolean	isCommaSepPremodifiers() Check whether this processor separates premodifiers using a comma.
List<NLGElement>	realise(List<NLGElement> elements) 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
NLGElement	realise(NLGElement element) Realises the given element.
String	realiseSentence(NLGElement element) Convenience class to realise any NLGElement as a sentence
void	setCommaSepCuephrase(boolean commaSepCuephrase) Set whether to separate cue phrases from the host phrase using a comma.
void	setCommaSepPremodifiers(boolean commaSepPremodifiers) Set whether to separate premodifiers using a comma.
void	setDebugMode(boolean debugOn)
void	setFormatter(NLGModule formatter)
void	setLexicon(Lexicon newLexicon) Sets the lexicon to be used by this module.

Methods inherited from class simplenlg.framework.NLGModule

getLexicon

Methods inherited from class java.lang.Object

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

Constructor Detail

Realiser

public Realiser()

create a realiser (no lexicon)

Realiser

public Realiser(Lexicon lexicon)

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

Method Detail

isCommaSepPremodifiers

public boolean isCommaSepPremodifiers()

Check whether this processor separates premodifiers using a comma.

Implementation note: this method checks whether the OrthographyProcessor has the parameter set.

Returns:

true if premodifiers in the noun phrase are comma-separated.

setCommaSepPremodifiers

public void setCommaSepPremodifiers(boolean commaSepPremodifiers)

Set whether to separate premodifiers using a comma. If true, premodifiers will be comma-separated, as in the long, dark road. If false, they won't.
Implementation note:: this method sets the relevant parameter in the OrthographyProcessor.

Parameters:

commaSepPremodifiers - the commaSepPremodifiers to set

isCommaSepCuephrase

public boolean isCommaSepCuephrase()

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

Implementation note: this method checks whether the OrthographyProcessor has the parameter set.

Returns:

true if cue phrases have a comma before the remainder of the host phrase

setCommaSepCuephrase

public void setCommaSepCuephrase(boolean commaSepCuephrase)

Set whether to separate cue phrases from the host phrase using a comma. If true, a comma will be inserted, as in however, Bill arrived late. If false, they won't.
Implementation note:: this method sets the relevant parameter in the OrthographyProcessor.

initialise

public void initialise()

Description copied from class: NLGModule

Performs one-time initialisation of the module.

Specified by:

initialise in class NLGModule

realise

public NLGElement realise(NLGElement element)

Description copied from class: NLGModule

Realises the given element. This call is usually recursive as the call processes the child elements of the given element.

Specified by:

realise in class NLGModule

Parameters:

element - the NLGElement to be realised.

Returns:

the NLGElement representing the realised state. This may be the initial element in a changed form or be a completely new element.

realiseSentence

public String realiseSentence(NLGElement element)

Convenience class to realise any NLGElement as a sentence

Returns:

String realisation of the NLGElement

realise

public List<NLGElement> realise(List<NLGElement> elements)

Description copied from class: 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

Specified by:

realise in class NLGModule

Parameters:

elements - the List of NLGElements to be realised.

Returns:

the List of realised NLGElements.

setLexicon

public void setLexicon(Lexicon newLexicon)

Description copied from class: NLGModule

Sets the lexicon to be used by this module. Passing in null will remove the existing lexicon and no lexicon will be used.

Overrides:

setLexicon in class NLGModule

Parameters:

newLexicon - the new Lexicon to be used.

setFormatter

public void setFormatter(NLGModule formatter)

setDebugMode

public void setDebugMode(boolean debugOn)