org.openestate.io.immoxml

Class ImmoXmlDocument

java.lang.Object

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

org.openestate.io.core.XmlConvertableDocument<Immoxml,ImmoXmlVersion>

org.openestate.io.immoxml.ImmoXmlDocument

public class ImmoXmlDocument
extends XmlConvertableDocument<Immoxml,ImmoXmlVersion>

ImmoXML document with a <immoxml> root element.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
ImmoXmlDocument(Document document) Create from a Document.

Method Summary

Methods

Modifier and Type	Method and Description
ImmoXmlVersion	getDocumentVersion() Returns the current XmlVersion of the contained Document.
ImmoXmlVersion	getLatestVersion() Returns the newest supported XmlVersion for the contained Document.
static boolean	isReadable(Document doc) Checks, if a Document is readable as a ImmoXmlDocument.
static ImmoXmlDocument	newDocument() Creates an empty ImmoXmlDocument.
static ImmoXmlDocument	newDocument(Immoxml immoxml) Creates a ImmoXmlDocument from a Immoxml object.
void	setDocumentVersion(ImmoXmlVersion version) Changes the XmlVersion of the contained Document.
Immoxml	toObject() Creates a Immoxml object from the contained Document.

Methods inherited from class org.openestate.io.core.XmlConvertableDocument

downgrade, upgrade, upgradeToLatestVersion

Methods inherited from class org.openestate.io.core.XmlDocument

getDocument, isTextWrittenAsCDATA, prepareDocumentBeforeWritingToXml, setTextWrittenAsCDATA, toXml, toXml, toXml, toXml, toXml, toXml, toXmlString, toXmlString

Methods inherited from class java.lang.Object

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

Constructor Detail

ImmoXmlDocument

public ImmoXmlDocument(Document document)

Create from a Document.

Parameters:

document - the document to create from

Method Detail

getDocumentVersion

public ImmoXmlVersion getDocumentVersion()

Description copied from class: XmlConvertableDocument

Returns the current XmlVersion of the contained Document.

Specified by:

getDocumentVersion in class XmlConvertableDocument<Immoxml,ImmoXmlVersion>

Returns:

current document version

getLatestVersion

public ImmoXmlVersion getLatestVersion()

Description copied from class: XmlConvertableDocument

Returns the newest supported XmlVersion for the contained Document.

Specified by:

getLatestVersion in class XmlConvertableDocument<Immoxml,ImmoXmlVersion>

Returns:

latest supported version

isReadable

public static boolean isReadable(Document doc)

Checks, if a Document is readable as a ImmoXmlDocument.

Parameters:

doc - document to check

Returns:

true, if the document is usable, otherwise false

newDocument

public static ImmoXmlDocument newDocument()
                                   throws ParserConfigurationException,
                                          JAXBException

Creates an empty ImmoXmlDocument.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

newDocument

public static ImmoXmlDocument newDocument(Immoxml immoxml)
                                   throws ParserConfigurationException,
                                          JAXBException

Creates a ImmoXmlDocument from a Immoxml object.

Parameters:

immoxml - Java object, that represents the <immoxml> root element

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

setDocumentVersion

public void setDocumentVersion(ImmoXmlVersion version)

Description copied from class: XmlConvertableDocument

Changes the XmlVersion of the contained Document.

Warning: This function only changes the version information. It does not execute an upgrade / downgrade. Use instead XmlConvertableDocument.downgrade(org.openestate.io.core.XmlVersion), XmlConvertableDocument.upgrade(org.openestate.io.core.XmlVersion), XmlConvertableDocument.upgradeToLatestVersion() in order to perform an upgrade / downgrade.

Specified by:

setDocumentVersion in class XmlConvertableDocument<Immoxml,ImmoXmlVersion>

Parameters:

version - new document version

toObject

public Immoxml toObject()
                 throws JAXBException

Creates a Immoxml object from the contained Document.

Specified by:

toObject in class XmlDocument<Immoxml>

Returns:

created object, that represents the <immoxml> root element

Throws:

JAXBException - if a problem with JAXB occured