io.jbotsim.io.format.xml

Class XMLTraceBuilder

java.lang.Object

io.jbotsim.io.format.xml.XMLBuilder

io.jbotsim.io.format.xml.XMLTraceBuilder

All Implemented Interfaces:

TraceFileWriter

public class XMLTraceBuilder
extends XMLBuilder
implements TraceFileWriter

Builder used to store recorded executions of a Topology.

This class is used, mainly, through methods inherited from XMLBuilder. It calls XMLTopologyBuilder.buildTopologyElement(org.w3c.dom.Document, io.jbotsim.core.Topology) to build the element that stores the recorded Topology.

Event of the Topology are recorded using addTraceEvent(TraceEvent) method.

Nested Class Summary

Nested classes/interfaces inherited from class io.jbotsim.io.format.xml.XMLBuilder

XMLBuilder.BuilderException

Field Summary

Fields inherited from class io.jbotsim.io.format.xml.XMLBuilder

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
XMLTraceBuilder(Topology tp) This constructor add to the root element of the document the trace element that stores the topology tp and the recorded events.

Method Summary

Modifier and Type	Method and Description
void	addTraceEvent(TraceEvent e) Adds an event to the document
protected FileAsStream	getFileAccessor()
void	write(String filename) Outputs the current XML document into the specified file.

Methods inherited from class io.jbotsim.io.format.xml.XMLBuilder

getDocument, writeToString

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLTraceBuilder

public XMLTraceBuilder(Topology tp)
                throws XMLBuilder.BuilderException

This constructor add to the root element of the document the trace element that stores the topology tp and the recorded events. Since the trace may not exist before the creation of the document, events are stored one by one using addTraceEvent(TraceEvent) after the document has been built.

Parameters:

tp - the topology that is traced.

Throws:

BuilderException - is raised if an error occurs while the document is built.

XMLBuilder.BuilderException

Method Detail

getFileAccessor

protected FileAsStream getFileAccessor()

write

public void write(String filename)
           throws XMLBuilder.BuilderException

Outputs the current XML document into the specified file.

Specified by:

write in interface TraceFileWriter

Parameters:

filename - the targeted output file

Throws:

BuilderException - raised either when an XML error occurs while the document is created or if an IO error occurs.

XMLBuilder.BuilderException

addTraceEvent

public void addTraceEvent(TraceEvent e)

Adds an event to the document

Specified by:

addTraceEvent in interface TraceFileWriter

Parameters:

e - the event added to the stored story