Mercurial > dive4elements > river
comparison flys-backend/doc/README.txt @ 3657:4f16070b917b
backend: Added first part of the importer documentation.
flys-backend/trunk@5250 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
|---|---|
| date | Thu, 23 Aug 2012 14:44:55 +0000 |
| parents | |
| children | 36edf9a71cbd |
comparison
equal
deleted
inserted
replaced
| 3656:6603aeeda6e3 | 3657:4f16070b917b |
|---|---|
| 1 FLYS3-Importer | |
| 2 | |
| 3 Der FLYS3-Importer dient dazu, hydrologische und morphologische | |
| 4 Gewässerdaten aus dem Dateisystem in die FLYS3-Datenbank zu importieren. | |
| 5 Das Werkzeug orientiert sich hierbei an der Dateihierachie, | |
| 6 so wie sie auch von Desktop-FLYS ausgelesen wird. | |
| 7 | |
| 8 Als Startargument bekommt der Importer den Pfad zu einer | |
| 9 GEW-Datei übergeben. | |
| 10 | |
| 11 Wichtig für den Importer sind in dieser Datei | |
| 12 die Zeilen, die mit "WSTDatei:" beginnen. In ihnen wird der | |
| 13 Pfad zu der zentralen WST-Datei des jeweiligen Gewässers angegeben. | |
| 14 Alle anderen importierten Dateien werden in ihrer Lage relativ zur | |
| 15 Lage dieser Datei betrachtet. | |
| 16 | |
| 17 Das Verhalten des Importes kann mit sogenannten | |
| 18 System-Properties gesteuert werden. Diese werden im | |
| 19 Allgemeinen in der Form -Dkey=value angegeben. | |
| 20 | |
| 21 Will man z.B. mit dem Importer nur in simulierierten Import | |
| 22 durchführen, dann kann dies über die Angabe von | |
| 23 '-Dflys.backend.importer.dry.run=true' erfolgen. | |
| 24 | |
| 25 !!! Der Import geht wie Desktop-FLYS davon aus, dass die Dateien | |
| 26 !!! Latin-1 encodiert vorliegen. | |
| 27 | |
| 28 Für den Importer stellt jeweils der Import eines Gewässers eine | |
| 29 transaktionale Einheit dar. Wird der Import während eines Gewässers | |
| 30 abgebrochen, werden alle Änderungen bzgl. dieses Gewässers zurück gerollt. | |
| 31 | |
| 32 Importierte Daten: | |
| 33 | |
| 34 Der Importer importiert folgende Datentypen: | |
| 35 | |
| 36 - Streckenfavoriten (*.km-Dateien) | |
| 37 Der Import kann mit '-Dflys.backend.importer.skip.annotations=true' | |
| 38 unterdrückt werden. | |
| 39 | |
| 40 TODO SLT: flys.backend.importer.annotation.types erklären! | |
| 41 | |
| 42 - Pegel, Stammdaten (*.glt, *.sta-Dateien): | |
| 43 Der Import kann mit '-Dflys.backend.importer.skip.gauges=true' | |
| 44 unterdrückt werden. | |
| 45 | |
| 46 - Basis-Wasserstände (gewaesser.wst-Dateien): | |
| 47 Der Import kann mit '-Dflys.backend.importer.skip.wst=true' | |
| 48 unterdrückt werden. | |
| 49 | |
| 50 - Zusätzliche Längsschnitte (*.zus, *.wst-Dateien) | |
| 51 Der Import kann mit '-Dflys.backend.importer.skip.extra.wsts=true' | |
| 52 unterdrückt werden. | |
| 53 | |
| 54 - Fixierungen (*.wst-Dateien) | |
| 55 Der Import kann mit '-Dflys.backend.importer.skip.fixations=true' | |
| 56 unterdrückt werden. | |
| 57 | |
| 58 - Amtliche Linien (*.wst-Dateien) | |
| 59 Der Import kann mit '-Dflys.backend.importer.skip.official.lines=true' | |
| 60 unterdrückt werden. | |
| 61 | |
| 62 - Profilspuren (*.prf-Dateien) | |
| 63 Der Import kann mit '-Dflys.backend.importer.skip.prfs=true' | |
| 64 unterdrückt werden. | |
| 65 | |
| 66 - Hydraulische Kennzahlen (*.hyk) | |
| 67 Der Import kann mit '-Dflys.backend.importer.skip.hyks=true' | |
| 68 unterdrückt werden. | |
| 69 | |
| 70 - Hochwassermarken (*.zus) | |
| 71 Der Import kann mit '-Dflys.backend.importer.skip.flood.water=true' | |
| 72 unterdrückt werden. | |
| 73 | |
| 74 - Hochwasserschutzanlagen (*.zus) | |
| 75 Der Import kann mit '-Dflys.backend.importer.skip.flood.protection=true' | |
| 76 unterdrückt werden. | |
| 77 | |
| 78 TODO INGO: | |
| 79 | |
| 80 flys.backend.importer.skip.bed.height.single | |
| 81 flys.backend.importer.skip.bed.height.epoch | |
| 82 flys.backend.importer.skip.sediment.density | |
| 83 flys.backend.importer.skip.morphological.width | |
| 84 flys.backend.importer.skip.flow.velocity | |
| 85 flys.backend.importer.skip.sediment.yield | |
| 86 flys.backend.importer.skip.waterlevels | |
| 87 flys.backend.importer.skip.waterlevel.differences | |
| 88 flys.backend.importer.skip.sq.relation | |
| 89 | |
| 90 TODO SLT: Datenbank-Credentials dokumentieren. | |
| 91 | |
| 92 TODO SLT: Fehler und Warnungen aus separater Datei hier hin. | |
| 93 | |
| 94 Betrieb: | |
| 95 | |
| 96 Der Speicherverbrauch des Importers ist sehr hoch. Es ist empfehlenswert, | |
| 97 der JVM mindestens 8GiB Haupspeicher zuzuordnen: '-Xmx=8192m' | |
| 98 Besonders speicherintensiv ist der Import der HYKs und der PRFs. | |
| 99 Hier ist es unter Umständen empfehlenswert, diese in zwei oder drei | |
| 100 Schritten zu importieren. Zuerst die sonstigen hydrologischen Daten | |
| 101 (hierbei mit flys.backend.importer.skip.hyks=true und flys.backend.importer.skip.prfs | |
| 102 den Import der HYKs und PRFs verhindern). Dann die HYKs (mit flys.backend.importer.skip.* | |
| 103 der anderen Daten) und im finalen Schritt dann die PRFs. |