org.openestate.io.openimmo

Class OpenImmoDocument<JavaType>

java.lang.Object

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

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

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

Type Parameters:

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

Direct Known Subclasses:

OpenImmoFeedbackDocument, OpenImmoTransferDocument

public abstract class OpenImmoDocument<JavaType>
extends XmlConvertableDocument<JavaType,OpenImmoVersion>

A general OpenImmo-XML document.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract OpenImmoVersion	getDocumentVersion() Returns the current XmlVersion of the contained Document.
OpenImmoVersion	getLatestVersion() Returns the newest supported XmlVersion for the contained Document.
boolean	isFeedback() Checks, if the current document is a OpenImmoFeedbackDocument.
boolean	isTransfer() Checks, if the current document is a OpenImmoTransferDocument.

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

downgrade, setDocumentVersion, upgrade, upgradeToLatestVersion

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

getDocument, isTextWrittenAsCDATA, prepareDocumentBeforeWritingToXml, setTextWrittenAsCDATA, toObject, 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

OpenImmoDocument

protected OpenImmoDocument(Document document)

Create from a Document.

Parameters:

document - the document to create from

Method Detail

getDocumentVersion

public abstract OpenImmoVersion getDocumentVersion()

Description copied from class: XmlConvertableDocument

Returns the current XmlVersion of the contained Document.

Specified by:

getDocumentVersion in class XmlConvertableDocument<JavaType,OpenImmoVersion>

Returns:

current document version

getLatestVersion

public OpenImmoVersion getLatestVersion()

Description copied from class: XmlConvertableDocument

Returns the newest supported XmlVersion for the contained Document.

Specified by:

getLatestVersion in class XmlConvertableDocument<JavaType,OpenImmoVersion>

Returns:

latest supported version

isFeedback

public boolean isFeedback()

Checks, if the current document is a OpenImmoFeedbackDocument.

Returns:

true, if the current document is a OpenImmoFeedbackDocument

isTransfer

public boolean isTransfer()

Checks, if the current document is a OpenImmoTransferDocument.

Returns:

true, if the current document is a OpenImmoTransferDocument