simplenlg.xmlrealiser

Class Recording

java.lang.Object

simplenlg.xmlrealiser.Recording

public class Recording
extends Object

A recording is a utility class that holds xml objects for testing the xmlrealiser.

Author:

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

Constructor Summary

Constructors

Constructor and Description
Recording(String directoryPath) Instantiate a Recording from an XML file.

Method Summary

Modifier and Type	Method and Description
void	addRecord(XmlDocumentElement input, String output) Adds a record to this recording.
void	finish() Ends processing for this recording and writes it to an XML file.
String	GetRecordingFile() Gets the recording file.
boolean	RecordingOn() Recording on.
void	start() Start.
static void	writeRecording(RecordSet record, OutputStream os) Write recording.

Methods inherited from class java.lang.Object

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

Constructor Detail

Recording

public Recording(String directoryPath)

Instantiate a Recording from an XML file. Recordings can contain multiple records, each of which represents a single element to be realised.

Parameters:

directoryPath - the path to the file

Method Detail

RecordingOn

public boolean RecordingOn()

Recording on.

Returns:

true, if successful

GetRecordingFile

public String GetRecordingFile()

Gets the recording file.

Returns:

the string

start

public void start()
           throws IOException

Start.

Throws:

IOException - Signals that an I/O exception has occurred.

addRecord

public void addRecord(XmlDocumentElement input,
                      String output)

Adds a record to this recording.

Parameters:

input - the DocumentElement in this record

output - the realisation

finish

public void finish()
            throws JAXBException,
                   IOException,
                   TransformerException

Ends processing for this recording and writes it to an XML file.

Throws:

JAXBException - the jAXB exception

IOException - Signals that an I/O exception has occurred.

TransformerException - the transformer exception

writeRecording

public static void writeRecording(RecordSet record,
                                  OutputStream os)
                           throws JAXBException,
                                  IOException,
                                  TransformerException

Write recording.

Parameters:

record - the record

os - the os

Throws:

JAXBException - the jAXB exception

IOException - Signals that an I/O exception has occurred.

TransformerException - the transformer exception