Mercurial > dive4elements > river

annotate flys-backend/doc/README.txt @ 3658:55c4b7442236

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