org.openestate.io.openimmo

Class OpenImmoFeedbackDocument

java.lang.Object

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

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

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

org.openestate.io.openimmo.OpenImmoFeedbackDocument

public class OpenImmoFeedbackDocument
extends OpenImmoDocument<OpenimmoFeedback>

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

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
OpenImmoFeedbackDocument(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 OpenImmoFeedbackDocument.
static OpenImmoFeedbackDocument	newDocument() Creates an empty OpenImmoFeedbackDocument.
static OpenImmoFeedbackDocument	newDocument(OpenimmoFeedback feedback) Creates a OpenImmoFeedbackDocument from a OpenimmoFeedback object.
void	setDocumentVersion(OpenImmoVersion version) Changes the XmlVersion of the contained Document.
OpenimmoFeedback	toObject() Creates a OpenimmoFeedback 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

OpenImmoFeedbackDocument

public OpenImmoFeedbackDocument(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<OpenimmoFeedback>

Returns:

current document version

isReadable

public static boolean isReadable(Document doc)

Checks, if a Document is readable as a OpenImmoFeedbackDocument.

Parameters:

doc - document to check

Returns:

true, if the document is usable, otherwise false

newDocument

public static OpenImmoFeedbackDocument newDocument()
                                            throws ParserConfigurationException,
                                                   JAXBException

Creates an empty OpenImmoFeedbackDocument.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

newDocument

public static OpenImmoFeedbackDocument newDocument(OpenimmoFeedback feedback)
                                            throws ParserConfigurationException,
                                                   JAXBException

Creates a OpenImmoFeedbackDocument from a OpenimmoFeedback object.

Parameters:

feedback - Java object, that represents the <openimmo_feedback> 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<OpenimmoFeedback,OpenImmoVersion>

Parameters:

version - new document version

toObject

public OpenimmoFeedback toObject()
                          throws JAXBException

Creates a OpenimmoFeedback object from the contained Document.

Specified by:

toObject in class XmlDocument<OpenimmoFeedback>

Returns:

created object, that represents the <openimmo_feedback> root element

Throws:

JAXBException - if a problem with JAXB occured