org.openestate.io.core

Class XmlDocument<JavaType>

java.lang.Object

org.openestate.io.core.XmlDocument<JavaType>

Type Parameters:

JavaType - the class of a (via JAXB generated) Java object, that the contained Document is mapped to

Direct Known Subclasses:

CasaItDocument, Is24XmlDocument, TrovitDocument, WisItDocument, XmlConvertableDocument

public abstract class XmlDocument<JavaType>
extends Object

A container for a XML Document, that provides functions for conversion from / to Java objects.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XmlDocument(Document document) Create from a Document.

Method Summary

Methods

Modifier and Type	Method and Description
Document	getDocument() Returns the Document, that is contained by this object.
boolean	isTextWrittenAsCDATA() Check, if text elements of generated XML should use CDATA.
protected void	prepareDocumentBeforeWritingToXml(Document doc) Make some modifications to a Document, before it is written to XML.
void	setTextWrittenAsCDATA(boolean textsAsCDATA) Enable CDATA for text elements in generated XML.
abstract JavaType	toObject() Creates an object from the contained Document.
void	toXml(File xmlFile) Generate XML for the contained Document.
void	toXml(File xmlFile, boolean prettyPrint) Generate XML for the contained Document.
void	toXml(OutputStream output) Generate XML for the contained Document.
void	toXml(OutputStream output, boolean prettyPrint) Generate XML for the contained Document.
void	toXml(Writer output) Generate XML for the contained Document.
void	toXml(Writer output, boolean prettyPrint) Generate XML for the contained Document.
String	toXmlString() Returns XML for the contained Document.
String	toXmlString(boolean prettyPrint) Returns XML for the contained Document.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlDocument

protected XmlDocument(Document document)

Create from a Document.

Parameters:

document - the contained document

Method Detail

getDocument

public final Document getDocument()

Returns the Document, that is contained by this object.

Returns:

the contained document

isTextWrittenAsCDATA

public final boolean isTextWrittenAsCDATA()

Check, if text elements of generated XML should use CDATA.

Returns:

true, if CDATA is used for XML generation

prepareDocumentBeforeWritingToXml

protected void prepareDocumentBeforeWritingToXml(Document doc)
                                          throws IOException

Make some modifications to a Document, before it is written to XML.

Parameters:

doc - the document, that will be written to XML

Throws:

IOException - if an error occured and XML generation should be stopped

setTextWrittenAsCDATA

public void setTextWrittenAsCDATA(boolean textsAsCDATA)

Enable CDATA for text elements in generated XML.

Parameters:

textsAsCDATA - true, if CDATA is used for XML generation

toObject

public abstract JavaType toObject()
                           throws JAXBException

Creates an object from the contained Document.

Returns:

created object, that represents the contained Document

Throws:

JAXBException - if the Java object is not creatable

toXml

public final void toXml(File xmlFile)
                 throws TransformerException,
                        IOException

Generate XML for the contained Document.

Parameters:

xmlFile - the file, where the XML code is written to

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

toXml

public void toXml(File xmlFile,
         boolean prettyPrint)
           throws TransformerException,
                  IOException

Generate XML for the contained Document.

Parameters:

xmlFile - the file, where the XML code is written to

prettyPrint - if pretty printing is enabled for the generated XML code

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

toXml

public final void toXml(OutputStream output)
                 throws TransformerException,
                        IOException

Generate XML for the contained Document.

Parameters:

output - the output, where the XML code is written to

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

toXml

public void toXml(OutputStream output,
         boolean prettyPrint)
           throws TransformerException,
                  IOException

Generate XML for the contained Document.

Parameters:

output - the output, where the XML code is written to

prettyPrint - if pretty printing is enabled for the generated XML code

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

toXml

public final void toXml(Writer output)
                 throws TransformerException,
                        IOException

Generate XML for the contained Document.

Parameters:

output - the output, where the XML code is written to

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

toXml

public void toXml(Writer output,
         boolean prettyPrint)
           throws TransformerException,
                  IOException

Generate XML for the contained Document.

Parameters:

output - the output, where the XML code is written to

prettyPrint - if pretty printing is enabled for the generated XML code

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

toXmlString

public String toXmlString()
                   throws TransformerException,
                          IOException

Returns XML for the contained Document.

Returns:

the generated XML code

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

toXmlString

public final String toXmlString(boolean prettyPrint)
                         throws TransformerException,
                                IOException

Returns XML for the contained Document.

Parameters:

prettyPrint - if pretty printing is enabled for the generated XML code

Returns:

the generated XML code

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed