org.openestate.io.core

Class XmlConvertableDocument<JavaType,VersionType extends XmlVersion>

java.lang.Object

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

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

Type Parameters:

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

VersionType - the class to determine different versions of the document

Direct Known Subclasses:

DaftIeDocument, ImmobiliareItDocument, ImmoXmlDocument, KyeroDocument, OpenImmoDocument

public abstract class XmlConvertableDocument<JavaType,VersionType extends XmlVersion>
extends XmlDocument<JavaType>

An extended XmlDocument with versioning functionality.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
XmlConvertableDocument(Document document)

Method Summary

Methods

Modifier and Type	Method and Description
void	downgrade(VersionType targetVersion) Downgrades the contained Document to an earlier version.
abstract VersionType	getDocumentVersion() Returns the current XmlVersion of the contained Document.
abstract VersionType	getLatestVersion() Returns the newest supported XmlVersion for the contained Document.
abstract void	setDocumentVersion(VersionType version) Changes the XmlVersion of the contained Document.
void	upgrade(XmlVersion targetVersion) Upgrades the contained Document to a newer version.
void	upgradeToLatestVersion() Upgrades the contained Document to the newest / latest version.

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

XmlConvertableDocument

public XmlConvertableDocument(Document document)

Method Detail

downgrade

public void downgrade(VersionType targetVersion)

Downgrades the contained Document to an earlier version.

Parameters:

targetVersion - the version, that the Document is downgraded to

getDocumentVersion

public abstract VersionType getDocumentVersion()

Returns the current XmlVersion of the contained Document.

Returns:

current document version

getLatestVersion

public abstract VersionType getLatestVersion()

Returns the newest supported XmlVersion for the contained Document.

Returns:

latest supported version

setDocumentVersion

public abstract void setDocumentVersion(VersionType version)

Changes the XmlVersion of the contained Document.

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

Parameters:

version - new document version

upgrade

public void upgrade(XmlVersion targetVersion)

Upgrades the contained Document to a newer version.

Parameters:

targetVersion - the version, that the Document is upgraded to

upgradeToLatestVersion

public final void upgradeToLatestVersion()

Upgrades the contained Document to the newest / latest version.