ikr.simlib.result.xml

Class XMLResultWriter

java.lang.Object

ikr.simlib.result.xml.XMLResultWriter

All Implemented Interfaces:

ResultWriter

public class XMLResultWriter
extends java.lang.Object
implements ResultWriter

A result writer which writes XML to an output stream.

Constructor Summary

Constructors

Constructor and Description
XMLResultWriter(java.io.OutputStream output, ResultFileType resultType, int seedIndex, int batchNumber, int totalNumberOfBatches, java.lang.String logNameForErrorMessages) Constructs a new XML result writer.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the writer and underlying streams.
static void	setRoundingDigits(java.lang.Integer digits) Set the number of significant digits for double output.
static void	setRoundingDigits(java.lang.Integer digits, java.math.RoundingMode mode) Set the number of significant digits for double output.
void	writeDouble(java.lang.String name, double value) A shorthand method for
void	writeEndArray() Writes the end of a result array.
void	writeEndArrayItem() Writes the end of a result array bucket.
void	writeEndNode() Writes the end of a result node.
void	writeEndResults() Writes the end of the results.
void	writeLong(java.lang.String name, long value) A shorthand method for
void	writeStartArray(java.lang.String name) Writes the beginning of a result array.
void	writeStartArrayItem(long index) Writes the beginning of a result array bucket.
void	writeStartNode(java.lang.String type, java.lang.String name) Writes the beginning of a result node.
void	writeStartResults() Writes the beginning of the results.
void	writeString(java.lang.String name, java.lang.String value) A shorthand method for

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLResultWriter

public XMLResultWriter(java.io.OutputStream output,
               ResultFileType resultType,
               int seedIndex,
               int batchNumber,
               int totalNumberOfBatches,
               java.lang.String logNameForErrorMessages)

Constructs a new XML result writer.

Parameters:

output - the output stream for the XML result tree. The stream will not be closed by this writer

logNameForErrorMessages -

Method Detail

setRoundingDigits

public static void setRoundingDigits(java.lang.Integer digits)

Set the number of significant digits for double output.

Parameters:

digits - the number of digits. Set to null to disable rounding.

setRoundingDigits

public static void setRoundingDigits(java.lang.Integer digits,
                     java.math.RoundingMode mode)

Set the number of significant digits for double output.

Parameters:

digits - the number of digits. Set to null to disable rounding.

mode - see RoundingMode for possible modes

close

public void close()
           throws PrintException

Description copied from interface: ResultWriter

Closes the writer and underlying streams.

Specified by:

close in interface ResultWriter

Throws:

PrintException

writeStartResults

public void writeStartResults()
                       throws PrintException

Description copied from interface: ResultWriter

Writes the beginning of the results. In order to complete the results the user must call writeEndResults .

Specified by:

writeStartResults in interface ResultWriter

Throws:

PrintException - if any error in writing the results occurs

writeEndResults

public void writeEndResults()
                     throws PrintException

Description copied from interface: ResultWriter

Writes the end of the results. It must be preceded by a call to writeStartResults and all other writeStartXXX must have been matched by their writeEndXXX counterparts.

Specified by:

writeEndResults in interface ResultWriter

Throws:

PrintException - if any error in writing the results occurs

writeDouble

public void writeDouble(java.lang.String name,
               double value)
                 throws PrintException

Description copied from interface: ResultWriter

A shorthand method for

 <code>
 writeDouble(value);
 writeName(name);
 </code>
 

Specified by:

writeDouble in interface ResultWriter

Parameters:

name - name of the result

value - value of the result

Throws:

PrintException - if any error in writing the results occurs

writeEndArray

public void writeEndArray()
                   throws PrintException

Description copied from interface: ResultWriter

Writes the end of a result array. It must be preceded by a call to writeStartArray.

Specified by:

writeEndArray in interface ResultWriter

Throws:

PrintException - if any error in writing the results occurs

writeEndArrayItem

public void writeEndArrayItem()
                       throws PrintException

Description copied from interface: ResultWriter

Writes the end of a result array bucket. It must be preceded by a call to writeStartBucket.

Specified by:

writeEndArrayItem in interface ResultWriter

Throws:

PrintException - if any error in writing the results occurs

writeEndNode

public void writeEndNode()
                  throws PrintException

Description copied from interface: ResultWriter

Writes the end of a result node. It must be preceded by a call to writeStartNode.

Specified by:

writeEndNode in interface ResultWriter

Throws:

PrintException - if any error in writing the results occurs

writeLong

public void writeLong(java.lang.String name,
             long value)
               throws PrintException

Description copied from interface: ResultWriter

A shorthand method for

 <code>
 writeLong(value);
 writeName(name);
 </code>
 

Specified by:

writeLong in interface ResultWriter

Parameters:

name - name of the result

value - value of the result

Throws:

PrintException - if any error in writing the results occurs

writeStartArray

public void writeStartArray(java.lang.String name)
                     throws PrintException

Description copied from interface: ResultWriter

Writes the beginning of a result array. In order to complete the array you must call writeEndArray.

Specified by:

writeStartArray in interface ResultWriter

Throws:

PrintException - if any error in writing the results occurs

writeStartArrayItem

public void writeStartArrayItem(long index)
                         throws PrintException

Description copied from interface: ResultWriter

Writes the beginning of a result array bucket. In order to complete the bucket you must call writeEndBucket. It is only legal to call this method in an array.

Specified by:

writeStartArrayItem in interface ResultWriter

Throws:

PrintException - if any error in writing the results occurs

writeStartNode

public void writeStartNode(java.lang.String type,
                  java.lang.String name)
                    throws PrintException

Description copied from interface: ResultWriter

Writes the beginning of a result node. In order to complete the node the user must call writeEndNode.

Specified by:

writeStartNode in interface ResultWriter

Parameters:

type - of the result node

Throws:

PrintException - if any error in writing the results occurs

writeString

public void writeString(java.lang.String name,
               java.lang.String value)
                 throws PrintException

Description copied from interface: ResultWriter

A shorthand method for

 <code>
 writeString(value);
 writeName(name);
 </code>
 

Specified by:

writeString in interface ResultWriter

Parameters:

name - name of the result

value - value of the result

Throws:

PrintException - if any error in writing the results occurs