simplenlg.format.english

Class TextFormatter

java.lang.Object

simplenlg.framework.NLGModule

simplenlg.format.english.TextFormatter

public class TextFormatter
extends NLGModule

This processing module adds some simple plain text formatting to the SimpleNLG output. This includes the following:

• Adding the document title to the beginning of the text.
• Adding section titles in the relevant places.
• Adding appropriate new line breaks for ease-of-reading.
• Adding list items with ' * '.
• Adding numbers for enumerated lists (e.g., "1.1 - ", "1.2 - ", etc.)

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
TextFormatter()

Method Summary

Modifier and Type	Method and Description
void	initialise() Performs one-time initialisation of the module.
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.

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

TextFormatter

public TextFormatter()

Method Detail

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.

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.