metricsOverlay.xml
Class MetricXMLWriter

java.lang.Object
  extended by metricsOverlay.xml.MetricXMLWriter

public class MetricXMLWriter
extends java.lang.Object

This class creates and writes XML to the provided file location. The contents of the file to be written are provided in the constructor in the form of a MetricDocument data structure.

Version:
25/6/2009
Author:
Matthew Harward

Constructor Summary
MetricXMLWriter(MetricDocument mDoc)
          The main constructor.
 
Method Summary
 void writeFile(java.lang.String xmlFileName)
          This method constructs a XML file from the provided metrics document and saves it to the XML file location provided.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MetricXMLWriter

public MetricXMLWriter(MetricDocument mDoc)
The main constructor.

Parameters:
mDoc - a metric document containing a programatic representation of the XML.
Method Detail

writeFile

public void writeFile(java.lang.String xmlFileName)
This method constructs a XML file from the provided metrics document and saves it to the XML file location provided.

Parameters:
xmlFileName - the absolute path and name of the XML file to be saved. This should be OS compatible and end with an .xml extension.