org.openestate.io.kyero

Class KyeroDocument

java.lang.Object

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

org.openestate.io.core.XmlConvertableDocument<Root,KyeroVersion>

org.openestate.io.kyero.KyeroDocument

public class KyeroDocument
extends XmlConvertableDocument<Root,KyeroVersion>

Kyero-XML document with a <root> root element.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

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

Method Summary

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

KyeroDocument

public KyeroDocument(Document document)

Create from a Document.

Parameters:

document - the document to create from

Method Detail

getDocumentVersion

public KyeroVersion getDocumentVersion()

Description copied from class: XmlConvertableDocument

Returns the current XmlVersion of the contained Document.

Specified by:

getDocumentVersion in class XmlConvertableDocument<Root,KyeroVersion>

Returns:

current document version

getLatestVersion

public KyeroVersion getLatestVersion()

Description copied from class: XmlConvertableDocument

Returns the newest supported XmlVersion for the contained Document.

Specified by:

getLatestVersion in class XmlConvertableDocument<Root,KyeroVersion>

Returns:

latest supported version

isReadable

public static boolean isReadable(Document doc)

Checks, if a Document is readable as a KyeroDocument.

Parameters:

doc - document to check

Returns:

true, if the document is usable, otherwise false

newDocument

public static KyeroDocument newDocument()
                                 throws ParserConfigurationException,
                                        JAXBException

Creates an empty KyeroDocument.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

newDocument

public static KyeroDocument newDocument(Root root)
                                 throws ParserConfigurationException,
                                        JAXBException

Creates a KyeroDocument from a Root object.

Parameters:

root - Java object, that represents the <root> 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(KyeroVersion 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<Root,KyeroVersion>

Parameters:

version - new document version

toObject

public Root toObject()
              throws JAXBException

Creates a Root object from the contained Document.

Specified by:

toObject in class XmlDocument<Root>

Returns:

created object, that represents the <root> root element

Throws:

JAXBException - if a problem with JAXB occured