dive4elements/river: flys-backend/doc/documentation/de/importer-hydr-morph.tex comparison

comparison flys-backend/doc/documentation/de/importer-hydr-morph.tex @ 3673:b6fb31fad420

Fixed bugs in hydrological and morphological documentation. flys-backend/trunk@5304 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Thu, 30 Aug 2012 08:35:15 +0000
parents	25b5af0cdf89
children	4076ee4e9a91

comparison

equal deleted inserted replaced

-:1cb3b9708d99
+:b6fb31fad420
 \textbf{Hinweis}
 \\Der Import geht wie auch Desktop-FLYS davon aus, dass die Dateien Latin-1
 encodiert vorliegen! Stellen Sie also sicher, dass das von Ihnen verwendete
 Encoding korrekt ist. Andernfalls ist es möglich, dass es während des Imports zu
-unerwarteten Problem kommt.
+unerwarteten Problemen kommt.
 Der Importer ist ein in Java geschriebenes Werkzeug und kann von der Konsole aus
 gestartet werden. Sämtlich Konfigurationen können über sogenannte
 \textit{System-Properties} übergeben werden. Eine \textit{System-Property} wird
 dabei mittels \textit{-Dkey=value} beim Start übergeben. Im folgenden Beispiel
 Auf gleicher Weise können dem Importer sämtliche Optionen zur Konfiguration
 beim Start mitgegeben werden. Im folgenden werden die möglichen System-Properties und
 ihre Auswirkung auf den Import genauer beschrieben. In den Kapiteln
 \ref{configuration} und \ref{start-hydr} wird zur Einfachheit jedoch ein
-Shellskript verwendet, der eine Standardkonfiguration vorgibt und den Importer
+Shellskript verwendet, das eine Standardkonfiguration vorgibt und den Importer
-mit allen Konfigurationen startet.
+mit allen erforderlichen Konfigurationen startet.
 \subsection{Importierte Daten}
 In diesem Kapitel werden die Datentypen aufgelistet und erläutert, wie sie vom
 Importer eingelesen werden.
 \subsubsection{Streckenfavoriten (*.km-Dateien)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.annotations=true}
+Der Import der Streckenfavoriten kann mit \textbf{-Dflys.backend.importer.skip.annotations=true}
 unterdrückt werden.
 Zur Klassifikation von Streckenfavoriten muss mittels\\
 \textbf{-Dflys.backend.importer.annotation.types=DATEI} der Pfad zu einer
 XML-Datei angegeben werden. In dieser Datei werden die Typen und Regeln
-festgelegt, anhand dessen die Klassifikation während des Import-Vorgangs
+festgelegt, anhand derer die Klassifikation während des Import-Vorgangs
 vorgenommen wird. Details hierzu befinden sich im Kapitel \ref{annotation-types}.
 \subsubsection{Pegel, Stammdaten (*.glt, *.sta-Dateien)}
-Der Import kann mit \textbf{'-Dflys.backend.importer.skip.gauges=true'}
+Der Import von Pegel- und Stammdaten kann mit \textbf{'-Dflys.backend.importer.skip.gauges=true'}
 unterdrückt werden. Die .glt-Datei, die neben der .wst-Datei liegt, wird zuerst
 ausgelesen. Es werden nur *.sta-Datei von Pegeln geladen, die in der .glt-Datei
 vermerkt sind.
 Mittels \textbf{-Dflys.backend.sta.parse.gauge.numbers=true'} wird versucht, die
 Die System-Property \textbf{flys.backend.main.value.types} kann einen String
 mit gültigen Typen von Stammdaten enthalten. Vorbelegt ist \textit{QWTD}. In der
 Praxis ist \textit{QWD} eine sinnvolle Belegung.
 \subsubsection{Basis-Wasserstände (gewaesser.wst-Dateien)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.wst=true} unterdrückt werden.
+Der Import von Wasserständen kann mit \textbf{-Dflys.backend.importer.skip.wst=true} unterdrückt werden.
 \subsubsection{Zusätzliche Längsschnitte (*.zus, *.wst-Dateien)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.extra.wsts=true}
+Der Import zusätzlichen Längsschnitten kann mit \textbf{-Dflys.backend.importer.skip.extra.wsts=true}
 unterdrückt werden. Es werden die *.zus- und *.wst-Dateien aus dem Verzeichnis
 \textit{../Zus.Längsschnitte} relativ zur gewaesser.wst-Datei betrachtet.
 \subsubsection{Fixierungen (*.wst-Dateien)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.fixations=true}
+Der Import von Fixierungen kann mit \textbf{-Dflys.backend.importer.skip.fixations=true}
 unterdrückt werden. Es werden die *.wst-Dateien aus dem Verzeichnis
 \textit{../Fixierungen} relativ zur gewaesser.wst-Datei betrachtet.
 \subsubsection{Amtliche Linien (*.wst-Dateien)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.official.lines=true}
+Der Import von amtlichen Linien kann mit \textbf{-Dflys.backend.importer.skip.official.lines=true}
 unterdrückt werden. Es werden die \textit{Amtl\_Linien.wst}-Dateien aus dem
 Verzeichnis \textit{../Basisdaten} und \textit{../Fixierungen} relativ zur
-gewaesser.wst-Datei betrachtet.
+\textit{gewaesser.wst}-Datei betrachtet.
 \subsubsection{Profilspuren (*.prf-Dateien)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.prfs=true}
+Der Import von Profilspuren kann mit \textbf{-Dflys.backend.importer.skip.prfs=true}
 unterdrückt werden. Es werden rekursiv alle *.prf-Dateien aus \textit{../../..}
 relativ zur gewaesser.wst-Datei betrachtet. Vor dem Import werden mithilfe
 eines Längen- und eines MD5-Summen-Vergleichs inhaltliche Duplikate
 ausgeschlossen.
 \subsubsection{Hydraulische Kennzahlen (*.hyk)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.hyks=true} unterdrückt
+Der Import von hydraulischen Kennzahlen kann mit \textbf{-Dflys.backend.importer.skip.hyks=true} unterdrückt
 werden. Es werden rekursiv alle *.hyk-Dateien aus \textit{../../..} relativ zur
 gewaesser.wst-Datei betrachtet. Vor dem Import werden mithilfe eines Längen- und
 eines MD5-Summen-Vergleichs inhaltliche Duplikate ausgeschlossen.
 \subsubsection{Hochwassermarken (*.zus, *.wst)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.flood.water=true}
+Der Import von Hochwassermarken kann mit \textbf{-Dflys.backend.importer.skip.flood.water=true}
 unterdrückt werden. Es werden die *.zus- und *.wst-Dateien aus dem Verzeichnis
 \textit{../HW-Marken} relativ zur gewaesser.wst-Datei betrachtet.
 \subsubsection{Hochwasserschutzanlagen (*.zus)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.flood.protection=true}
+Der Import von Hochwasserschutzanlagen kann mit \textbf{-Dflys.backend.importer.skip.flood.protection=true}
 unterdrückt werden. Es werden die *.zus- und *.wst-Dateien aus dem Verzeichnis
-\textit{../HW-Schutzanlagen} relativ zur gewaesser.wst-Datei betrachtet.
+\textit{../HW-Schutzanlagen} relativ zur \textit{gewaesser.wst}-Datei betrachtet.
 \subsubsection{Sohlhöhen (Peilungen)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.bed.height.single}
+Der Import von Sohlhöhen-Peilungen kann mit \textbf{-Dflys.backend.importer.skip.bed.height.single=true}
 unterdrückt werden. Es werden die Dateien aus dem Verzeichnis
 \textit{Morphologie/Sohlhoehen/Einzeljahre} geladen.
 \subsubsection{Sohlhöhen (Epochen)}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.bed.height.epoch}
+Der Import Sohlhöhen-Epochen kann mit \textbf{-Dflys.backend.importer.skip.bed.height.epoch=true}
 unterdrückt werden. Es werden die Dateien aus dem Verzeichnis
 \textit{Morphologie/Sohlhoehen/Epochen} geladen.
-\subsubsection{Sediment Sedimentdichte}
+\subsubsection{Sedimentdichte}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.sediment.density}
+Der Import der Sedimentdichte kann mit
+\textbf{-Dflys.backend.importer.skip.sediment.density=true}
 unterdrückt werden. Es werden alle Dateien aus dem Verzeichnis
 \textit{Morphologie/Sedimentdichte} geladen.
 \subsubsection{Morphologische Breite}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.morphological.width}
+Der Import der morphologischen Breite kann mit
+\textbf{-Dflys.backend.importer.skip.morphological.width=true}
 unterdrückt werden. Es werden alle Dateien aus dem Verzeichnis
 \textit{Morphologie/morphologische\_Breite} geladen.
 \subsubsection{Fließgeschwindigkeit}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.flow.velocity}
+Der Import der Fließgeschwindigkeit kann mit
+\textbf{-Dflys.backend.importer.skip.flow.velocity=true}
 unterdrückt werden. Es werden alle Modellrechnungen aus dem Verzeichnis\\
 \textit{Morphologie/Geschwindigkeit\_Schubspannung/Modellrechnungen} und\\
 \textit{Morphologie/Geschwindigkeit\_Schubspannung/v-Messungen} geladen.
 \subsubsection{Sedimentfracht}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.sediment.yield}
+Der Import der Sedimentfracht kann mit
+\textbf{-Dflys.backend.importer.skip.sediment.yield=true}
 unterdrückt werden. Es werden alle Dateien aus dem Verzeichnis
 \textit{Morphologie/Fracht} geladen. Dabei werden die Dateien aus dem
 Unterverzeichnissen \textit{Einzeljahre} und \textit{Epochen} entsprechend als
 \textit{Einzeljahre} und \textit{Epochen} vermerkt.
 \subsubsection{Wasserspiegellagen für MINFO}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.waterlevels}
+Der Import der MINFO spezifischen Wasserspiegellagen kann mit
+\textbf{-Dflys.backend.importer.skip.waterlevels=true}
 unterdrückt werden. Es werden alle Dateien aus dem Verzeichnis
 \textit{Morphologie/Fixierungsanalyse/Wasserspiegellagen} geladen.
 \subsubsection{Wasserspiegeldifferenzen für MINFO}
-Der Import kann mit \textbf{-Dflys.backend.importer.skip.waterlevel.differences}
+Der Import der Wasserspiegellagendifferenzen kann mit
+\textbf{-Dflys.backend.importer.skip.waterlevel.differences=true}
 unterdrückt werden. Es werden alle Dateien aus dem Verzeichnis
 \textit{Morphologie/Fixierungsanalyse/Wasserspiegeldifferenzen} geladen.
 \subsubsection{Transport Abfluss Beziehung}
-Der Import kann mit \textbf{flys.backend.importer.skip.sq.relation} unterdrückt
+Der Import der Daten für die Transport Abfluss Beziehung kann mit
+\textbf{flys.backend.importer.skip.sq.relation=true} unterdrückt
 werden. Es werden alle Dateien unter
 \textit{Feststofftransport-Abfluss-Beziehung} geladen.
 \subsection{Klassifikation von Streckenfavoriten}
 \label{annotation-types}
 Streckenfavoriten werden aus KM-Dateien importiert. Um die einzelnen Einträge
-eine Kategorie (Brücken, Pegel, etc.) zuzuordnen, kann eine XML angegeben werden,
+einer Kategorie (Brücke, 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':
 \begin{lstlisting}
 <annotation>
 ...
 </patterns>
 </annotation>
 \end{lstlisting}
-In der Sektion 'types' werden die Kategorien vereinbart, in die klassifiziert
+In der Sektion \textit{types} werden die Kategorien vereinbart, in die klassifiziert
-werden sollen. Die geschieht mit einzelnen
+werden soll. Dies geschieht mit entsprechenden Zeilen in der XML Datei. Es folgt
+ein Auszug aus einer solchen Datei:
 \begin{lstlisting}
 <type name="Pegel"/>
 <type name="Brücke"/>
 ...
 <type name="Sonstige" default="true"/>
 \end{lstlisting}
-Das Attribut 'default' kann einmal vergeben werden und besagt, dass diese
+Das Attribut 'default' darf maximal 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
+In der Sektion 'patterns' werden dann die Regeln definiert, die einzelne Einträge
 den zuvor definierten Kategorien zuordnet. Hierfür können zwei Arten von
 Definitionen angegeben werden:
 \begin{lstlisting}
 <file pattern="^Brücken$" type="Brücke"/>
 \end{lstlisting}
 Die erste Variante bestimmt die Kategorie, die pro KM-Datei gelten soll.
 \textit{pattern} ist hierbei ein regulärer Ausdruck, der auf den Dateinamen
 angewandt wird. Passt der Name der Datei auf den regulären Ausdruck, wird
-\textit{type} als Vorgabe angenommen. Treffen mehrere <file>-Regeln zu, wird
+\textit{type} als Vorgabe angenommen. Treffen mehrere \textit{file}-Regeln zu,
-der erste Treffer angewandt. Findet keine der <file>-Regeln Anwendung, wird
+wird der erste Treffer angewandt. Findet keine der \textit{file}-Regeln Anwendung, wird
-die Kategorie ausgewählt, die in der <types>-Section das Attribut
+die Kategorie ausgewählt, die in der \textit{types}-Section das Attribut
 \textit{default} gesetzt hat.
-Die zweite Regel-Variante <line> wird auf jeden Eintrag innerhalb einer KM-Datei
+Die zweite Regel-Variante \textit{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 \textit{pattern} definiert wird.
-Die Kategorie wird in Trefferfall über das Attribut \textit{type} bestimmt.
+Die Kategorie wird im Trefferfall über das Attribut \textit{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.
 \\Der Hibernate-Dialekt, den die Datenbank versteht. Im Falle einer Oracle-XE
 wäre dies z.B.: \textit{org.hibernate.dialect.OracleDialect}.
 Weitere Details zum Verbinden zu einer Oracle Datenbank finden Sie unter
-\href{http://www.orafaq.com/wiki/JDBC}. Alle weiteren Einstellungen sind
+\href{http://www.orafaq.com/wiki/JDBC}{http://www.orafaq.com/wiki/JDBC}. Alle weiteren Einstellungen sind
 optional anpassbar:
 \textbf{LOG4J\_CONFIG}
-\\Der Fachdatenimport verwendet eine externe Bibliothek Apache Log4J zum Loggen
+\\Der Fachdatenimport verwendet die externe Bibliothek \textit{Apache Log4J} zum Loggen
 von Informationen. Dazu ist es notwendig eine entsprechende Konfiguration beim
 Start anzugeben. \textit{LOG4J\_CONFIG} verweist in diesem Fall auf eine externe
 Datei zur Konfiguration von Log4J. Im Standardfall wird die Datei
-\textit{conf/log4j.properties} verwendet, welche eine sinnvolle Konfiguration
+\textit{conf/log4j.properties} verwendet, welche eine sinnvolle Standardkonfiguration
 enthält. Sollten Sie diese Konfiguration verwenden, wird beim Import eine
 Log-Datei namens \textit{import.log} erstellt, die maximal 100 MB groß werden
 kann. Sollte die Log-Datei größer als 100 MB anwachsen, wird die aktuelle Datei
 nach \textit{import.log.1} umbenannt und eine neue Datei \textit{import.log}
 wird begonnen. Maximal werden 10 Log-Dateien gespeichert. Für weitere Details
 \textbf{IMPORTER\_SKIP\_SEDIMENT\_YIELD}
 \\Wenn \textit{true} gesetzt ist werden keine Sedimentfrachten bearbeitet.
 \textbf{IMPORTER\_SKIP\_WATERLEVELS}
-\\Wenn \textit{true} gesetzt ist werden keine Sohlhöhen bearbeitet.
+\\Wenn \textit{true} gesetzt ist werden keine Wasserspiegellagen für MINFO bearbeitet.
 \textbf{IMPORTER\_SKIP\_WATERLEVEL\_DIFFERENCES}
-\\Wenn \textit{true} gesetzt ist werden keine Sohlhöhendifferenzen bearbeitet.
+\\Wenn \textit{true} gesetzt ist werden keine Wasserspiegellagendifferenzen für
+MINFO bearbeitet.
 \textbf{IMPORTER\_SKIP\_SQ\_RELATION}
 \\Wenn \textit{true} gesetzt ist werden keine Daten für die Berechnungsart
 SQ-Beziehung bearbeitet.
 \textbf{Error while storing sediment yield.}
 \\Beim Schreiben einer Sedimentablagerung trat ein Fehler auf.
 \textbf{Error while storing waterlevel diff.}
-\\Beim Schreiben einer Wassspiegeldifferenz trat ein Fehler auf.
+\\Beim Schreiben einer Wasserspiegeldifferenz trat ein Fehler auf.
 \textbf{Error while storing sq relation.}
 \\Beim Schreiben einer S(Q) Beziehung trat ein Fehler auf.
 \textbf{Error reading PRF file.}
 \textbf{GLT: no gauge found in line \#}
 \\In der GLT-Datei wurde ein Pegel erwartet, aber nicht gefunden.
 \textbf{GLT: line \# has not enough columns.}
-\\Eine Zeile in der Pegelgültigkeitsdatei hat nicht genug spalten.
+\\Eine Zeile in der Pegelgültigkeitsdatei hat nicht genug Spalten.
 \textbf{Error while parsing flow velocity values.}
 \\Invalide Datenzeile in einer Datei mit einer Fliessgeschwindigkeitsmessung.
 \textbf{skip invalid data line: \#}
 \textbf{Error while parsing flow velocity values.}
 \\Invalide Datenzeile in einer Datei Fließgeschwindigkeitsmodellen.
 \textbf{Error while parsing number from data row: \#}
-\todo INGO
+\\In der eingelesenen Zeile konnte keine Zahl gefunden werden.
 \textbf{Unknown meta line: \#}
 \\Invalide Datenzeile in einer Datei mit Sedimentdichten.
 \textbf{Error while parsing numbers in: \#}
 \textbf{PRF: line 5 is not an positive integer.}\\
 \textbf{PRF: cannot extract km in line \#}
 \\Das PRF-Format ist komplex. Bei oben genannten Fehlern sollten weitere
 Information zur genaueren Analyse herangezogen werden.
-\textbf{cannot access WST file <FILE>}
+\textbf{cannot access WST file $FILE$}
 \\Die WST-Datei konnte nicht gefunden werden.
 \textbf{Found an invalid row in the AT file.}
 \\Eine Zeile in einer AT-Datei ist nicht korrekt.
-\textbf{AT: invalid number <XYZ>}
+\textbf{AT: invalid number $XYZ$}
 \\Eine Zahl wurde erwartet aber nicht gefunden.
 \textbf{Try to add Q range without waterlevel!}
 \\Q-Bereich ohne Wasserstand gefunden.
 \\Unbekannte Kornfraktion.
 \textbf{WST: invalid number.}
 \\Ungültige Zahl.
-\textbf{WST: km <km> (<Zeile>) found more than once. -> ignored.}
+\textbf{WST: km $km$ (<Zeile>) found more than once. -\> ignored.}
 \\Ein Kilometer ist doppelt in einer WST-Datei enthalten.
 \textbf{HYK: zone coordinates swapped in line \#}
 \\Fließzonenkordinaten wurden in umgekehrter Reihenfolge angeben.
 \subsection{Starten des Fachdaten Importers}
 \label{start-hydr}
 Der Fachdaten Importer wird mit Hilfe eines Shellskripts von einer Konsole
-gestartet. Dazu wechseln Sie auf der Konsole in das Verzeichnis \todo und führen
+gestartet. Dazu führen folgenden Befehl aus:\\
-folgenden Befehl aus:\\
 \begin{lstlisting}
-sh contrib/run.sh
+contrib/run_hydr_morph.sh
 \end{lstlisting}
+Nachdem der Prompt der Konsole zurückkehrt, ist der Import abgeschlossen oder es
+ist ein Fehler aufgetreten. Weitere Informationen entnehmen Sie der Log-Datei.

Mercurial > dive4elements > river

comparison flys-backend/doc/documentation/de/importer-hydr-morph.tex @ 3673:b6fb31fad420