citygml4j - The Open Source Java API for CityGML

Version @version@ (@date@)

  This library is free software and is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
  

0. Index
--------

1. License
2. Copyright
3. About
4. System requirements
5. How to use it
6. Developers
7. Contact
8. Websites


1. License
----------

The citygml4j library is licensed under the Apache License,
Version 2.0 (the "License"); you may not use this library except in compliance
with the License. You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0


2. Copyright
------------

(C) 2013-@copyright@,
Claus Nagel <claus.nagel@gmail.com>


3. About
--------

citygml4j is a Java class library and API for facilitating work with the
City Geography Markup Language (CityGML). It makes it easy to read, process, and
write CityGML datasets, and to develop CityGML-aware software applications.

Feature list:
* Full support for CityGML version 2.0.0 and 1.0.0
  (read-only support for CityGML 0.4.0)
* Support for CityGML specific subset of GML 3.1.1
* Support for the eXtensible Address Language (xAL)
* Support for user-defined CityGML Application Domain Extensions (ADE)
* Support for CityJSON 1.0 and the CityJSON extension mechanism

CityGML is an open data model and XML-based format for the storage and exchange
of semantic 3D city models. It is an application schema for the Geography Markup
Language version 3.1.1 (GML3), the extendible international standard for spatial
data exchange issued by the Open Geospatial Consortium (OGC) and the ISO TC211.
The aim of the development of CityGML is to reach a common definition of the
basic entities, attributes, and relations of a 3D city model.

CityGML is an international OGC standard and can be used free of charge.


4. System requirements
----------------------

* Java JRE or JDK >= @javaCompatibility@


5. How to use it
----------------

Simply put the @jar@ library file and its mandatory dependencies
from the "lib" folder on your classpath to start developing with citygml4j.
Have fun :-)

citygml4j is also available as Maven artifact: 

  <dependency>
    <groupId>@groupId@</groupId>
    <artifactId>@artifactId@</artifactId>
    <version>@version@</version>
  </dependency>

A collection of sample programs that demonstrate the use of the library are
provided in the "samples" folder. The sample programs are organized into
subfolders, each addressing a different use case of citygml4j.

Gradle tasks are provided to easily run the sample programs. Simply open a
shell environment, change to the "samples" folder and invoke the Gradle wrapper
using the fully qualified name of the Java class as task name.


6. Developers
-------------

Claus Nagel <claus.nagel@gmail.com>


7. Contact
----------

claus.nagel@gmail.com


8. Websites
-----------

Official citygml4j website: 
https://github.com/citygml4j

Related websites:
http://www.citygml.org/
http://www.citygmlwiki.org/
http://www.opengeospatial.org/standards/citygml