Class XMLResultsWriter

java.lang.Object

common.xml.XMLResultsWriter

All Implemented Interfaces:

XMLResultsConstants

public class XMLResultsWriter
extends Object
implements XMLResultsConstants

Title: XML Results Writer

Description: Writes calculated measures to an XML file along with temporary values. This class provide methods used to store all simulation results with model definition.

Author:

Bertoli Marco Date: 3-ott-2005 Time: 10.36.30

Field Summary

Fields inherited from interface XMLResultsConstants

XML_A_LAST_INTERVAL_AVG_VALUE, XML_A_MEASURE_ALPHA, XML_A_MEASURE_CLASS, XML_A_MEASURE_DISCARDEDSAMPLES, XML_A_MEASURE_FINALVALUE, XML_A_MEASURE_ISSERVERTYPE, XML_A_MEASURE_LOG, XML_A_MEASURE_NAME, XML_A_MEASURE_NODETYPE, XML_A_MEASURE_PRECISION, XML_A_MEASURE_SAMPLES, XML_A_MEASURE_STATE, XML_A_MEASURE_STATION, XML_A_MEASURE_TYPE, XML_A_ROOT_ELAPSED, XML_A_ROOT_LOG_DECIMAL_SEP, XML_A_ROOT_LOG_DELIMITER, XML_A_ROOT_LOG_PATH, XML_A_ROOT_O_METHOD, XML_A_ROOT_O_MODELPATH, XML_A_ROOT_POLLING, XML_A_SAMPLE_LOWERBOUND, XML_A_SAMPLE_MEAN, XML_A_SAMPLE_UPPERBOUND, XML_A_SAMPLE_VALIDITY, XML_A_TIME, XML_AO_MEASURE_ALPHA, XML_AO_MEASURE_CLASS, XML_AO_MEASURE_DISCARDEDSAMPLES, XML_AO_MEASURE_LOWER, XML_AO_MEASURE_MAXSAMPLES, XML_AO_MEASURE_MEAN, XML_AO_MEASURE_NODETYPE, XML_AO_MEASURE_PRECISION, XML_AO_MEASURE_SAMPLES, XML_AO_MEASURE_SERVER_TYPE, XML_AO_MEASURE_STATION, XML_AO_MEASURE_SUCCESSFUL, XML_AO_MEASURE_TYPE, XML_AO_MEASURE_UPPER, XML_DOCUMENT_O_ROOT, XML_DOCUMENT_O_XSD, XML_DOCUMENT_ROOT, XML_DOCUMENT_XSD, XML_E_MEASURE, XML_E_SAMPLE, XML_EO_MEASURE

Constructor Summary

Constructors

Constructor	Description
XMLResultsWriter()

Method Summary

Modifier and Type	Method	Description
static Document	getDocument(MeasureDefinition measure)	Returns the entire Document representing results data structure.
protected static void	writeMeasures(Document doc, Node resultsNode, MeasureDefinition measure)	Write measures information
protected static void	writeResults(Document resultsDoc, MeasureDefinition measure)	Creates root element and adds schema informations to it
protected static void	writeSamples(Document doc, Node measureNode, MeasureDefinition measure, int measureIndex, boolean parametric)	Writes all samples for a given measure Modified by Francesco D'Aquino
static void	writeXML(File xmlFile, MeasureDefinition measure)	Writes results into an XML file
static void	writeXML(OutputStream out, MeasureDefinition measure)	Writes results into an XML stream
static void	writeXML(String fileName, MeasureDefinition measure)	Writes results into an XML file

Methods inherited from class Object

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

Constructor Details

XMLResultsWriter

public XMLResultsWriter()

Method Details

writeXML

public static void writeXML(String fileName,
 MeasureDefinition measure)

Writes results into an XML file

Parameters:

fileName - name of the file to be created

measure - data structure

writeXML

public static void writeXML(File xmlFile,
 MeasureDefinition measure)

Writes results into an XML file

Parameters:

xmlFile - handler to the file to be created

measure - data structure

writeXML

public static void writeXML(OutputStream out,
 MeasureDefinition measure)

Writes results into an XML stream

Parameters:

out - stream where XML should be written

measure - data structure

getDocument

public static Document getDocument(MeasureDefinition measure)

Returns the entire Document representing results data structure.

Parameters:

measure - data structure

Returns:

complete measures data structure in Document format

writeResults

protected static void writeResults(Document resultsDoc,
 MeasureDefinition measure)

Creates root element and adds schema informations to it

Parameters:

resultsDoc - Document root

measure - data structure

writeMeasures

protected static void writeMeasures(Document doc,
 Node resultsNode,
 MeasureDefinition measure)

Write measures information

Parameters:

doc - Document root

resultsNode - parent node where measure informations should be added

measure - data structure

writeSamples

protected static void writeSamples(Document doc,
 Node measureNode,
 MeasureDefinition measure,
 int measureIndex,
 boolean parametric)

Writes all samples for a given measure Modified by Francesco D'Aquino

Parameters:

doc - Document root

measureNode - parent node where samples informations should be added

measure - data structure

measureIndex - index of the measure to be written

parametric - true if these are results from a parametric analysis simulation