# HG changeset patch
# User Sascha L. Teichmann <sascha.teichmann@intevation.de>
# Date 1346008676 0
# Node ID 70c41c5493b6678c509f0d461e14aebbdd9079ea
# Parent  0bd5e327afb04bf239e764018d8e7f41d2e7d7b8
backend: Importer: Documented the classification of the annotations.


flys-backend/trunk@5268 c6561f87-3c4e-4783-a992-168aeb5c3f6f

diff -r 0bd5e327afb0 -r 70c41c5493b6 flys-backend/ChangeLog
--- a/flys-backend/ChangeLog	Sun Aug 26 18:36:30 2012 +0000
+++ b/flys-backend/ChangeLog	Sun Aug 26 19:17:56 2012 +0000
@@ -1,3 +1,7 @@
+2012-08-24	Sascha L. Teichmann	<sascha.teichmann@intevation.de>
+
+	* doc/README.txt: Documented the classification of the annotations.
+
 2012-08-26	Sascha L. Teichmann	<sascha.teichmann@intevation.de>
 
 	* doc/README.txt: Documented the db credentials.
diff -r 0bd5e327afb0 -r 70c41c5493b6 flys-backend/doc/README.txt
--- a/flys-backend/doc/README.txt	Sun Aug 26 18:36:30 2012 +0000
+++ b/flys-backend/doc/README.txt	Sun Aug 26 19:17:56 2012 +0000
@@ -37,7 +37,11 @@
   Der Import kann mit '-Dflys.backend.importer.skip.annotations=true'
   unterdrückt werden.
 
-  TODO SLT: flys.backend.importer.annotation.types erklären!
+  Zur Klassifikation von Streckenfavoriten kann mit
+  -Dflys.backend.importer.annotation.types=DATEI
+  der Pfad zu einer XML-Datei angegeben werden, in der über
+  Regeln festgelegt wird, wie diese geschehen soll.
+  Details hierzu im Anhang 'Klassifikation von Streckenfavoriten'.
 
 - Pegel, Stammdaten (*.glt, *.sta-Dateien):
   Der Import kann mit '-Dflys.backend.importer.skip.gauges=true'
@@ -137,8 +141,62 @@
     den Import der HYKs und PRFs verhindern). Dann die HYKs (mit flys.backend.importer.skip.*
     der anderen Daten) und im finalen Schritt dann die PRFs.
 
-Anhang Fehler und Warnungen:
-============================
+Anhang 'Klassifikation von Streckenfavoriten'
+---------------------------------------------
+Streckenfavoriten werden aus KM-Dateien importiert. Um die einzelnen Einträge
+eine Kategorie (Brücken, Pegel, etc.) zuzuordnen, kann eine XML angegeben werden,
+in der Regeln für diese Klassifikation definiert werden. Schematisch gliedert
+sich diese Datei in die zwei Bereiche 'types' und 'patterns':
+
+<annotation>
+    <types> ...  </types>
+    <patterns> ...  </patterns>
+</annotation>
+
+In der Sektion 'types' werden die Kategorien vereinbart, in die
+klassifiziert werden sollen. Die geschieht mit einzelnen
+
+  <type name="Pegel"/>
+  <type name="Brücke"/>
+  ...
+  <type name="Sonstige" default="true"/>
+
+Das Attribut 'default' kann einmal vergeben werden und
+besagt, dass diese Kategorie gewählt werden soll, wenn
+keine andere Kategorie zugeordnet werden kann.
+
+In der Sektion 'patterns' werden dann die Regel
+definiert, die einzelne Einträge den definierten Kategorien
+zuordnet. Hierfür können zwei Arten von Definitionen
+angegeben werden:
+
+  <file pattern="^Brücken$" type="Brücke"/>
+
+oder
+
+  <line pattern="^Brücke[:\s].*$" type="Brücke"/>
+
+Die erste Variante bestimmt die Kategorie, die pro KM-Datei
+gelten soll. 'pattern' ist hierbei ein regulärer Ausdruck,
+der auf den Dateinamen angewandt wird. Passt der Name
+der Datei auf den regulären Ausdruck, wird 'type' als
+Vorgabe angenommen. Treffen mehrere <file>-Regeln zu,
+wird der erste Treffer angewandt. Findet keine der <file>-Regeln
+Anwendung, wird die Kategorie ausgewählt, die in der <types>-Section
+das Attribut 'default' gesetzt hat.
+
+Die zweite Regel-Variante <line> wird auf jeden Eintrag
+innerhalb einer KM-Datei auf den Bezeichner der Streckenfavoriten
+angewandt. Als Muster dient auch hier ein regulärer Ausdruck,
+der über das Attribut 'pattern' definiert wird. Die Kategorie
+wird in Trefferfall über das Attribut 'type' bestimmt. Treffen
+mehrere Regeln zu, wird die Kategorie gewählt, die zum ersten
+Treffer gehört. Trifft keine Regel zu wird der Eintrag der
+Kategorie zugeteilt, die für die beinhaltende Datei als Vorgabe
+gilt.
+
+Anhang 'Fehler und Warnungen':
+=============================
 
 Fehler:
 -------