org.openestate.io.immobiliare_it

Class ImmobiliareItDocument

java.lang.Object

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

org.openestate.io.core.XmlConvertableDocument<Feed,ImmobiliareItVersion>

org.openestate.io.immobiliare_it.ImmobiliareItDocument

public class ImmobiliareItDocument
extends XmlConvertableDocument<Feed,ImmobiliareItVersion>

XML document from immobiliare.it with a <feed> root element.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

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

Method Summary

Methods

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

ImmobiliareItDocument

public ImmobiliareItDocument(Document document)

Create from a Document.

Parameters:

document - the document to create from

Method Detail

getDocumentVersion

public ImmobiliareItVersion getDocumentVersion()

Description copied from class: XmlConvertableDocument

Returns the current XmlVersion of the contained Document.

Specified by:

getDocumentVersion in class XmlConvertableDocument<Feed,ImmobiliareItVersion>

Returns:

current document version

getLatestVersion

public ImmobiliareItVersion getLatestVersion()

Description copied from class: XmlConvertableDocument

Returns the newest supported XmlVersion for the contained Document.

Specified by:

getLatestVersion in class XmlConvertableDocument<Feed,ImmobiliareItVersion>

Returns:

latest supported version

isReadable

public static boolean isReadable(Document doc)

Checks, if a Document is readable as a ImmobiliareItDocument.

Parameters:

doc - document to check

Returns:

true, if the document is usable, otherwise false

newDocument

public static ImmobiliareItDocument newDocument()
                                         throws ParserConfigurationException,
                                                JAXBException

Creates an empty ImmobiliareItDocument.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

JAXBException - if a problem with JAXB occured

newDocument

public static ImmobiliareItDocument newDocument(Feed feed)
                                         throws ParserConfigurationException,
                                                JAXBException

Creates a ImmobiliareItDocument from a Feed object.

Parameters:

feed - Java object, that represents the <feed> 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(ImmobiliareItVersion 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<Feed,ImmobiliareItVersion>

Parameters:

version - new document version

toObject

public Feed toObject()
              throws JAXBException

Creates a Feed object from the contained Document.

Specified by:

toObject in class XmlDocument<Feed>

Returns:

created object, that represents the <feed> root element

Throws:

JAXBException - if a problem with JAXB occured