org.openestate.io.openimmo

Class OpenImmoTransferDocument

java.lang.Object

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

org.openestate.io.core.XmlConvertableDocument<JavaType,OpenImmoVersion>

org.openestate.io.openimmo.OpenImmoDocument<Openimmo>

org.openestate.io.openimmo.OpenImmoTransferDocument

public class OpenImmoTransferDocument
extends OpenImmoDocument<Openimmo>

OpenImmo-XML document with a <openimmo> root element.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
OpenImmoVersion	getDocumentVersion() Returns the current XmlVersion of the contained Document.
static boolean	isReadable(Document doc) Checks, if a Document is readable as a OpenImmoTransferDocument.
static OpenImmoTransferDocument	newDocument() Creates an empty OpenImmoTransferDocument.
static OpenImmoTransferDocument	newDocument(Openimmo openimmo) Creates a OpenImmoTransferDocument from a Openimmo object.
void	setDocumentVersion(OpenImmoVersion version) Changes the XmlVersion of the contained Document.
Openimmo	toObject() Creates a Openimmo object from the contained Document.

Methods inherited from class org.openestate.io.openimmo.OpenImmoDocument

getLatestVersion, isFeedback, isTransfer

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

OpenImmoTransferDocument

public OpenImmoTransferDocument(Document document)

Create from a Document.

Parameters:

document - the document to create from

Method Detail

getDocumentVersion

public OpenImmoVersion getDocumentVersion()

Description copied from class: XmlConvertableDocument

Returns the current XmlVersion of the contained Document.

Specified by:

getDocumentVersion in class OpenImmoDocument<Openimmo>

Returns:

current document version

isReadable

public static boolean isReadable(Document doc)

Checks, if a Document is readable as a OpenImmoTransferDocument.

Parameters:

doc - document to check

Returns:

true, if the document is usable, otherwise false

newDocument

public static OpenImmoTransferDocument newDocument()
                                            throws ParserConfigurationException,
                                                   JAXBException

Creates an empty OpenImmoTransferDocument.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

newDocument

public static OpenImmoTransferDocument newDocument(Openimmo openimmo)
                                            throws ParserConfigurationException,
                                                   JAXBException

Creates a OpenImmoTransferDocument from a Openimmo object.

Parameters:

openimmo - Java object, that represents the <openimmo> 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(OpenImmoVersion 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<Openimmo,OpenImmoVersion>

Parameters:

version - new document version

toObject

public Openimmo toObject()
                  throws JAXBException

Creates a Openimmo object from the contained Document.

Specified by:

toObject in class XmlDocument<Openimmo>

Returns:

created object, that represents the <openimmo> root element

Throws:

JAXBException - if a problem with JAXB occured