mt.edu.um.microplan
Class NLGRealiser

java.lang.Object
  extended by mt.edu.um.microplan.NLGRealiser

public abstract class NLGRealiser
extends java.lang.Object

This interface defines the API for a realiser. A realiser should take a mt.edu.um.docplan.DocPlan, after the Microplanner.microplanDoc(mt.edu.um.nlgapp.docplan.DocPlan) has been called, and map each of its messages to a String.

Author:
bertugatt

Constructor Summary
NLGRealiser(simplenlg.framework.NLGFactory factory, simplenlg.realiser.english.Realiser realiser)
          Constructor: The NLGRealiser needs a NLGFactory to construct phrases and a Realiser to turn the phrases into Strings.
 
Method Summary
abstract  java.lang.String realiseDoc(DocPlan doc)
          This is the principal method in the NLGRealiser.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NLGRealiser

public NLGRealiser(simplenlg.framework.NLGFactory factory,
                   simplenlg.realiser.english.Realiser realiser)
Constructor: The NLGRealiser needs a NLGFactory to construct phrases and a Realiser to turn the phrases into Strings.

Parameters:
factory - The NLGFactory
realiser - the realiser
Method Detail

realiseDoc

public abstract java.lang.String realiseDoc(DocPlan doc)
This is the principal method in the NLGRealiser. It takes a plan, whose nodes have been micro-planned, and returns the String representing the document.

Parameters:
doc - the doc plan, whose nodes have lexical templates
Returns:
the text itself