com.interstarinc.xmedius.sendfax
Class XMLBuilder

java.lang.Object
  com.interstarinc.xmedius.sendfax.XMLBuilder

public class XMLBuilder
extends Object

A utility class that converts a java beans graph into a DOM tree (an XML document).

Version:

$Revision: 1.16 $

Author:

André Morin

See Also:

XMLBuilder.MetaDocHandler, Fax.toXML(com.interstarinc.xmedius.sendfax.model.IFaxModel, java.io.OutputStream), The XMLBuilder documentation

Nested Class Summary

class

XMLBuilder.MetaDocHandler This class defines the SAX parser callback methods.

Field Summary

private boolean

nameSpaceAware

Constructor Summary

XMLBuilder()

Method Summary

Document	createDocument(Object aModel, InputStream aMetaDoc) This method returns createDocument(aModel, aMetaDoc, null).
Document	createDocument(Object aModel, InputStream aMetaDoc, Properties parserProperties) This method converts a java beans graph into an XML Document.
boolean	isNameSpaceAware()
void	saveDocument(Document aDocument, OutputStream target) This method invokes saveDocument(aDocument, target, null).
void	saveDocument(Document aDocument, OutputStream target, Properties outputProperties) This method saves the document returned by the createDocument method.
void	setNameSpaceAware(boolean nameSpaceAware)

Methods inherited from class java.lang.Object

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

Field Detail

nameSpaceAware

private boolean nameSpaceAware

Constructor Detail

XMLBuilder

public XMLBuilder()

Method Detail

isNameSpaceAware

public boolean isNameSpaceAware()

setNameSpaceAware

public void setNameSpaceAware(boolean nameSpaceAware)

createDocument

public Document createDocument(Object aModel,
                               InputStream aMetaDoc)
                        throws XMLBuilderException

This method returns createDocument(aModel, aMetaDoc, null).

Throws:

XMLBuilderException

See Also:

createDocument(Object, InputStream, Properties)

createDocument

public Document createDocument(Object aModel,
                               InputStream aMetaDoc,
                               Properties parserProperties)
                        throws XMLBuilderException

This method converts a java beans graph into an XML Document.
It parses the meta-document using a SAX parser and creates an XML document.

Parameters:

aModel - The java beans graph to be converted.

aMetaDoc - The meta-document this class parses in order to produce a DOM tree.

parserProperties - the properties used to initialize the SAX parser.

Returns:

A DOM tree copy of the meta-document enhanced with text nodes whose values are picked up from the model.

Throws:

XMLBuilderException

See Also:

SAXParserFactory, SAXParser

saveDocument

public void saveDocument(Document aDocument,
                         OutputStream target)
                  throws XMLBuilderException

This method invokes saveDocument(aDocument, target, null).

Throws:

XMLBuilderException

See Also:

saveDocument(Document, OutputStream, Properties)

saveDocument

public void saveDocument(Document aDocument,
                         OutputStream target,
                         Properties outputProperties)
                  throws XMLBuilderException

This method saves the document returned by the createDocument method.
It uses a transformer to convert the document to XML.

Parameters:

aDocument - The document (DOM tree) to be saved.

target - Where the document is saved.

outputProperties - The transformer output properties.

Throws:

XMLBuilderException

See Also:

TransformerFactory, Transformer