Mercurial > dive4elements > river
comparison flys-backend/doc/README.txt @ 3664:70c41c5493b6
backend: Importer: Documented the classification of the annotations.
flys-backend/trunk@5268 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
|---|---|
| date | Sun, 26 Aug 2012 19:17:56 +0000 |
| parents | 0bd5e327afb0 |
| children | 0b0522bf51b6 |
comparison
equal
deleted
inserted
replaced
| 3663:0bd5e327afb0 | 3664:70c41c5493b6 |
|---|---|
| 35 | 35 |
| 36 - Streckenfavoriten (*.km-Dateien) | 36 - Streckenfavoriten (*.km-Dateien) |
| 37 Der Import kann mit '-Dflys.backend.importer.skip.annotations=true' | 37 Der Import kann mit '-Dflys.backend.importer.skip.annotations=true' |
| 38 unterdrückt werden. | 38 unterdrückt werden. |
| 39 | 39 |
| 40 TODO SLT: flys.backend.importer.annotation.types erklären! | 40 Zur Klassifikation von Streckenfavoriten kann mit |
| 41 -Dflys.backend.importer.annotation.types=DATEI | |
| 42 der Pfad zu einer XML-Datei angegeben werden, in der über | |
| 43 Regeln festgelegt wird, wie diese geschehen soll. | |
| 44 Details hierzu im Anhang 'Klassifikation von Streckenfavoriten'. | |
| 41 | 45 |
| 42 - Pegel, Stammdaten (*.glt, *.sta-Dateien): | 46 - Pegel, Stammdaten (*.glt, *.sta-Dateien): |
| 43 Der Import kann mit '-Dflys.backend.importer.skip.gauges=true' | 47 Der Import kann mit '-Dflys.backend.importer.skip.gauges=true' |
| 44 unterdrückt werden. | 48 unterdrückt werden. |
| 45 | 49 |
| 135 Schritten zu importieren. Zuerst die sonstigen hydrologischen Daten | 139 Schritten zu importieren. Zuerst die sonstigen hydrologischen Daten |
| 136 (hierbei mit flys.backend.importer.skip.hyks=true und flys.backend.importer.skip.prfs | 140 (hierbei mit flys.backend.importer.skip.hyks=true und flys.backend.importer.skip.prfs |
| 137 den Import der HYKs und PRFs verhindern). Dann die HYKs (mit flys.backend.importer.skip.* | 141 den Import der HYKs und PRFs verhindern). Dann die HYKs (mit flys.backend.importer.skip.* |
| 138 der anderen Daten) und im finalen Schritt dann die PRFs. | 142 der anderen Daten) und im finalen Schritt dann die PRFs. |
| 139 | 143 |
| 140 Anhang Fehler und Warnungen: | 144 Anhang 'Klassifikation von Streckenfavoriten' |
| 141 ============================ | 145 --------------------------------------------- |
| 146 Streckenfavoriten werden aus KM-Dateien importiert. Um die einzelnen Einträge | |
| 147 eine Kategorie (Brücken, Pegel, etc.) zuzuordnen, kann eine XML angegeben werden, | |
| 148 in der Regeln für diese Klassifikation definiert werden. Schematisch gliedert | |
| 149 sich diese Datei in die zwei Bereiche 'types' und 'patterns': | |
| 150 | |
| 151 <annotation> | |
| 152 <types> ... </types> | |
| 153 <patterns> ... </patterns> | |
| 154 </annotation> | |
| 155 | |
| 156 In der Sektion 'types' werden die Kategorien vereinbart, in die | |
| 157 klassifiziert werden sollen. Die geschieht mit einzelnen | |
| 158 | |
| 159 <type name="Pegel"/> | |
| 160 <type name="Brücke"/> | |
| 161 ... | |
| 162 <type name="Sonstige" default="true"/> | |
| 163 | |
| 164 Das Attribut 'default' kann einmal vergeben werden und | |
| 165 besagt, dass diese Kategorie gewählt werden soll, wenn | |
| 166 keine andere Kategorie zugeordnet werden kann. | |
| 167 | |
| 168 In der Sektion 'patterns' werden dann die Regel | |
| 169 definiert, die einzelne Einträge den definierten Kategorien | |
| 170 zuordnet. Hierfür können zwei Arten von Definitionen | |
| 171 angegeben werden: | |
| 172 | |
| 173 <file pattern="^Brücken$" type="Brücke"/> | |
| 174 | |
| 175 oder | |
| 176 | |
| 177 <line pattern="^Brücke[:\s].*$" type="Brücke"/> | |
| 178 | |
| 179 Die erste Variante bestimmt die Kategorie, die pro KM-Datei | |
| 180 gelten soll. 'pattern' ist hierbei ein regulärer Ausdruck, | |
| 181 der auf den Dateinamen angewandt wird. Passt der Name | |
| 182 der Datei auf den regulären Ausdruck, wird 'type' als | |
| 183 Vorgabe angenommen. Treffen mehrere <file>-Regeln zu, | |
| 184 wird der erste Treffer angewandt. Findet keine der <file>-Regeln | |
| 185 Anwendung, wird die Kategorie ausgewählt, die in der <types>-Section | |
| 186 das Attribut 'default' gesetzt hat. | |
| 187 | |
| 188 Die zweite Regel-Variante <line> wird auf jeden Eintrag | |
| 189 innerhalb einer KM-Datei auf den Bezeichner der Streckenfavoriten | |
| 190 angewandt. Als Muster dient auch hier ein regulärer Ausdruck, | |
| 191 der über das Attribut 'pattern' definiert wird. Die Kategorie | |
| 192 wird in Trefferfall über das Attribut 'type' bestimmt. Treffen | |
| 193 mehrere Regeln zu, wird die Kategorie gewählt, die zum ersten | |
| 194 Treffer gehört. Trifft keine Regel zu wird der Eintrag der | |
| 195 Kategorie zugeteilt, die für die beinhaltende Datei als Vorgabe | |
| 196 gilt. | |
| 197 | |
| 198 Anhang 'Fehler und Warnungen': | |
| 199 ============================= | |
| 142 | 200 |
| 143 Fehler: | 201 Fehler: |
| 144 ------- | 202 ------- |
| 145 | 203 |
| 146 - 'error while parsing gew' | 204 - 'error while parsing gew' |