simplenlg.xmlrealiser

Class UnWrapper

java.lang.Object

simplenlg.xmlrealiser.UnWrapper

public class UnWrapper
extends Object

UnWrapper maps from classes generated by xjc from RealizerSchema.xsd to SimpleNLG classes. There are classes of the same name in two packages. The xjc wrapper classes are in the simplenlg.xmlrealiser.wrapper package, and are prefixed with the package name. The real simplenlg classes are referenced without package name prefix.

Author:

Christopher Howell Agfa Healthcare Corporation, Albert Gatt, University of Malta

Constructor Summary

Constructors

Constructor and Description
UnWrapper(Lexicon lexicon) Initialise an UnWrapper with a lexicon.

Method Summary

Modifier and Type	Method and Description
static NLGSpec	getNLGSpec(Reader xmlReader) Create wrapper objects from xml for a request to realise, or the xml for a recording.
NLGElement	UnwrapCoordinatePhraseSpec(XmlNLGElement wps) Unwraps a coordinate phrase.
DocumentElement	UnwrapDocumentElement(XmlDocumentElement wt) Create simplenlg objects from wrapper objects.
NLGElement	UnwrapNLGElement(XmlNLGElement wps) Unwrap a simplenlg.xmlrealiser.wrapper.NLGElement and map it to a simplenlg.framework.NLGElement
void	UnwrapPhraseComponents(PhraseElement hp, XmlNLGElement wps) Unwrap the common phrase components (premodifiers, postmodifiers etc) that any simplenlg.xmlrealiser.wrapper.NLGElement can have, and map it to a simplenlg.framework.NLGElement

Methods inherited from class java.lang.Object

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

Constructor Detail

UnWrapper

public UnWrapper(Lexicon lexicon)

Initialise an UnWrapper with a lexicon.

Parameters:

lexicon - the lexicon to use

Method Detail

getNLGSpec

public static NLGSpec getNLGSpec(Reader xmlReader)
                          throws XMLRealiserException

Create wrapper objects from xml for a request to realise, or the xml for a recording. Both are elements of NLGSpec.

Parameters:

xmlReader - the xml reader

Returns:

the nLG spec

Throws:

XMLRealiserException - the xML realiser exception

UnwrapDocumentElement

public DocumentElement UnwrapDocumentElement(XmlDocumentElement wt)

Create simplenlg objects from wrapper objects.

Parameters:

wt - the wrapper DocumentElement object

Returns:

the document element

UnwrapNLGElement

public NLGElement UnwrapNLGElement(XmlNLGElement wps)

Unwrap a simplenlg.xmlrealiser.wrapper.NLGElement and map it to a simplenlg.framework.NLGElement

Parameters:

wps - The wrapper object

Returns:

the NLGElement

UnwrapPhraseComponents

public void UnwrapPhraseComponents(PhraseElement hp,
                                   XmlNLGElement wps)

Unwrap the common phrase components (premodifiers, postmodifiers etc) that any simplenlg.xmlrealiser.wrapper.NLGElement can have, and map it to a simplenlg.framework.NLGElement

Parameters:

hp - the simplenlg.framework.NLGElement which is cuurrently being constructed

wps - The wrapper object

UnwrapCoordinatePhraseSpec

public NLGElement UnwrapCoordinatePhraseSpec(XmlNLGElement wps)

Unwraps a coordinate phrase.

Parameters:

wps - the simplenlg.xmlrealiser.wrapper.NLGElement representing the phrase

Returns:

a simplenlg.framework.CoordinatedPhraseElement or null if the wrapper element is not a coordinate phrase.