simplenlg.orthography.english

Class OrthographyProcessor

java.lang.Object

simplenlg.framework.NLGModule

simplenlg.orthography.english.OrthographyProcessor

public class OrthographyProcessor
extends NLGModule

This processing module deals with punctuation when applied to DocumentElements. The punctuation currently handled by this processor includes the following (as of version 4.0):

• Capitalisation of the first letter in sentences.
• Termination of sentences with a period if not interrogative.
• Termination of sentences with a question mark if they are interrogative.
• Replacement of multiple conjunctions with a comma. For example, John and Peter and Simon becomes John, Peter and Simon.

Version:

4.0

Author:

D. Westwater, University of Aberdeen.

Field Summary

Fields inherited from class simplenlg.framework.NLGModule

lexicon

Constructor Summary

Constructors

Constructor and Description
OrthographyProcessor()

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 a matrix phrase 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.
void	setCommaSepCuephrase(boolean commaSepCuephrase) If set to true, separates a cue phrase from the matrix phrase using a comma.
void	setCommaSepPremodifiers(boolean commaSepPremodifiers) Set whether to separate premodifiers using a comma.

Methods inherited from class simplenlg.framework.NLGModule

getLexicon, setLexicon

Methods inherited from class java.lang.Object

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

Constructor Detail

OrthographyProcessor

public OrthographyProcessor()

Method Detail

initialise

public void initialise()

Description copied from class: NLGModule

Performs one-time initialisation of the module.

Specified by:

initialise in class NLGModule

isCommaSepPremodifiers

public boolean isCommaSepPremodifiers()

Check whether this processor separates premodifiers using a comma.

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.

Parameters:

commaSepPremodifiers - the commaSepPremodifiers to set

isCommaSepCuephrase

public boolean isCommaSepCuephrase()

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

Returns:

true if this parameter is set.

setCommaSepCuephrase

public void setCommaSepCuephrase(boolean commaSepCuephrase)

If set to true, separates a cue phrase from the matrix phrase using a comma. Cue phrases are typically at the start of a sentence (e.g. However, John left early). This will only apply to phrases with the feature DiscourseFunction.CUE_PHRASE or DiscourseFunction.FRONT_MODIFIER.

Parameters:

commaSepCuephrase - whether to separate cue phrases using a comma

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.

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.