org.openestate.io.daft_ie

Class DaftIeDocument

java.lang.Object

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

org.openestate.io.core.XmlConvertableDocument<Daft,DaftIeVersion>

org.openestate.io.daft_ie.DaftIeDocument

public class DaftIeDocument
extends XmlConvertableDocument<Daft,DaftIeVersion>

XML document from daft.ie with a <daft> root element.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DaftIeVersion	getDocumentVersion() Returns the current XmlVersion of the contained Document.
DaftIeVersion	getLatestVersion() Returns the newest supported XmlVersion for the contained Document.
static boolean	isReadable(Document doc) Checks, if a Document is readable as a DaftIeDocument.
static DaftIeDocument	newDocument() Creates an empty DaftIeDocument.
static DaftIeDocument	newDocument(Daft daft) Creates a DaftIeDocument from a Daft object.
void	setDocumentVersion(DaftIeVersion version) Changes the XmlVersion of the contained Document.
Daft	toObject() Creates a Daft 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

DaftIeDocument

public DaftIeDocument(Document document)

Create from a Document.

Parameters:

document - the document to create from

Method Detail

getDocumentVersion

public DaftIeVersion getDocumentVersion()

Description copied from class: XmlConvertableDocument

Returns the current XmlVersion of the contained Document.

Specified by:

getDocumentVersion in class XmlConvertableDocument<Daft,DaftIeVersion>

Returns:

current document version

getLatestVersion

public DaftIeVersion getLatestVersion()

Description copied from class: XmlConvertableDocument

Returns the newest supported XmlVersion for the contained Document.

Specified by:

getLatestVersion in class XmlConvertableDocument<Daft,DaftIeVersion>

Returns:

latest supported version

isReadable

public static boolean isReadable(Document doc)

Checks, if a Document is readable as a DaftIeDocument.

Parameters:

doc - document to check

Returns:

true, if the document is usable, otherwise false

newDocument

public static DaftIeDocument newDocument()
                                  throws ParserConfigurationException,
                                         JAXBException

Creates an empty DaftIeDocument.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

newDocument

public static DaftIeDocument newDocument(Daft daft)
                                  throws ParserConfigurationException,
                                         JAXBException

Creates a DaftIeDocument from a Daft object.

Parameters:

daft - Java object, that represents the <daft> 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(DaftIeVersion 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<Daft,DaftIeVersion>

Parameters:

version - new document version

toObject

public Daft toObject()
              throws JAXBException

Creates a Daft object from the contained Document.

Specified by:

toObject in class XmlDocument<Daft>

Returns:

created object, that represents the <daft> root element

Throws:

JAXBException - if a problem with JAXB occured