gov.va.vinci.leo.tools

Class XMLSerializer

java.lang.Object

gov.va.vinci.leo.tools.XMLSerializer

public class XMLSerializer
extends Object

Use SAX to serialize XML data out to a file.

Author:

thomasginter

Constructor Summary

Constructors

Constructor and Description
XMLSerializer() Default Constructor, setup basic XML output properties such as Encoding, Method, and Indent.
XMLSerializer(File fileHandle) Constructor with File Handle input.
XMLSerializer(OutputStream outputStream) Constructor with outputStream input.
XMLSerializer(String filename) Constructor with file path input paramter, uses the path to setup the output stream.
XMLSerializer(Writer writer) Constructor with Writer input.

Method Summary

Modifier and Type	Method and Description
TransformerHandler	getTHandler() Return a pointer to the TransformerHandler object created and managed by the serializer.
void	setOutputProperty(String name, String value) Allow the user to specify arbitrary properties for output.
void	setOutputStream(File fileHandle) Set the OutputStream for this serializer from a File Handle.
void	setOutputStream(OutputStream outputStream) Set the OutputStream for this serializer.
void	setOutputStream(String fileName) Set the OutputStream for this serializer from a String file name.
void	setWriter(Writer writer) Set the Writer object for this serializer.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLSerializer

public XMLSerializer()
              throws TransformerConfigurationException,
                     TransformerFactoryConfigurationError

Default Constructor, setup basic XML output properties such as Encoding, Method, and Indent.

Throws:

TransformerConfigurationException - if there is an exception with the Transformer configuration.

TransformerFactoryConfigurationError - if there is an exception with the Transformer Factory.

XMLSerializer

public XMLSerializer(String filename)
              throws Exception

Constructor with file path input paramter, uses the path to setup the output stream.

Parameters:

filename - Path to the file that will be written out

Throws:

Exception - if there are any Transformer or output stream exceptions.

XMLSerializer

public XMLSerializer(File fileHandle)
              throws Exception

Constructor with File Handle input. Uses the file handle for the output stream.

Parameters:

fileHandle - File Handle used for output stream.

Throws:

Exception - if there are any Transformer or output stream exceptions.

XMLSerializer

public XMLSerializer(OutputStream outputStream)
              throws Exception

Constructor with outputStream input. Uses the Output Stream for serializing the file.

Parameters:

outputStream - OutputStream used to serialize the file.

Throws:

Exception - if there are any Transformer or output stream exceptions.

XMLSerializer

public XMLSerializer(Writer writer)
              throws Exception

Constructor with Writer input. Use the Writer object to serialize the file.

Parameters:

writer - Writer to be used for file output

Throws:

Exception - if there are any Transformer or output stream exceptions.

Method Detail

setOutputStream

public void setOutputStream(String fileName)
                     throws FileNotFoundException

Set the OutputStream for this serializer from a String file name.

Parameters:

fileName - the file name, including path, to write out to.

Throws:

FileNotFoundException - if there is an error creating the file.

setOutputStream

public void setOutputStream(File fileHandle)
                     throws FileNotFoundException

Set the OutputStream for this serializer from a File Handle.

Parameters:

fileHandle - the file handle to write the output to.

Throws:

FileNotFoundException - if there is an error creating the file.

setOutputStream

public void setOutputStream(OutputStream outputStream)

Set the OutputStream for this serializer.

Parameters:

outputStream - the output stream to write the xml to.

setWriter

public void setWriter(Writer writer)

Set the Writer object for this serializer.

Parameters:

writer - the writer to write the xml to.

setOutputProperty

public void setOutputProperty(String name,
                              String value)

Allow the user to specify arbitrary properties for output.

Parameters:

name - Name of the property

value - Value of the property

getTHandler

public TransformerHandler getTHandler()

Return a pointer to the TransformerHandler object created and managed by the serializer.

Returns:

TransformerHandler Object for writing the file