org.openestate.io.kyero.converters

Class Kyero_3

java.lang.Object

org.openestate.io.core.XmlConverter<KyeroDocument,KyeroVersion>

org.openestate.io.kyero.converters.Kyero_3

public class Kyero_3
extends XmlConverter<KyeroDocument,KyeroVersion>

Converter for version 3.

Since:

1.0

Author:

Andreas Rudolph

Constructor Summary

Constructors

Constructor and Description
Kyero_3()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	downgradeNewBuildElements(Document doc) Downgrade <new_build> elements to Kyero 2.1.
void	downgradeToPreviousVersion(KyeroDocument doc) Downgrade a Kyero document from version 3.
protected void	downgradeTypeElements(Document doc) Downgrade <type> elements to Kyero 2.1.
protected void	downgradeUrlElements(Document doc) Downgrade <url> elements to Kyero 2.1.
KyeroVersion	getVersion() Returns the version, that this converter is implemented for.
protected void	removeCustomElements(Document doc) Remove <custom> elements.
protected void	removeEnergyRatingElements(Document doc) Remove <energy_rating> elements.
protected void	removeLocationElements(Document doc) Remove <location> elements.
protected void	removeNotesElements(Document doc) Remove <notes> elements.
protected void	removeUnsupportedLanguageElements(Document doc) Remove elements with translations in unsupported languages.
protected void	upgradeCurrencyElements(Document doc) Upgrade <currency> elements to Kyero 3.
void	upgradeFromPreviousVersion(KyeroDocument doc) Upgrade a Kyero document to version 3.
protected void	upgradeNewBuildElements(Document doc) Upgrade <new_build> elements for Kyero 3.
protected void	upgradeTypeElements(Document doc) Upgrade <type> elements to Kyero 3.
protected void	upgradeUrlElements(Document doc) Upgrade <url> elements to Kyero 3.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Kyero_3

public Kyero_3()

Method Detail

getVersion

public KyeroVersion getVersion()

Description copied from class: XmlConverter

Returns the version, that this converter is implemented for.

Specified by:

getVersion in class XmlConverter<KyeroDocument,KyeroVersion>

Returns:

version version of the converter

downgradeToPreviousVersion

public void downgradeToPreviousVersion(KyeroDocument doc)

Downgrade a Kyero document from version 3.

Specified by:

downgradeToPreviousVersion in class XmlConverter<KyeroDocument,KyeroVersion>

Parameters:

doc - Kyero document in version 3

upgradeFromPreviousVersion

public void upgradeFromPreviousVersion(KyeroDocument doc)

Upgrade a Kyero document to version 3.

Specified by:

upgradeFromPreviousVersion in class XmlConverter<KyeroDocument,KyeroVersion>

Parameters:

doc - Kyero document in version 2.1

downgradeNewBuildElements

protected void downgradeNewBuildElements(Document doc)
                                  throws org.jaxen.JaxenException

Downgrade <new_build> elements to Kyero 2.1.

The <new_build> elements are not available in version 2.1. Instead the value "new_build" is used in the <price_freq> element.

Any <new_build> elements are removed. If its value is set to "1", then <price_freq>sale</price_freq> is convertet to <price_freq>new_build</price_freq>,

Parameters:

doc - Kyero document in version 3

Throws:

org.jaxen.JaxenException

downgradeTypeElements

protected void downgradeTypeElements(Document doc)
                              throws org.jaxen.JaxenException

Downgrade <type> elements to Kyero 2.1.

The <type> elements require a <en> child element in version 2.1.

An <en> child element is created for any <type> element.

Parameters:

doc - Kyero document in version 3

Throws:

org.jaxen.JaxenException

downgradeUrlElements

protected void downgradeUrlElements(Document doc)
                             throws org.jaxen.JaxenException

Downgrade <url> elements to Kyero 2.1.

The <url> elements only support a simple text value in version 2.1. Version 3 allows different URL's for different languages.

Any children of <url> elements are removed. The english URL or the first found URL is copied as simple value into the <url> element.

Parameters:

doc - Kyero document in version 3

Throws:

org.jaxen.JaxenException

removeCustomElements

protected void removeCustomElements(Document doc)
                             throws org.jaxen.JaxenException

Remove <custom> elements.

Kyero 3 does not support <custom> elements in <property> and <agent>.

Any occurence of these elements is removed.

Parameters:

doc - OpenImmo document in version 2.1

Throws:

org.jaxen.JaxenException

removeEnergyRatingElements

protected void removeEnergyRatingElements(Document doc)
                                   throws org.jaxen.JaxenException

Remove <energy_rating> elements.

Kyero 2.1 does not support <energy_rating> elements.

Parameters:

doc - OpenImmo document in version 3

Throws:

org.jaxen.JaxenException

removeLocationElements

protected void removeLocationElements(Document doc)
                               throws org.jaxen.JaxenException

Remove <location> elements.

Kyero 2.1 does not support <location> elements.

Parameters:

doc - OpenImmo document in version 3

Throws:

org.jaxen.JaxenException

removeNotesElements

protected void removeNotesElements(Document doc)
                            throws org.jaxen.JaxenException

Remove <notes> elements.

Kyero 2.1 does not support <notes> elements.

Parameters:

doc - OpenImmo document in version 3

Throws:

org.jaxen.JaxenException

removeUnsupportedLanguageElements

protected void removeUnsupportedLanguageElements(Document doc)
                                          throws org.jaxen.JaxenException

Remove elements with translations in unsupported languages.

Kyero 2.1 does only support translation in <title> (for images), <desc> (for properties) elements for "en", "es", "de", "nl", "fr".

Parameters:

doc - OpenImmo document in version 3

Throws:

org.jaxen.JaxenException

upgradeCurrencyElements

protected void upgradeCurrencyElements(Document doc)
                                throws org.jaxen.JaxenException

Upgrade <currency> elements to Kyero 3.

The <currency> only supports the values "EUR", "GBP", "USD" in version 3.

Any <currency> with an unsupported value is removed from the document.

Parameters:

doc - Kyero document in version 2.1

Throws:

org.jaxen.JaxenException

upgradeNewBuildElements

protected void upgradeNewBuildElements(Document doc)
                                throws org.jaxen.JaxenException

Upgrade <new_build> elements for Kyero 3.

The <new_build> elements are not available in version 2.1. Instead the value "new_build" is used in the <price_freq> element.

Any occurences of <price_freq>new_build</price_freq> is replaced by <price_freq>sale</price_freq> and <new_build>1</new_build> is added to the property.

Parameters:

doc - Kyero document in version 2.1

Throws:

org.jaxen.JaxenException

upgradeTypeElements

protected void upgradeTypeElements(Document doc)
                            throws org.jaxen.JaxenException

Upgrade <type> elements to Kyero 3.

The <type> elements do not support any child element in version 3.

Any child elements of <type> are removed. The text from the <en> child element is copied into the <type> element.

Parameters:

doc - Kyero document in version 2.1

Throws:

org.jaxen.JaxenException

upgradeUrlElements

protected void upgradeUrlElements(Document doc)
                           throws org.jaxen.JaxenException

Upgrade <url> elements to Kyero 3.

The <url> elements only support a simple text value in version 2.1. Version 3 allows different URL's for different languages.

The simple value of <url> elements is removed and copied into the <en> child element.

Parameters:

doc - Kyero document in version 2.1

Throws:

org.jaxen.JaxenException