Skip to content

Latest commit

 

History

History

OpenImmo

README.md

OpenEstate-IO-OpenImmo 1.5

OpenEstate-IO-OpenImmo is a Java library to read and write real estate data in the OpenImmo format (version 1.2.7b down to 1.1), that is used by a variety of real estate software in Germany, Austria and Switzerland.

Features

How to use

Download the latest release from GitHub. The provided archive contains all required files (compiled libraries, dependencies, source code and documentations).

Alternatively you can integrate the library from Maven Central Repository into your Maven project. Just add the following dependency to your projects pom.xml:

<dependency>
  <groupId>org.openestate.io</groupId>
  <artifactId>OpenEstate-IO-OpenImmo</artifactId>
  <version>1.5</version>
</dependency>

You can find further information in the project wiki. Some example classes for this format are available in the Examples module.

Specifications

According to the license of the OpenImmo format we're not allowed to publish the specifications. Get in contact with OpenImmo e.V. to obtain the specifications of the OpenImmo format.

Modifications to the original specification

In order to improve the generated Java classes, we've made the following modifications to the original openimmo_127b.xsd schema:

  • removed <xsd:choice> from <xsd:element name="geo"> and move its child elements into the parent <xsd:sequence>

  • removed <xsd:choice> from <xsd:element name="kontaktperson"> and move its child elements into the parent <xsd:sequence>

The following changes were made to the original openimmo-feedback_125.xsd schema:

  • added <xsd:include schemaLocation="openimmo_127b.xsd"/> before <xsd:element name="openimmo_feedback">

  • removed <xsd:element name="user_defined_extend"> ... </xsd:element> because it is also defined in openimmo_127.xsd

To generate the Java classes via JAXB for yourself, copy the modified openimmo_127b.xsd and openimmo-feedback_125.xsd into src/main/xsd and run mvn-jaxb-xjc.sh.

Dependencies

Notes about JDK versions below 11

JAXB is bundled with JDK 8, was disabled / deprecated in JDK 9 & 10 and finally removed in JDK 11. Therefore, we're providing JAXB as an explicit dependency. See also "JAXB on Java 9, 10, 11 and beyond".

It is recommended to use this library with JDK 11 as it should work out of the box. In case you're using JDK 8, you might need to follow one of these steps documented at "JAXB Release Documentation":

JavaSE comes with JAXB 2.x API/implementation in rt.jar. Each version of JavaSE (6, 7, 8, ...) contains different version of JAXB 2.x API. Therefore, if you want to use different version of JAXB API/implementation than the one present in your version of JDK, you are required to override a portion of rt.jar with the new API. There are several ways to achieve this:

  1. Place the jakarta.xml.bind-api-X.Y.Z.jar into $JRE_HOME/lib/endorsed. Do not put other JAXB jars into the endorsed directory. This essentially makes your JRE to "JRE X + JAXB 2.y". This would affect any other applications that use this JRE, and it's easy. On the other hand, in various scenarios you may not be able to alter the JRE.

  2. Use the system property java.endorsed.dirs when you launch your application, and have it point to the directory which contains the jakarta.xml.bind-api-X.Y.Z.jar only. The directory must not contain any other jaxb artifacts. This allows you to use different version of JAXB for different applications.

See the endorsed directory mechanism for more details.

All provided dependencies should work with JDK 8. If compatibility problems occur, you might replace them with an earlier version.

Changelog

Take a look at CHANGELOG.md for the full changelog.

License

This library is licensed under the terms of Apache License, Version 2.0. Take a look at LICENSE.txt for the license text.

Further information