mt.edu.um.nlgapp
Class NLGApplication

java.lang.Object
  extended by mt.edu.um.nlgapp.NLGApplication

public abstract class NLGApplication
extends java.lang.Object

This is the class for an NLG application. It requires an document planner, a microplanner and a realiser.

Author:
bertugatt

Constructor Summary
NLGApplication()
          Default (empty) constructor
NLGApplication(DocPlanner dp, Microplanner mp, NLGRealiser r)
          Constructor with parameters
 
Method Summary
 java.lang.String generate(uk.ac.abdn.carados.OntologyHandler ontology)
          This is the principal method to generate a text, and models the generation pipeline.
 DocPlanner getDocplanner()
           
 Microplanner getMicroplanner()
           
 NLGRealiser getRealiser()
           
 void setDocplanner(DocPlanner docplanner)
           
 void setMicroplanner(Microplanner microplanner)
           
 void setRealiser(NLGRealiser realiser)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NLGApplication

public NLGApplication()
Default (empty) constructor


NLGApplication

public NLGApplication(DocPlanner dp,
                      Microplanner mp,
                      NLGRealiser r)
Constructor with parameters

Parameters:
dp - the doc planner
mp - the microplanner
r - the realiser
Method Detail

getDocplanner

public DocPlanner getDocplanner()
Returns:
the docplanner

setDocplanner

public void setDocplanner(DocPlanner docplanner)
Parameters:
docplanner - the docplanner to set

getMicroplanner

public Microplanner getMicroplanner()
Returns:
the microplanner

setMicroplanner

public void setMicroplanner(Microplanner microplanner)
Parameters:
microplanner - the microplanner to set

getRealiser

public NLGRealiser getRealiser()
Returns:
the realiser

setRealiser

public void setRealiser(NLGRealiser realiser)
Parameters:
realiser - the realiser to set

generate

public java.lang.String generate(uk.ac.abdn.carados.OntologyHandler ontology)
This is the principal method to generate a text, and models the generation pipeline. Starting from an ontology, it (a) plans the document and selects content; (b) passes the result to the microplanner; (c) ralises the result as a string.

Parameters:
ontology - the ontology containing the instances or messages
Returns:
a string representing the document.