Benutzerhandbuch für die xPlanBox

1. Präambel

Dieses Dokument ist das offizielle Handbuch zur Benutzung der Software xPlanBox. Die in diesem Dokument genannten Soft- und Hardwarebezeichnungen sind in den meisten Fällen auch eingetragene Warenzeichen und unterliegen als solche den gesetzlichen Bestimmungen.

Die in diesem Werk enthaltenen Angaben, Daten, Ergebnisse usw. wurden von den Autoren nach bestem Wissen erstellt und mit Sorgfalt überprüft. Dennoch sind inhaltliche Fehler nicht völlig auszuschließen. Daher erfolgen alle Angaben ohne jegliche Verpflichtung oder Garantie. Die Autoren übernehmen aus diesem Grund auch keinerlei Verantwortung oder Haftung für Fehler und deren Folgen. Hinweise auf eventuelle Irrtümer werden gerne entgegengenommen.

Dieses Dokument ist mit AsciiDoc gesetzt. Es ist als Quellcode erhältlich und kann als HTML und PDF angeschaut bzw. bereitgestellt werden. Für die Bereitstellung des AsciiDoc Quellcode wenden Sie sich bitte an lat/lon - per E-mail an info@lat-lon.de.

1.1. Autoren

Danilo Bretschneider, Jens Fitzke, Torsten Friebe, Sebastian Goerke, Lyn Elisa Goltz, Lena Rippolz, Sabine Schmitz, Dirk Stenger, Carmen Tawalika, Jeronimo Wanhoff.

1.2. Lizenz des Dokuments

Es wird die Erlaubnis gewährt, dieses Dokument zu kopieren, zu verteilen und/oder zu modifizieren, unter den Bestimmungen der GNU Free Documentation License, Version 1.3 oder jeder späteren Version, veröffentlicht von der Free Software Foundation; mit den unveränderlichen Abschnitten Präambel und Autoren, ohne vordere Umschlagtexte und ohne hintere Umschlagtexte. Die Lizenz wird unter http://www.gnu.org/licenses/fdl-1.3 bereitgestellt.

2. Überblick

Die xPlanBox dient der Abbildung der Bauleit- und der Landschaftsplanung. Die xPlanBox basiert auf den Standards des Open Geospatial Consortium, der INSPIRE Richtlinie und insbesondere dem Standard XPlanung zur Abbildung des deutschen Planungsrechts durch ein GML-Anwendungsschema.

Zur Implementierung der Komponenten der xPlanBox wurde die Open Source Software deegree eingesetzt, das ein Projekt der OSGeo Foundation ist. Die xPlanBox besteht aus den folgenden Komponenten:

XPlanValidator: Web-Oberfläche für den Validator
XPlanManager: Web-Oberfläche für das Datenmanagement
XPlanWMS: Standard-Karten-Dienst für die Auskunft
XPlanWFS: Standard-Daten-Dienst für die Auskunft (originale Datenstruktur)
XPlanSynWFS: Standard-Daten-Dienst für die Auskunft (vereinfachte Datenstruktur)
XPlanTransformCLI: Kommandozeilenwerkzeug für die Transformation von Plänen

Aktuell werden für Bebauungspläne, Flächennutzungspläne, Landschaftspläne und Raumordnungspläne die XPlanGML Versionen 2.0, 3.0, 4.0, 4.1, 5.0, 5.1, 5.2, 5.3 und 5.4 durch die xPlanBox unterstützt. Für sonstige raumbezogene Planwerke werden die XPlanGML Versionen 5.0, 5.1, 5.2, 5.3 und 5.4 unterstützt.

Die Komponenten der xPlanBox werden in diesem Benutzerhandbuch im Einzelnen erläutert.

3. XPlanValidator

Der XPlanValidator ist ein Tool zur technischen Validierung von

Bebauungsplänen (B-Pläne),
Flächennutzungsplänen (F-Pläne),
Raumordnungsplänen (R-Pläne),
Landschaftsplänen (L-Pläne) und
Sonstigen Plänen (SO-Pläne)

in den XPlanGML Versionen 4.0, 4.1, 5.0, 5.1, 5.2, 5.3 und 5.4.

Die Konformitätsregeln sind für die Version 5.0 und höher optimiert!

XPlanung ist der Standard für die Struktur, den Inhalt und die Form von Daten und Informationen zur Bereitstellung von räumlichen Planwerken der Raumordnung, Landes- und Regionalplanung, Bauleitplanung und Landschaftsplanung. Durch die Anwendung des Standards kann ein verlustfreier Datenaustausch zwischen unterschiedlichen IT-Systemen und Anwendungen gewährleistet werden.

Um die Einhaltung des Standards zu gewährleisten und damit einen Austausch zu ermöglichen, muss eine Validierung der Daten erfolgen.

Der XPlanValidator kann prüfen, ob Daten der XPlanung technisch fehlerfrei sind. Dies ersetzt aber keine inhaltliche und fachliche Prüfung.

3.1. XPlanValidatorWeb

3.1.1. In 3 Schritten zum Validierungsbericht

Schritt 1 – Plan hochladen

Laden Sie Ihren Plan bzw. Planarchiv hoch, indem Sie auf „Datei auswählen“ klicken.

Bitte beachten Sie, dass abhängig von Ihrem Browser, "Datei auswählen" auch "Durchsuchen" o.a. heißen kann.

Vom XPlanValidator werden folgende Dateiformate akzeptiert:

ZIP-Dateien (Dateiendung .zip) mit folgendem Aufbau: Im Basisverzeichnis muss die XPlanGML-Datei mit dem Dateinamen xplan.gml vorhanden sein. Rasterdaten sowie alle im xplan.gml referenzierten Anhänge liegen ebenfalls im Basisverzeichnis der ZIP-Datei. Eine solche ZIP-Datei wird XPlanArchiv genannt.
GML-Dateien (Dateiendung .gml)
XML-Dateien (Dateiendung .xml)

Bitte beachten Sie die Anforderungen an den Dateinamen. Der Dateiname darf nur folgende Zeichen enthalten:

Kleinbuchstaben von a-z
Großbuchstaben von A-Z
Zahlen von 0-9
Bindestriche -
Unterstriche _
Klammern ( und )
Punkte .

Sonderzeichen wie z.B. Umlaute, Zeilenumbrüche und Leerzeichen sind nicht erlaubt.

Die Größe eines Plans hat unmittelbare Auswirkungen auf die Dauer der Validierung.

Schritt 2 – Bezeichnung des Validierungsberichts und Validierungstyp wählen

Wenn Sie einen Plan hochgeladen haben, steht im Feld „Bezeichnung für den Report“ der Name der Datei ohne Endung.

Dateiname als Bezeichner des Validierungsbereichts

Sie können der aktuellen Validierung, falls notwendig, eine beliebige Bezeichnung geben. Diese erscheint ausschließlich auf dem Validierungsbericht.

Vermeiden Sie auch hier Umlaute, Sonderzeichen und/oder Leerzeichen.

In Ihrem Validierungsbericht wird die Bezeichnung wie folgt dargestellt:

Wählen Sie nun unter folgenden Validierungstypen:

Standardmäßig sind alle Validierungstypen selektiert.

1) Semantische Validierung (optional)

Die semantische Validierung überprüft die fachlich-inhaltliche Kohärenz der XPlanGML-Datei. Genauer gesagt wird geprüft, ob die Validierungsregeln der Konformitätsbedingungen in der jeweiligen Version eingehalten wurden.

4.0 (194 Regeln)
4.1 (235 Regeln)
5.0 (178 Regeln)
5.1 (184 Regeln)
5.2 (191 Regeln)
5.3 (195 Regeln)
5.4 (198 Regeln)

Die Konformitätsregeln sind für die Version 5.0 und höher optimiert!

Eine XPlanGML-Datei ist dann zu der jeweiligen XPlanGML Version konform, wenn das XMLDokument gegen das jeweilige XPlanGML Schema validiert und alle in den Konformitätsbedingungen spezifizierten Regeln erfüllt werden.

Folgende Validierungsregeln werden derzeit nicht durch die semantische Validierung geprüft:

4.1.5.3 Ausschluss von gemischter Geometrie (ab Version 5.0)
5.1.5.3 Ausschluss von gemischter Geometrie (ab Version 5.0)
6.1.5.3 Ausschluss von gemischter Geometrie (ab Version 5.0)
7.1.5.2 Ausschluss von gemischter Geometrie
8.1.5.1 Ausschluss von gemischter Geometrie
8.1.7.1 Einschränkung auf Punktgeometrie

Der Ausschluss von gemischter Geometrie ist bereits durch das GML-Profil abgedeckt. Verstöße fallen somit bereits bei der syntaktischen Validierung auf.

Die Regel "8.1.7.1 Die Einschränkung auf Punktgeometrie" bezieht sich auf LP_Punktobjekt. Dabei handelt es sich um eine abstrakte Klasse, für die es keine abgeleiteten Klassen gibt.

2) Geometrische Validierung (optional)

Bei der geometrischen Validierung wird die Korrektheit der Geometrien überprüft. XPlanung bezieht sich auf das Simple Feature Model des OGC. Räumliche Objekte werden hier als Punkte, Linien oder Flächen mit speziellen geometrischen Eigenschaften modellhaft abgebildet. Als Fehler werden z. B. sich überschneidende Polygone identifiziert.

Folgende Prüfungen werden in Abhängigkeit vom Geometrietyp durchgeführt, es handelt sich um die Basis-Geometrischen Prüfungen:

Punkte: Prüfung auf 2D-Koordinaten
Linien: Segment-Kontinuität
Polygone:
- Geschlossenheit (äußere und innere Ringe)
- äußerer Ring: Orientierung im Gegenuhrzeigersinn
- innere Ringe: Orientierung im Uhrzeigersinn
- kein Schnitt äußerer Ring / innere Ringe
- Innere Ringe liegen innerhalb der vom äußeren Ring umschlossenen Fläche
- Schnittmenge der von zwei inneren Ringen gebildeten Flächen ist leer
- keine doppelten Stützpunkte (äußere und innere Ringe)
MultiPolygone:
- kein Schnitt zwischen einzelnen Polygonen
- alle für Polygone geltenden Prüfungen für jedes einzelne Polygon

Nutzung der Optionen

„Geometrische Prüfung der Flächenschlussbedingung (2.2.1.1) überspringen“:
Mit der Option "Prüfung der Flächenschlussbedingung (2.2.1.1) überspringen" kann die Prüfung der Flächenschlussbedingung in Ausnahmefällen deaktiviert werden. Grundsätzlich sollten alle Fehler, die den Flächenschluss betreffen, behoben werden.
„Geometrische Prüfung des Geltungsbereichs (2.2.3.1) überspringen“:
Wenn Fehler im Geltungsbereich, z.B. in Kreisbögen, nicht korrigiert werden können, selektieren Sie in Ausnahmefällen die Option „Geometrische Prüfung des Geltungsbereichs (2.2.3.1) überspringen“. Bei Überlappungen des Geltungsbereiches gilt eine Toleranz von 1 mm. Grundsätzlich sollten alle Fehler, die den Geltungsbereich betreffen, behoben werden.
„Prüfung der Laufrichtung (2.2.2.1) überspringen“:
Bei der Prüfung der Laufrichtung werden Fehler bei der Orientierung von Polygonen ausgegeben. Sollen die Fehler bei der Laufrichtung ignoriert werden, können Sie die Option "Prüfung der Laufrichtung (2.2.2.1) überspringen" aktivieren.

Wenn sich zwei aneinandergrenzende Flächenschlussobjekte an einer Geraden berühren und nur eines der Flächenschlussobjekte einen zusätzlichen Stützpunkt innerhalb dieser Geraden aufweist, wird der fehlende Stützpunkt des anderen Flächenschlussobjekt durch den XPlanValidator nicht gefunden.

3) Syntaktische Validierung (obligatorisch)

Die syntaktische Validierung ist die Voraussetzung für die semantische und geometrische Validierung und ist daher nicht abwählbar.

Bei der syntaktischen Validierung wird die Struktur der XPlanGML-Datei geprüft. Eine syntaktisch valide XPlanGML-Datei muss sowohl den Anforderungen der Wohlgeformtheit von XML entsprechen als auch die vom XPlanGML-Schema definierten Regeln erfüllen.

Die Validierung kann über den Button BT ValidierungStarten gestartet werden.

Schritt 3 – Validierungsergebnis und Validierungsbericht

Das Validierungsergebnis

1) Allgemeine Informationen

Der Kopf des Validierungsberichts gibt Ihnen einen Überblick über die Informationen aus der XPlanGML-Datei sowie das Validierungsergebnis.

Neben dem Namen des XPlanArchivs, des Datums der Validierung sowie der Version der XPlanGML-Datei werden auch die in dem XPlanGML-Dokument enthaltenen Instanzen mit deren Namen sowie externe Referenzen angezeigt, wenn z.B. Rasterdaten in Form von PNG- mit PGW-Dateien im XPlanArchiv hinterlegt sind. Das Validierungsergebnis wird für alle in dem XPlanArchiv enthaltenen Instanzen angezeigt. Es müssen alle Validierungstypen für alle Instanzen fehlerfrei sein, damit das Gesamtergebnis valide ist. Die zu den jeweiligen Validierungstypen detaillierten Validierungsergebnisse werden in den folgenden Abschnitten ausgegeben.

2) Semantische Validierung – valide

Eine valide semantische Prüfung wird Ihnen wie folgt angezeigt.

Die Anzahl der ausgeführten Validierungsregeln variiert in Abhängigkeit der Version der GML-Datei.

3) Semantische Validierung – nicht valide

Am Beispiel der nachfolgenden Abbildung sehen Sie welche Konformitätsbedingung (bzw. Validierungsregel) nicht erfüllt ist.

Die ausgegebene GML-ID gibt Ihnen einen Hinweis, welches Element in der XPlanGML-Datei davon betroffen ist.

4) Geometrische Validierung – valide

Eine valide geometrische Prüfung wird wie folgt angezeigt.

Eine geometrische Validierung kann valide sein, aber dennoch Warnungen enthalten. Warnungen werden angezeigt, wenn z. B. Lücken bei Prüfung der Flächenschlussbedingung gefunden werden.

5) Geometrische Validierung – nicht valide

Fehler werden angezeigt, wenn die geometrischen Validierungsregeln nicht erfüllt sind.

Am Beispiel der nachfolgenden Abbildung sehen Sie, welche Validierungsregeln nicht erfüllt sind.

Die ausgegebene GML-ID gibt Ihnen einen Hinweis, welches Element in der XPlanGML-Datei davon betroffen ist.

6) Syntaktische Validierung – valide

Eine valide syntaktische Prüfung wird wie folgt angezeigt.

7) Syntaktische Validierung – nicht valide

Wenn die syntaktische Validierung nicht valide ist, werden die semantische und die geometrische Validierung nicht durchgeführt und es ist auch keine Kartenvorschau vorhanden.

Der Validierungsbericht

Der Validierungsbericht kann in den Formaten:

HTML
PDF
XML

exportiert werden.

Geometriefehler können zusätzlich auch als Shape-Datei gespeichert werden.

Derzeit werden ausschließlich Schnittpunkte in der Shape-Datei ausgegeben, also die Punkte an denen sich die Umgrenzungslinie der betroffenen Geometrie und die des Geltungsbereichs schneiden. Linienförmige Schnittbereiche werden derzeit nicht ausgegeben.

Alle Ergebnisdateien, selektierte Reports und Geometriefehler, werden in einer ZIP-Datei gespeichert. Der Dateiname entspricht der Bezeichnung des Validierungsdurchlaufs.

Kartenvorschau

Über den Button BT KartenvorschauOeffnen wechseln Sie zur Kartenansicht des Plans. Hier kann eine visuelle Überprüfung des Plans vorgenommen werden.

Der Plan wird zentriert in der Kartenvorschau angezeigt.

Der Plan steht in der Kartenansicht nur für eine begrenzte Zeitspanne (ca. 5 Minuten) zur Verfügung, anschließend ist nur noch die Hintergrundkarte zu sehen.

Die Kartenvorschau visualisiert ausschließlich die Geometrien aus der XPlanGML-Datei. Angehängte Rasterpläne werden nicht dargestellt.

Bei Plänen, die geometrisch nicht valide sind, kann es zu Problemen bei der Darstellung in der Kartenvorschau kommen.

Navigation:

Mit BT Zurueck können Sie die Validierungsoptionen verändern.

Mit BT WeiterenPlan kehren Sie zur Startseite zurück und können einen neuen oder geänderten Plan hochladen.

3.2. XPlanValidatorAPI

Die REST-API des XPlanValidator ermöglicht es, die Funktionen des XPlanValidator über eine Web-API aufzurufen. Die REST-API des XPlanValidator stellt folgende Ressourcen bereit:

Ressource HTTP Methode Beschreibung

Ressource	HTTP Methode	Beschreibung
`/`	`GET`	Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument
`/validate`	`POST`	Validieren eines XPlanGML-Dokuments oder XPlanArchivs
`/info`	`GET`	Informationen zur Software und Konfiguration

/

GET

Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument

/validate

POST

Validieren eines XPlanGML-Dokuments oder XPlanArchivs

/info

GET

Informationen zur Software und Konfiguration

Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI Schnittstellenbeschreibung enthalten.

Die URL für die REST-API des XPlanValidator setzt sich wie folgt zusammen http://<host>:<port>/xplan-api-validator/xvalidator/api/v1/. Die URL für die xPlanBox-Demo lautet https://xplanbox.lat-lon.de/xvalidator/api/v1.

3.3. XPlanValidatorCLI

Analog zum XPlanManagerWeb können XPlanGML-Dokumente mit der Komponente XPlanValidatorCLI über ein Kommandozeilenwerkzeug validiert werden.

3.3.1. Benutzungsanleitung

Beim XPlanValidatorCLI handelt es sich um ein Kommandozeilentool, das parametrisiert aufgerufen wird. Da diese Anwendung bei der Installation in die PATH Variable aufgenommen wird, ist diese von einem beliebigen Ort aufrufbar.

Konfiguration über Datei

In dem Verzeichnis <validator-cli-directory>/etc/ befindet sich die Konfigurationsdatei validatorConfiguration.properties, welche genutzt werden kann, um generelle Konfigurationen an dem Kommandozeilentool durchzuführen.

Über validationReportDirectory=<directory> kann konfiguriert werden, wo die Reports mit dem Validierungsergebnis, die während der Ausführung des Tools generiert werden, abgespeichert werden sollen.

Mit der Option validationRulesDirectory=<directory> kann konfiguriert werden, in welchem Verzeichnis die semantischen Validierungsregeln liegen, die für die Validierung verwendet werden sollen. Erfolgt keine Angabe werden die unter <validator-cli-directory>/etc/rules liegenden semantischen Validierungsregeln verwendet.

Hilfe

Die Hilfe mit den Angaben zu den möglichen Eingabeparametern lässt sich mit dem Parameter help ausgeben.

Aufruf:

./XPlanValidator -help

Ausgabe:

usage: XPlanValidator [-name <arg>] -validate <arg> [-vo <arg>] [-vtype
       <arg>] [-xq <arg>]

   -name <arg>         name of the validation
   -validate <arg>     zip file path
   -vo <arg>           validation options
   -vtype <arg>        values: syntax, geometric, semantic. multiple types must
                       be comma separated

Auswahl XPlanArchiv

Über den Parameter validate <planarchiv> kann der Pfad zum XPlanArchiv auswählt werden, welcher validiert werden soll. Die Angabe des Parameters ist obligatorisch.

Aufruf:

./XPlanValidator -validate Plan.zip

Bezeichnung für den Report

Über den Parameter name <bezeichnung> kann eine Bezeichnung für den generierten Report vergeben werden. Die Angabe des Parameters -name ist optional. Fehlt dieser Parameter, wird der Name des XPlanArchivs verwendet.

Aufruf:

./XPlanValidator -validate Plan.zip -name Validierung

Validierungsart

Die Kommandozeilenschnittstelle des XPlanValidator kann zur Auswahl der Validierungsart parametrisiert aufgerufen werden. Die Angabe des Parameters -vtype ist optional.

Aufruf:

./XPlanValidator -validate Plan.zip -vtype [syntax|geometric|semantic]

Zuordnung der Werte:

syntax = Syntaktisch
geometric = Geometrisch
semantic = Semantisch

Wird kein vtype Parameter gewählt, werden alle Validierungsarten durchgeführt.

Beispiel für eine Ausgabe:

 Configuration directory is ./xplan-validator-cli-5.1-SNAPSHOT/etc
 Configuration is read from file ./xplan-validator-cli-5.1-SNAPSHOT/etc/validatorConfiguration.properties
 -------------------------------------------
 Configuration of the XPlanValidator:
 -------------------------------------------
   validation report directory
    - /var/folders/s5/hwytkj2j2170hx3l29ncw6hh0000gn/T/validationReport12531021004621205039
   validation rules directory
    - internal rules are used
   XPlanValidatorWMS Endpoint
    - null
 -------------------------------------------
...
Ergebnisse der geometrischen Validierung:
Warnungen: 3
   - 2.2.1.1: Das Flaechenschlussobjekt mit der gml id GML_4c5557e0-2015-4ccf-a87a-9d6ef125c8d2 erfuellt die Flaechenschlussbedingung an folgender Stelle nicht, es koennte sich um eine Luecke handeln: (572703.5953,5938215.9377)
   - 2.2.1.1: Das Flaechenschlussobjekt mit der gml id GML_4c5557e0-2015-4ccf-a87a-9d6ef125c8d2 erfuellt die Flaechenschlussbedingung an folgender Stelle nicht, es koennte sich um eine Luecke handeln: (572755.21,5938248.4235)
   - 2.2.1.1: Das Flaechenschlussobjekt mit der gml id GML_4c5557e0-2015-4ccf-a87a-9d6ef125c8d2 erfuellt die Flaechenschlussbedingung an folgender Stelle nicht, es koennte sich um eine Luecke handeln: (572662.528,5938214.726)
...
Geometrie-Fehler: 2
  - Polygon (Zeile 163, Spalte 9): 2.2.2.1: Äußerer Ring verwendet falsche Laufrichtung (CW).
  - Polygon (Zeile 163, Spalte 9): 2.2.2.1: Innerer Ring verwendet falsche Laufrichtung (CCW).
Fortsetzung trotz Geometrie-Fehlern (--force).
...
Geometrische Validierung hat ergeben: Dokument ist nicht valide
Semantische Validierung hat ergeben: Dokument ist valide
Syntaktische Validierung hat ergeben: Dokument ist valide
Archiv mit Validierungsergebnissen wird erstellt.
Archiv mit Validierungsergebnissen wurde unter /var/folders/s5/hwytkj2j2170hx3l29ncw6hh0000gn/T/validationReport12531021004621205039 abgelegt.

Validierungsoption

Die Kommandozeilenschnittstelle des XPlanValidator kann zur Auswahl von zusätzlichen Validierungsoptionen parametrisiert aufgerufen werden. Die Angabe des Parameters -vo ist optional.

Aufruf:

./XPlanValidator -validate Plan.zip -vo skip-flaechenschluss -vo skip-geltungsbereich

Zuordnung der Werte:

skip-flaechenschluss → Geometrische Überprüfung der Flächenschlussbedingung (2.2.1.1) überspringen [ja]
skip-geltungsbereich → Geometrische Überprüfung des Geltungsbereich (2.2.3.1) überspringen [ja]

Validierungsergebnis

Am Ende des Validierungsdurchlaufs wird dem Benutzer der Pfad zu dem Validierungsergebnis ausgegeben. Das Validierungsergebnis wird als HTML, XML sowie PDF in einem Archiv gespeichert. Das Archiv ist nach dem Validierungsdurchlaufs benannt und kann somit leicht identifiziert werden.

4. XPlanManager

4.1. XPlanManager Grundlagen

Der XPlanManager dient zur Verwaltung von XPlanArchiven innerhalb der xPlanBox. Mit dem XPlanManager können XPlanArchive importiert, editiert oder gelöscht werden. Nachdem ein XPlanArchiv erfolgreich über den XPlanManager importiert wurde, können die Daten über die Dienste XPlanWFS und XPlanWMS abgerufen werden. Im folgenden Abschnitt werden die Anforderungen an ein XPlanArchiv beschrieben.

4.1.1. Das XPlanArchiv

Das XPlanArchiv ist eine ZIP-Datei mit folgendem Aufbau:

Im Basisverzeichnis muss die XPlanGML-Datei mit dem Dateinamen xplan.gml vorhanden sein.
Rasterdaten, die in der XPlanGML-Datei referenziert sind, müssen ebenfalls im Basisverzeichnis der ZIP-Datei liegen, siehe dazu auch Referenzierung von Rasterdaten im XPlanGML.
Alle anderen in der XPlanGML-Datei referenzierten Anhänge müssen entweder im Basisverzeichnis der ZIP-Datei liegen oder werden über einen Link auf eine externe Datei (URL) referenziert.

Wichtig: Dateinamen dürfen keine Sonderzeichen wie z. B. &, # , /, \, ", ' (doppeltes oder einfaches Anführungszeichen), Leerzeichen oder auch Umlaute beinhalten. Gross- und Kleinschreibung in den Dateinamen (auch der Dateiendung) werden berücksichtigt und müssen vollständig mit den Referenzen im Dokument übereinstimmen!

4.1.2. Das XPlanGML-Dokument

Das XPlanGML-Dokument muss folgende Eigenschaften aufweisen:

Das XPlanGML-Dokument ist wohlgeformt und hat den Dateinamen xplan.gml.
Das XPlanGML-Dokument beinhaltet nur ein oder mehrere Elemente vom Typ <xplan:XP_PLAN/>. Beinhaltet eine Datei mehrere dieser Elemente, so dürfen keine nicht referenzierte Features im XPlanGML-Dokument vorkommen, wie z.B. ein freies Präsentationsobjekt ohne Bezug zum Bereich!
Wenn das XPlanGML-Dokument mehrere BP_Bereich-Elemente beinhaltet, muss das Element nummer für jeden BP_Bereich eindeutig sein.

4.1.3. Anlegen von deegree Konfigurationsstrukturen für Rasterdaten

Beim Import von XPlanGML-Rasterdaten werden in der Datenbasis Konfigurationen angelegt, welche die Visualisierung der Rasterdaten im XPlanWMS ermöglichen.

Für jede importierte Rasterdatei werden folgende Konfigurationen angelegt:

eine Konfigurationsdatei für einen GeoTiffTileStore oder GDALTileStore,
eine Konfigurationsdatei für einen TileLayer und
in der Ebenenbaum-Konfiguration wird ein neuer Layer in die Kategorieebene eingefügt, die die Rasterpläne nach Datum sortiert beinhaltet.

Referenzierung von Rasterdaten im XPlanGML

Die Rasterdaten müssen mit in dem XPlanArchiv enthalten sein und neben der Datei xplan.gml liegen.

Innerhalb des XPlanGML müssen die Rasterdateien wie folgt referenziert sein:

XPlanGML 3:

Rasterdateien werden im Feature Type XP_RasterplanBasis, XP_RasterplanAenderung, BP_RasterplanAenderung oder FP_RasterplanAenderung über einen xlink referenziert:

gml:featureMember
  xplan:XP_RasterplanBasis
  (oder) xplan:XP_RasterplanAenderung
  (oder) xplan:BP_RasterplanAenderung
  (oder) xplan:FP_RasterplanAenderung
    xplan:refScan (mit xlink Attribut)

xlink zeigt auf den Feature Type XP_ExterneReferenz oder XP_ExterneReferenzPlan:

gml:featureMember
  xplan:XP_ExterneReferenz
  (oder) xplan:XP_ExterneReferenzPlan (nur XPlanGML 3) (jeweils mit id Attribut)
    xplan:referenzName
    xplan:referenzURL
    xplan:referenzMimeType
    xplan:georefURL (falls Feature Type XP_ExterneReferenzPlan, nur XPlanGML 3)
    xplan:georefMimeType (falls Feature Type XP_ExterneReferenzPlan, nur XPlanGML 3)

Das Element <referenzURL/> beinhaltet die relative Referenz auf die Rasterdatei. Beispiel:

<gml:featureMember>
    <xplan:XP_ExterneReferenzPlan gml:id="GML_1234567890">
        <xplan:referenzName>rasterdatei</xplan:referenzName>
        <xplan:referenzURL>rasterdatei.tif</xplan:referenzURL>
        <xplan:georefURL>rasterdatei.tfw</xplan:georefURL>
    </xplan:XP_ExterneReferenzPlan>
</gml:featureMember>

XPlanGML 4.x:

Rasterdateien werden im Feature Type XP_RasterplanBasis, XP_RasterplanAenderung, BP_RasterplanAenderung, FP_RasterplanAenderung, LP_RasterplanAenderung oder RP_RasterplanAenderung referenziert:

gml:featureMember
  xplan:XP_RasterplanBasis
  (oder) xplan:XP_RasterplanAenderung
  (oder) xplan:BP_RasterplanAenderung
  (oder) xplan:FP_RasterplanAenderung
  (oder) xplan:LP_RasterplanAenderung
  (oder) xplan:RP_RasterplanAenderung
    xplan:refScan (kann auch mehrfach vorkommen)
      xplan:XP_ExterneReferenz
        xplan:georefURL
        xplan:art
        xplan:referenzName
        xplan:referenzURL

Das Element <refScan/> kann beliebig häufig vorkommen. Das Element <referenzURL/> beinhaltet die relative Referenz auf die Rasterdatei. Beispiel:

<gml:featureMember>
    <xplan:XP_RasterplanBasis gml:id="FEATURE_1234567890">
        <xplan:refScan>
            <xplan:XP_ExterneReferenz>
                <xplan:georefURL>rasterdatei.tfw</xplan:georefURL>
                <xplan:art>PlanMitGeoreferenz</xplan:art>
                <xplan:referenzName>rasterdatei</xplan:referenzName>
                <xplan:referenzURL>rasterdatei.tif</xplan:referenzURL>
            </xplan:XP_ExterneReferenz>
        </xplan:refScan>
    </xplan:XP_RasterplanBasis>
</gml:featureMember>

XPlanGML 5.x:

Rasterdateien werden im Feature Type XP_Rasterdarstellung referenziert:

gml:featureMember
  xplan:XP_Rasterdarstellung
    xplan:refScan (kann auch mehrfach vorkommen)
      xplan:XP_ExterneReferenz
        xplan:georefURL
        xplan:art
        xplan:referenzName
        xplan:referenzURL

Das Element <refScan/> kann beliebig häufig vorkommen. Das Element <referenzURL/> beinhaltet die relative Referenz auf die Rasterdatei. Beispiel:

<gml:featureMember>
    <xplan:XP_Rasterdarstellung gml:id="FEATURE_1234567890">
        <xplan:refScan>
            <xplan:XP_ExterneReferenz>
                <xplan:georefURL>rasterdatei.tfw</xplan:georefURL>
                <xplan:art>PlanMitGeoreferenz</xplan:art>
                <xplan:referenzName>rasterdatei</xplan:referenzName>
                <xplan:referenzURL>rasterdatei.tif</xplan:referenzURL>
            </xplan:XP_ExterneReferenz>
        </xplan:refScan>
    </xplan:XP_Rasterdarstellung>
</gml:featureMember>

In XPlanGML 5.1, 5.2, 5.3 und 5.4 ist diese Referenzierung als veraltet notiert. Stattdessen werden Rasterdateien über die von XP_Bereich abgeleiteten Feature Types über das Element <refScan/> referenziert (im folgendem Beispiel BP_Bereich):

gml:featureMember
  xplan:BP_Bereich
    xplan:refScan (kann auch mehrfach vorkommen)
      xplan:XP_ExterneReferenz
        xplan:georefURL
        xplan:art
        xplan:referenzName
        xplan:referenzURL

Das Element <refScan/> kann beliebig häufig vorkommen. Das Element <referenzURL/> beinhaltet die relative Referenz auf die Rasterdatei. Beispiel:

<gml:featureMember>
    <xplan:BP_Bereich gml:id="FEATURE_1234567890">
        ...
        <xplan:refScan>
            <xplan:XP_ExterneReferenz>
                <xplan:georefURL>rasterdatei.tfw</xplan:georefURL>
                <xplan:art>PlanMitGeoreferenz</xplan:art>
                <xplan:referenzName>rasterdatei</xplan:referenzName>
                <xplan:referenzURL>rasterdatei.tif</xplan:referenzURL>
            </xplan:XP_ExterneReferenz>
        </xplan:refScan>
        ...
    </xplan:BP_Bereich>
</gml:featureMember>

Ab Version 6.0 wird nur noch die zweite Variante über das Element <refScan/> unterstützt.

Über die Editor-Funktion des XPlanManager können Rasterdaten über XP_RasterplanBasis oder über das Element <refScan/> innerhalb eines von XP_Bereich abgeleiteten Feature Type angezeigt werden. Weitere Informationen dazu auch im Kapitel Editieren.

Voraussetzungen für die Rasterdaten

Um Rasterdaten importieren und diese über den XPlanWMS-Ebene zur Verfügung stellen zu können, müssen die Daten folgende Anforderungen erfüllen.

Die Unterstützung verschiedener Rasterdatenformate ist vom gesetzten Raster-Konfigurationstyp abhängig.

Wichtig: Dies kann nur zentral für die xPlanBox konfiguriert und nicht durch den Nutzer geändert werden. Hinweise zur Konfiguration sind im Betriebshandbuch zu finden.

Unterschieden wird dabei zwischen den Konfigurationstypen GeoTiff und GDAL:

GeoTiff - Konfigurationstyp:

Es werden ausschließlich Rasterdaten im GeoTiff Format unterstützt.

GDAL - Konfigurationstyp:

Grundsätzlich können alle durch GDAL unterstützten Rasterdatenformate auch durch deegree und somit dem XPlanManager verarbeitet werden.
Getestet wurden bisher nur die Formate GeoTiff und PNG.

Folgende Voraussetzung werden an die einzelnen Formate gestellt:

GeoTiff:

GeoTiff-Dateien liegen als gekachelte GeoTiff-Dateien vor.
GeoTiff-Dateien liegen in dem Koordinatenreferenzsystem vor, welches für den XPlanManager konfiguriert ist.
GeoTiff-Dateien enthalten ihre räumliche Ausdehnung als Metatags innerhalb der Datei.
Zur Optimierung der Antwortzeit beim Zugriff auf die GeoTiff-Dateien wird empfohlen, in den GeoTiff-Dateien Overlays mit niedriger Auflösung hinzuzufügen.

PNG:

Farbmodell (RGB) mit ein, drei oder vier Bändern.
Farbtiefe ist 8bit, 16bit oder 256 indizierten Farben im Farbpalettenmodus.
Transparenz ist als Alphakanal je Band (RGBA) oder als "NoData Value" angegeben.
PNG-Dateien liegen in dem Koordinatenreferenzsystem vor, welches für den XPlanManager konfiguriert ist.
PNG-Dateien enthalten ihre räumliche Ausdehnung in einer ausgelagerten PGW-Datei (PNG World File).
Wenn das Kommandozeilentool XPlanManagerCLI verwendet wird, muss in der Datei aux.xml das Koordinatenreferenzsystem der PNG-Datei definiert sein. Für den XPlanManagerWeb ist dies keine Voraussetzung, da der Fachadministrator beim Import der Daten das Koordinatenreferenzsystem der PNG-Datei über einen Dialog bestätigen kann.

4.2. XPlanManagerWeb

Die Komponente XPlanManagerWeb ist eine Web-Oberfläche, die dem Fachadministrator der xPlanBox ermöglicht, die Datenhaltung zu kontrollieren und zu verwalten. Mit dem XPlanManagerWeb kann der Benutzer XPlanArchive in die Datenhaltung laden, diese editieren, löschen sowie bereits importiere XPlanArchive wieder exportieren und in einer Liste anzeigen.

4.2.1. Einstiegsseite

Die Webanwendung XPlanManagerWeb dient der Verwaltung von XPlanArchiven und ist unter:

http://<host>:<port>/xplan-manager-web/

verfügbar und kann mit einem Web-Browser aufgerufen werden.

4.2.2. Funktionen des XPlanManagerWeb

Hilfe

Die Hilfe mit den Angaben zu den möglichen Funktionen lässt sich durch Betätigen des Buttons Hilfe ausgeben.

Hinzufügen

Vor dem Importieren eines XPlanGML-Dokuments in die Datenhaltung, muss dieser über die Web-Oberfläche hochgeladen werden. Hierfür kann der Plan über den Button Durchsuchen ausgewählt und durch einen Klick auf Import hochgeladen werden. Der Benutzer wird über das erfolgreiche bzw. fehlerhafte Hinzufügen des Plans in Form eines PopUp-Fensters informiert.

Nachdem der Plan hochgeladen wurde, kann dieser validiert bzw. entfernt werden. Erst nachdem der Plan erfolgreich validiert wurde, kann der Plan in die Datenbasis importiert werden. Andernfalls ist der Button Import deaktiviert.

Bei der Validierung werden immer die syntaktische und Basis-Geometrische Prüfung (s. Abschnitt geometrische Validierung) ausgeführt. Diese stellen sicher, dass ein Plan keine schwerwiegenden Fehler hat, die einen Import verhindern würden. Um die automatische Korrektur der Laufrichtung von Polygonen beim Import zu erzwingen, muss die Option "Prüfung der Laufrichtung (2.2.2.1) überspringen" aktiviert sein.

Import

Nachdem der Plan erfolgreich validiert wurde, kann der Plan durch einen Klick auf den Button Import in die Datenbasis importiert werden. Der Benutzer wird über den erfolgreichen bzw. fehlerhaften Import des Plans in Form eines PopUps informiert.

Auflistung

Standardmäßig werden alle importierten Pläne in einer Liste angezeigt. Diese Liste kann nach den angezeigen Spaltennamen auf- oder absteigend sortiert werden.

Filter

Diese Liste kann auch nach verschiedenen Kriterien gefiltert werden. Neben dem Filter nach "Gemeinde" und "Planstatus" kann über den freien Filer die Anzeige der Pläne im XPlanManager reduziert werden. Mit dem Button "Alle Pläne anzeigen" können alle Filter aufgehoben werden und alle Pläne werden wieder angezeigt.

Kartenvorschau

Durch den Klick auf den Button Kartenvorschau öffnet sich ein neues Fenster, indem der XPlan visualisiert wird. Im Hintergrund befindet sich eine Hintergrundkarte. Durch den Klick auf Schließen wird die Kartenvorschau wieder geschlossen.

Die Kartenvorschau verwendet den Browser-Cache. Falls in der Kartenvorschau nicht der aktuelle Status des Plans angezeigt wird, muss der Cache des genutzten Web-Browsers gelöscht werden.

Herunterladen

Die importierten Pläne können vom Benutzer durch den Klick auf den Button Herunterladen wieder als XPlanArchiv heruntergeladen werden.

Löschen

Je nach Benutzerrechten können die importierten Pläne durch den Klick auf den Button Löschen aus der Datenbasis gelöscht werden. Hat ein Benutzer keine Rechte, so wird der Button grau dargestellt.

Editieren

Abhängig von den Benutzerrechten können Pläne editiert werden. Fehlen dem Benutzer die entsprechenden Rechte ist die Funktion deaktiviert und der Button Editieren wird grau dargestellt. Die Editieransicht öffnet sich durch Klick auf den Button Editieren. Die Ansicht ist in verschiedene Bereiche aufgeteilt, die insgesamt die Bearbeitung folgender Elemente zulässt:

Basisdaten

name
beschreibung
technHerstellDatum
untergangsDatum
planArt
sonstPlanArt
verfahren
rechtsstand
rechtsverordnungsDatum

Das Editieren des Rechtsstands kann dazu führen, dass eine Zustandsänderung des Plans eintritt. Damit verbunden ist das Verschieben der Vektor- und Rasterdaten in die entsprechende Datenhaltung. Übergänge sind beliebig zwischen den drei Zuständen 'Festgestellt', 'In Aufstellung' und 'Archiviert' möglich. Eine Zustandsänderung von 'Festgestellt' nach 'In Aufstellung' tritt beispielsweise beim Ändern des Rechtsstands von 'InkraftGetreten' nach 'Untergegangen' ein.

Beim Import kann der Nutzer den Zustand eines Planes über eine Auswahlliste mit den Optionen 'Festgestellt', 'In Aufstellung' und 'Archiviert' ändern. Abhängig von dem im Plan gesetzten Rechtsstand wird eine Vorauswahl getroffen, die der Nutzer aber ändern kann. Beim Öffnen der Editieransicht wird der Rechtsstand aus dem Plan angezeigt und nicht der vom Nutzer zum Zeitpunkt des Imports ausgewählte Rechtsstand. Somit entspricht die Anzeige des Rechtsstands im Editor nicht dem Zustand des Plans, falls dieser beim Import geändert wurde. Beim Abspeichern von Änderungen ist somit Vorsicht geboten, da es so unbeabsichtigt zu einer Zustandsänderung des Plans kommen kann!

Gültigkeitszeitraum

Der Zeitraum in dem ein Plan gültig ist. Für dieses Feld gibt es keine Entsprechung im XPlanGML. Die Angabe des Zeitraums, wie sie beim Import erfolgt ist, wird beim Ändern des Zeitraums überschrieben.

Änderungen

aendert
wurdeGeaendertVon

Texte

texte

Dokumente

Abhängig von der XPlanGML Version können folgende Dokumente editiert werden:

XPlanGML 3.0:

refBegruendung

XPlanGML 4.1:

refBegruendung
refRechtsplan
refGruenordnungsplan

XPlanGML 5.x:

alle verfügbaren Typen aus XP_ExterneReferenzTyp (Enumeration)

Dabei kann der Benutzer wählen, ob er eine Datei über einen vollqualifizierten Link (URL) referenziert oder zum XPlanArchiv hinzugefügt und dann relativ verlinkt.

Rasterbasis

rasterbasis

Die Rasterbasis kann nur editiert werden, wenn ein Plan ein Objekt vom Typ BP_Bereich besitzt. Ist dies nicht der Fall, wird ein entsprechender Hinweis in der Oberfläche angegeben. Die Angabe einer Rasterbasis kann in diesem Fall nicht erfolgen.

Wie im Abschnitt Referenzierung von Rasterdaten im XPlanGML beschrieben, sind in den Versionen 5.1, 5.2, 5.3 und 5.4 zwei Varianten zur Referenzierung von Rasterdaten möglich. Die Anzeige im XPlanManager unterstützt die alte und die neue Variante. Wird über den XPlanManager eine Referenz geändert, dann erfolgt die Referenzierung immer über das Element <refScan/> unabhängig von der im Plan ursprünglich verwendeten Referenzierung.

Werden Referenzen auf Rasterbasisdateien entfernt oder verändert, so werden die nicht mehr referenzierten Dateien aus der Datenhaltung entfernt. Änderungen führen zu einer Aktualisierung der XPlanWMS-Konfiguration. Klickt der Nutzer auf Speichern, wird zunächst eine Validierung der Rasterdaten vorgenommen. Bei invaliden Dateien bekommt der Nutzer eine Entscheidungsoption wie mit diesen Daten umgegangen werden soll. Passt das CRS der Rasterdaten nicht mit dem CRS der Rasterdatenhaltung überein, so erhält der Nutzer die Option, den Plan ohne Erzeugung der Rasterkonfiguration zu importieren. Anschließend erfolgt die Aktualisierung der Daten.

Die ebenfalls in diesem Abschnitt editierbaren Referenzen auf Texte (refText) und Legenden (refLegende) müssen in den Versionen 5.1, 5.2, 5.3 und 5.4 über die Abschnitte Texte und Dokumente editiert werden.

Die Editierfunktion steht nur für BPläne in den XPlanGML Versionen 3.0, 4.1, 5.0, 5.1, 5.2, 5.3 und 5.4 zur Verfügung.

Bereitstellung als INSPIRE PLU Datensatz

Abhängig von den Benutzerrechten können Pläne im Datenthema INSPIRE Planned Land Use veröffentlicht werden. Fehlen dem Benutzer die entsprechenden Rechte ist die Funktion deaktiviert und der Button Bereitstellung als INSPIRE Datensatz wird nicht dargestellt.

Durch Klick auf den Button Bereitstellung als INSPIRE Datensatz wird der Plan in das INSPIRE PLU Datenschema überführt und in den INSPIRE konformen Download Service importiert. Anschließend kann der transformierte Plan über den INSPIRE Download Service (XPlanInspirePluWFS) und INSPIRE View Service (XPlanInspirePluWMS) abgerufen werden.

Die Bereitstellung als INSPIRE PLU Datensatz steht nur für BPläne in den XPlanGML Versionen 4.1, 5.0, 5.1, 5.2, 5.3 und 5.4 zur Verfügung.

4.3. XPlanManagerAPI

Die REST-API des XPlanManager ermöglicht es, die Funktionen des XPlanManager über eine Web-API aufzurufen. Bei der Festlegung der Ressourcen wurden Begriffe aus drei Domänen verwendet. Die REST API Ressourcen wie z.B. /plan oder /info sind in Englisch und der Einstiegspunkt für eine Entität. Ressourcen unterhalb einer Entität wie z.B. /plan/{planId}/aenderung oder /plan/{planId}/gueltigkeit sind in Deutsch und aus der Oberfläche des XPlanManagerWeb abgeleitet. Die verwendeten Datentypen sind ebenfalls in Deutsch und aus den Bezeichnern des XPlanung-Datenmodells (XPlanGML-Applikationsschema) abgeleitet. Bezeichner wie z. B. {planId} in einer Ressource sind Variablen und müssen durch entsprechende Werte ausgetauscht werden. Folgende Variablen werden in der API verwendet:

{planId} - eindeutiger Schlüssel eines Plans (numerischer Wert, z.B. 10)
{planName} - eindeutiger Name eines Plans (alphanumerischer Wert, z.B. HafenCity14)
{name} - Name oder Suchtext (alphanumerischer Wert, z.B. Hafen )
{id} - eindeutiger Schlüssel einer Ressource (alphanumerischer Wert, Beispiele siehe Abschnitt eindeutige Schlüssel)

Die REST-API des XPlanManager stellt folgende Ressourcen bereit:

Ressource HTTP Methode Beschreibung

Ressource	HTTP Methode	Beschreibung
`/`	`GET`	Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument
`/info`	`GET`	Informationen zur xPlanBox Version und aktiven Konfiguration
`/plan`	`POST`	Importieren eines XPlanGML-Dokuments oder XPlanArchivs
`/plan/{planId}`	`GET`	Abfrage der Daten zu einem XPlanArchiv über PlanID
`/plan/{planId}`	`DELETE`	Löschen eines XPlanArchivs
`/plan/name/{planName}`	`GET`	Abfrage der Daten zu einem XPlanArchiv über den Plannamen
`/plans?planName={name}`	`GET`	Suche nach XPlanArchiven über den Plannamen
`/plan/{planId}/basisdaten`	`GET`	Abfrage von Basisdaten zu einem Plan
`/plan/{planId}/basisdaten`	`PUT`	Hinzufügen/ersetzen von Basisdaten zu einem Plan
`/plan/{planId}/gueltigkeit`	`GET`	Abfrage des Gültigkeitzeitraums zu einem Plan
`/plan/{planId}/gueltigkeit`	`PUT`	Hinzufügen/ersetzen des Gültigkeitzeitraums zu einem Plan
`/plan/{planId}/aenderungen`	`GET`	Abfrage von Änderungen zu einem Plan
`/plan/{planId}/aenderungen`	`PUT`	Hinzufügen von Änderungen zu einem Plan
`/plan/{planId}/dokument`	`GET`	Abfrage von Dokumenten zu einem Plan
`/plan/{planId}/dokument`	`POST`	Hinzufügen/ersetzen von Dokumenten zu einem Plan
`/plan/{planId}/dokument/{id}`	`GET`	Abfrage eines Dokuments zu einem Plan
`/plan/{planId}/dokument/{id}`	`PUT`	Hinzufügen/ersetzen eines Dokuments zu einem Plan
`/plan/{planId}/dokument/{id}`	`DELETE`	Entfernen eines Dokuments zu einem Plan
`/plan/{planId}/text`	`GET`	Abfrage von Texten zu einem Plan
`/plan/{planId}/text`	`POST`	Hinzufügen von Texten zu einem Plan
`/plan/{planId}/text/{id}`	`GET`	Abfrage eines Texts zu einem Plan
`/plan/{planId}/text/{id}`	`PUT`	Hinzufügen/ersetzen eines Texts zu einem Plan
`/plan/{planId}/rasterbasis`	`GET`	Abfrage von Rasterbasisdateien zu einem Plan
`/plan/{planId}/rasterbasis`	`PUT`	Hinzufügen von Rasterbasisdateien zu einem Plan
`/plan/{planId}/rasterbasis/{id}`	`GET`	Abfrage einer Rasterbasisdatei zu einem Plan
`/plan/{planId}/rasterbasis/{id}`	`PUT`	Hinzufügen/ersetzen einer Rasterbasisdatei zu einem Plan
`/plan/{planId}/rasterbasis/{id}`	`DELETE`	Entfernen einer Rasterbasisdatei zu einem Plan

/

GET

Beschreibung der Schnittstelle als OpenAPI 3.0 Dokument

/info

GET

Informationen zur xPlanBox Version und aktiven Konfiguration

/plan

POST

Importieren eines XPlanGML-Dokuments oder XPlanArchivs

/plan/{planId}

GET

Abfrage der Daten zu einem XPlanArchiv über PlanID

/plan/{planId}

DELETE

Löschen eines XPlanArchivs

/plan/name/{planName}

GET

Abfrage der Daten zu einem XPlanArchiv über den Plannamen

/plans?planName={name}

GET

Suche nach XPlanArchiven über den Plannamen

/plan/{planId}/basisdaten

GET

Abfrage von Basisdaten zu einem Plan

/plan/{planId}/basisdaten

PUT

Hinzufügen/ersetzen von Basisdaten zu einem Plan

/plan/{planId}/gueltigkeit

GET

Abfrage des Gültigkeitzeitraums zu einem Plan

/plan/{planId}/gueltigkeit

PUT

Hinzufügen/ersetzen des Gültigkeitzeitraums zu einem Plan

/plan/{planId}/aenderungen

GET

Abfrage von Änderungen zu einem Plan

/plan/{planId}/aenderungen

PUT

Hinzufügen von Änderungen zu einem Plan

/plan/{planId}/dokument

GET

Abfrage von Dokumenten zu einem Plan

/plan/{planId}/dokument

POST

Hinzufügen/ersetzen von Dokumenten zu einem Plan

/plan/{planId}/dokument/{id}

GET

Abfrage eines Dokuments zu einem Plan

/plan/{planId}/dokument/{id}

PUT

Hinzufügen/ersetzen eines Dokuments zu einem Plan

/plan/{planId}/dokument/{id}

DELETE

Entfernen eines Dokuments zu einem Plan

/plan/{planId}/text

GET

Abfrage von Texten zu einem Plan

/plan/{planId}/text

POST

Hinzufügen von Texten zu einem Plan

/plan/{planId}/text/{id}

GET

Abfrage eines Texts zu einem Plan

/plan/{planId}/text/{id}

PUT

Hinzufügen/ersetzen eines Texts zu einem Plan

/plan/{planId}/rasterbasis

GET

Abfrage von Rasterbasisdateien zu einem Plan

/plan/{planId}/rasterbasis

PUT

Hinzufügen von Rasterbasisdateien zu einem Plan

/plan/{planId}/rasterbasis/{id}

GET

Abfrage einer Rasterbasisdatei zu einem Plan

/plan/{planId}/rasterbasis/{id}

PUT

Hinzufügen/ersetzen einer Rasterbasisdatei zu einem Plan

/plan/{planId}/rasterbasis/{id}

DELETE

Entfernen einer Rasterbasisdatei zu einem Plan

Neben dem Datenformat JSON unterstützt die REST API auch andere Inhaltstypen, die das Datenformat JSON (Inhaltstyp application/json) genauer beschreiben. Im Rahmen der Inhaltsvereinbarung zwischen Client und Server über das HTTP-Header-Feld Accept können auch die Inhaltstypen (media types) application/vnd.xplanbox.api+json, application/vnd.xplanbox.api.v1+json und application/vnd.xplanbox.api.v2+json angefragt werden. Einzelne Ressourcen wie z.B. POST /plan unterstützen diese anwendungsspezifischen Datentypen.

Eine vollständige Beschreibung der HTTP Status-Codes und der unterstützten Inhaltstypen (media types) und Formate (Encodings) für die jeweiligen Ressourcen sind in der OpenAPI Schnittstellenbeschreibung enthalten.

Die URL für die REST-API des XPlanManager setzt sich wie folgt zusammen: http://<host>:<port>/xplan-api-manager/xmanager/api/v1/. Die URL für die xPlanBox-Demo lautet https://xplanbox.lat-lon.de/xmanager/api/v1/.

Die alte REST-API mit den Ressourcen /xplanmgrweb/rest/manager/plans und /xplanmgrweb/rest/manager/plan/{planId} wird durch die neue API komplett ersetzt und in einer zukünftigen Version der xPlanBox entfernt!

4.3.1. Eindeutige Schlüssel für den Zugriff auf REST Ressourcen

Um den Zugriff auf externe Dokumente zu ermöglichen, die über Referenzen in dem XPlanGML-Dokument definiert sind, wurden folgende Konventionen für die Bestimmung eines eindeutigen Schlüssels festgelegt. Diese Konventionen müssen von einem XPlanArchiv erfüllt werden, wenn dieses über die REST API bearbeitet werden soll. Im Folgenden sind die Konventionen am Beispiel der Planart "BPlan" und die jeweilige XPlanGML Version aufgeführt.

Ressource: /plan/{planId}/text/{id}

XPlanGML Version	Element	ID
4.1	BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType)	GML ID
5.0	BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType)	GML ID
5.1	BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType)	GML ID
5.2	BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType)	GML ID
5.3	BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType)	GML ID
5.4	BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType)	GML ID
6.0	BP_Plan/texte ⇒ BP_TextAbschnitt (FeatureType)	GML ID

XPlanGML Version

Element

4.1