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

comparison flys-backend/doc/documentation/de/importer-hydr-morph.tex @ 3667:9b08db037ee5

Fixes and structural changes in the german documentation. flys-backend/trunk@5273 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Ingo Weinzierl <ingo.weinzierl@intevation.de>
date	Mon, 27 Aug 2012 11:42:40 +0000
parents	9f768a9034f4
children	2a3bc47d1ba9

comparison

equal deleted inserted replaced

-:9f768a9034f4
+:9b08db037ee5
 Sollte beim Lese- oder Schreib-Vorgang eines Gewässers ein Fehler auftreten, so
 werden sämtliche Daten des Gewässers verworfen. Beide Phasen zusammen bilden
 somit eine Transaktion.
 \textbf{Hinweis}
-\\Der Import geht wie Desktop-FLYS davon aus, dass die Dateien Latin-1 encodiert
+\\Der Import geht wie auch Desktop-FLYS davon aus, dass die Dateien Latin-1
-vorliegen!
+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.
+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
+würde der Importer mit einer Konfiguration \textit{flys.backend.importer.dry.run},
+welche den Wert \textit{true} gesetzt hat, gestartet.
+\begin{lstlisting}
+java -Dflys.backend.importer.dry.run=true de.intevation.flys.importer.Importer
+\end{lstlisting}
+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
+mit allen Konfigurationen startet.
 \subsection{Importierte Daten}
-Der Importer importiert folgende Datentypen:
+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}
 unterdrückt werden.
-Zur Klassifikation von Streckenfavoriten kann mit
+Zur Klassifikation von Streckenfavoriten muss mittels\\
 \textbf{-Dflys.backend.importer.annotation.types=DATEI} der Pfad zu einer
-XML-Datei angegeben werden, in der über Regeln festgelegt wird, wie diese
+XML-Datei angegeben werden. In dieser Datei werden die Typen und Regeln
-geschehen soll. Details hierzu im Anhang 'Klassifikation von Streckenfavoriten'.
+festgelegt, anhand dessen 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'}
 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
 offiziellen Pegelnummern aus den Stammdaten zu extrahieren.
 \textbf{Dies ist mit Vorsicht zu behandeln, denn die meisten STA-Dateien
 enthalten invalide Pegelnummern.}
 Die System-Property \textbf{flys.backend.main.value.types} kann einen String
-mit gültigen Typen von Stammdaten enthalten. Vorbelegt ist \textbf{QWTD}. In der
+mit gültigen Typen von Stammdaten enthalten. Vorbelegt ist \textit{QWTD}. In der
-Praxis ist "QWD" eine sinnvolle Belegung.
+Praxis ist \textit{QWD} eine sinnvolle Belegung.
-\subsection{Basis-Wasserstände (gewaesser.wst-Dateien)}
+\subsubsection{Basis-Wasserstände (gewaesser.wst-Dateien)}
 Der Import kann mit \textbf{-Dflys.backend.importer.skip.wst=true} unterdrückt werden.
-\subsection{Zusätzliche Längsschnitte (*.zus, *.wst-Dateien)}
+\subsubsection{Zusätzliche Längsschnitte (*.zus, *.wst-Dateien)}
 Der Import 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.
-\subsection{Fixierungen (*.wst-Dateien)}
+\subsubsection{Fixierungen (*.wst-Dateien)}
 Der Import 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.
-\subsection{Amtliche Linien (*.wst-Dateien)}
+\subsubsection{Amtliche Linien (*.wst-Dateien)}
 Der Import 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.
-\subsection{Profilspuren (*.prf-Dateien)}
+\subsubsection{Profilspuren (*.prf-Dateien)}
 Der Import 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.
-\subsection{Hydraulische Kennzahlen (*.hyk)}
+\subsubsection{Hydraulische Kennzahlen (*.hyk)}
 Der Import 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.
-\subsection{Hochwassermarken (*.zus, *.wst)}
+\subsubsection{Hochwassermarken (*.zus, *.wst)}
 Der Import 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.
-\textbf{Hochwasserschutzanlagen (*.zus)}
+\subsubsection{Hochwasserschutzanlagen (*.zus)}
 Der Import 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.
 \todo INGO:
 flys.backend.importer.skip.flow.velocity
 flys.backend.importer.skip.sediment.yield
 flys.backend.importer.skip.waterlevels
 flys.backend.importer.skip.waterlevel.differences
 flys.backend.importer.skip.sq.relation
-\subsection{Konfiguration}
-\label{configuration}
-\todo
-Zum Starten des Importers ist es notwendig, in der Datei \textit{run.sh} die
-Variablen am Anfang der Datei anzupassen. Im folgenden werden notwendige und
-optionale Einstellungen beschrieben, die beim Starten des Importers
-berücksichtigt werden. Folgende Einstellungen sind zwangsläufig an die
-bestehende Umgebung anzupassen:
-\textbf{INFO\_GEW}
-\\Diese Option muss auf eine valide *.gew Datei verweisen (bekannt aus
-Desktop-FLYS). Wichtig für den Importer sind in dieser Datei die Zeilen, die mit
-\textit{WSTDatei:} beginnen. In ihnen wird der Pfad zu der zentralen WST-Datei
-des jeweiligen Gewässers angegeben. Alle anderen importierten Dateien werden in
-ihrer Lage im Dateisystem relativ zur Lage dieser Datei betrachtet.
-\textbf{BACKEND\_USER}
-\\Der Nutzername, der zum Verbinden zur Datenbank verwendet werden soll.
-\textbf{BACKEND\_PASS}
-\\Das Passwort, welches in Kombination mit \textbf{BACKEND\_USER} zum Verbinden
-zur Datenbank verwendet werden soll.
-\textbf{BACKEND\_HOST}
-\\Der Datenbank-Host. In der Regel sollte hier \textit{localhost} eingetragen
-werden, da es empfohlen wird, den Importer auf dem selben Host zu starten, auf
-dem auch die Datenbank läuft.
-\textbf{BACKEND\_PORT}
-\\Der Port auf dem die Datenbank zu erreichen ist. Bei einer Oracle XE Instanz
-z.B.: \textit{1521}, sofern nicht anders konfiguriert.
-\textbf{BACKEND\_NAME}
-\\Der Name der Datenbank Instanz. Beispielsweise \textit{XE} bei einer Oracle XE
-Instanz.
-Für die Verbindung zur Datenbank ist es nötig, dem Import die Verbindungsdaten
-zu übergeben. Dies geschieht ebenfalls über System-Properties:
-\textbf{BACKEND\_DB\_PREFIX}
-\\Der Präfix zum Aufbau einer Datenbankverbindung. Für Oracle z.B.: \textit{jdbc:oracle:thin:@}.
-\textbf{BACKEND\_DB\_DRIVER}
-\\Der Name des JDBC-Treibers, der es erlaubt das Protokoll der Datenbank zu
-sprechen. Im Falle einer Oracle XE wäre dies z.B.: \textit{oracle.jdbc.OracleDriver}.
-\textbf{BACKEND\_DB\_DIALECT}
-\\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}.
-\textbf{IMPORTER\_MAINVALUE\_TYPES}
-\\Diese Einstellung erlaubt die Angabe eines Textes, der aus den gültigen Typen
-für Hauptwerte zusammengesetzt ist. \textit{QWTD} ist standardmäßig gesetzt.
-\textbf{IMPORTER\_ANNOTATION\_TYPES}
-\\Diese Einstellung verweist auf eine Datei (relativ zum Ort der \textit{run.sh}
-im Dateisystem), die die möglichen Typen von Streckenfavoriten und deren Regeln
-definiert. Siehe hierzu auch Kapitel \ref{annotation-types}.
-Die im folgenden beschriebenen Einstellungen können jeweils die Werte
-\textit{true} oder \textit{false} annehmen und sind optional anzupassen.
-\textbf{IMPORTER\_DRY\_RUN}
-\\Falls \textit{true} gesetzt wird, wird der Import nur simuliert. Es werden
-keine Daten in die Datenbank geschrieben. Dies kann z.B.: zum Ermitteln
-potentieller Dateninkonsistenzen sinnvoll sein.
-\textbf{IMPORTER\_SKIP\_GAUGES}
-\\Wenn \textit{true} gesetzt ist werden keine Pegel- und Stammdaten bearbeitet.
-\textbf{IMPORTER\_SKIP\_ANNOTATIONS}
-\\Wenn \textit{true} gesetzt ist werden keine Streckenfavoriten bearbeitet.
-\textbf{IMPORTER\_SKIP\_WST}
-\\Wenn \textit{true} gesetzt ist werden keine WST Dateien bearbeitet.
-\textbf{IMPORTER\_SKIP\_PRFS}
-\\Wenn \textit{true} gesetzt ist werden keine Querprofilspuren bearbeitet.
-\textbf{IMPORTER\_SKIP\_HYKS}
-\\Wenn \textit{true} gesetzt ist werden keine HYK Dateien bearbeitet.
-\textbf{IMPORTER\_SKIP\_EXTRA\_WST}
-\\Wenn \textit{true} gesetzt ist werden keine zusätzlichen Längsschnitte
-bearbeitet.
-\textbf{IMPORTER\_SKIP\_FIXATIONS}
-\\Wenn \textit{true} gesetzt ist werden keine Fixierungen bearbeitet.
-\textbf{IMPORTER\_SKIP\_OFFICIAL\_LINES}
-\\Wenn \textit{true} gesetzt ist werden keine offiziellen Linien bearbeitet.
-\textbf{IMPORTER\_SKIP\_FLOOD\_WATER}
-\\Wenn \textit{true} gesetzt ist werden keine Hochwassermarken bearbeitet.
-\textbf{IMPORTER\_SKIP\_FLOOD\_PROTECTION}
-\\Wenn \textit{true} gesetzt ist werden keine Hochwasserschutzanlagen
-bearbeitet.
-\textbf{IMPORTER\_SKIP\_BED\_HEIGHT\_SINGLE}
-\\Wenn \textit{true} gesetzt ist werden keine mittleren Sohlhöhen (Peilungen) bearbeitet.
-\textbf{IMPORTER\_SKIP\_BED\_HEIGHT\_EPOCH}
-\\Wenn \textit{true} gesetzt ist werden keine mittleren Sohlhöhen (Epochen)
-bearbeitet.
-\textbf{IMPORTER\_SKIP\_SEDIMENT\_DENSITY}
-\\Wenn \textit{true} gesetzt ist werden keine Dateien zur Sedimentdichte
-bearbeitet.
-\textbf{IMPORTER\_SKIP\_MORPHOLOGICAL\_WIDTH}
-\\Wenn \textit{true} gesetzt ist wird keine morphologische Breite bearbeitet.
-\textbf{IMPORTER\_SKIP\_FLOW\_VELOCITY}
-\\Wenn \textit{true} gesetzt ist werden keine Fließgeschwindigkeiten bearbeitet.
-\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.
-\textbf{IMPORTER\_SKIP\_WATERLEVEL\_DIFFERENCES}
-\\Wenn \textit{true} gesetzt ist werden keine Sohlhöhendifferenzen bearbeitet.
-\textbf{IMPORTER\_SKIP\_SQ\_RELATION}
-\\Wenn \textit{true} gesetzt ist werden keine Daten für die Berechnungsart
-SQ-Beziehung bearbeitet.
 \subsection{Klassifikation von Streckenfavoriten}
 \label{annotation-types}
 Streckenfavoriten werden aus KM-Dateien importiert. Um die einzelnen Einträge
 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.
+\subsection{Konfiguration}
+\label{configuration}
+\todo LOG4J
+Zum Starten des Importers ist es notwendig, in der Datei \textit{run.sh} die
+Variablen am Anfang der Datei anzupassen. Im folgenden werden notwendige und
+optionale Einstellungen beschrieben, die beim Starten des Importers
+berücksichtigt werden. Folgende Einstellungen sind zwangsläufig an die
+bestehende Umgebung anzupassen:
+\textbf{INFO\_GEW}
+\\Diese Option muss auf eine valide *.gew Datei verweisen (bekannt aus
+Desktop-FLYS). Wichtig für den Importer sind in dieser Datei die Zeilen, die mit
+\textit{WSTDatei:} beginnen. In ihnen wird der Pfad zu der zentralen WST-Datei
+des jeweiligen Gewässers angegeben. Alle anderen importierten Dateien werden in
+ihrer Lage im Dateisystem relativ zur Lage dieser Datei betrachtet.
+\textbf{BACKEND\_USER}
+\\Der Nutzername, der zum Verbinden zur Datenbank verwendet werden soll.
+\textbf{BACKEND\_PASS}
+\\Das Passwort, welches in Kombination mit \textbf{BACKEND\_USER} zum Verbinden
+zur Datenbank verwendet werden soll.
+\textbf{BACKEND\_HOST}
+\\Der Datenbank-Host. In der Regel sollte hier \textit{localhost} eingetragen
+werden, da es empfohlen wird, den Importer auf dem selben Host zu starten, auf
+dem auch die Datenbank läuft.
+\textbf{BACKEND\_PORT}
+\\Der Port auf dem die Datenbank zu erreichen ist. Bei einer Oracle XE Instanz
+z.B.: \textit{1521}, sofern nicht anders konfiguriert.
+\textbf{BACKEND\_NAME}
+\\Der Name der Datenbank Instanz. Beispielsweise \textit{XE} bei einer Oracle XE
+Instanz.
+Für die Verbindung zur Datenbank ist es nötig, dem Import die Verbindungsdaten
+zu übergeben. Dies geschieht ebenfalls über System-Properties:
+\textbf{BACKEND\_DB\_PREFIX}
+\\Der Präfix zum Aufbau einer Datenbankverbindung. Für Oracle z.B.: \textit{jdbc:oracle:thin:@}.
+\textbf{BACKEND\_DB\_DRIVER}
+\\Der Name des JDBC-Treibers, der es erlaubt das Protokoll der Datenbank zu
+sprechen. Im Falle einer Oracle XE wäre dies z.B.: \textit{oracle.jdbc.OracleDriver}.
+\textbf{BACKEND\_DB\_DIALECT}
+\\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}.
+\textbf{IMPORTER\_MAINVALUE\_TYPES}
+\\Diese Einstellung erlaubt die Angabe eines Textes, der aus den gültigen Typen
+für Hauptwerte zusammengesetzt ist. \textit{QWTD} ist standardmäßig gesetzt.
+\textbf{IMPORTER\_ANNOTATION\_TYPES}
+\\Diese Einstellung verweist auf eine Datei (relativ zum Ort der \textit{run.sh}
+im Dateisystem), die die möglichen Typen von Streckenfavoriten und deren Regeln
+definiert. Siehe hierzu auch Kapitel \ref{annotation-types}.
+Die im folgenden beschriebenen Einstellungen können jeweils die Werte
+\textit{true} oder \textit{false} annehmen und sind optional anzupassen.
+\textbf{IMPORTER\_DRY\_RUN}
+\\Falls \textit{true} gesetzt wird, wird der Import nur simuliert. Es werden
+keine Daten in die Datenbank geschrieben. Dies kann z.B.: zum Ermitteln
+potentieller Dateninkonsistenzen sinnvoll sein.
+\textbf{IMPORTER\_SKIP\_GAUGES}
+\\Wenn \textit{true} gesetzt ist werden keine Pegel- und Stammdaten bearbeitet.
+\textbf{IMPORTER\_SKIP\_ANNOTATIONS}
+\\Wenn \textit{true} gesetzt ist werden keine Streckenfavoriten bearbeitet.
+\textbf{IMPORTER\_SKIP\_WST}
+\\Wenn \textit{true} gesetzt ist werden keine WST Dateien bearbeitet.
+\textbf{IMPORTER\_SKIP\_PRFS}
+\\Wenn \textit{true} gesetzt ist werden keine Querprofilspuren bearbeitet.
+\textbf{IMPORTER\_SKIP\_HYKS}
+\\Wenn \textit{true} gesetzt ist werden keine HYK Dateien bearbeitet.
+\textbf{IMPORTER\_SKIP\_EXTRA\_WST}
+\\Wenn \textit{true} gesetzt ist werden keine zusätzlichen Längsschnitte
+bearbeitet.
+\textbf{IMPORTER\_SKIP\_FIXATIONS}
+\\Wenn \textit{true} gesetzt ist werden keine Fixierungen bearbeitet.
+\textbf{IMPORTER\_SKIP\_OFFICIAL\_LINES}
+\\Wenn \textit{true} gesetzt ist werden keine offiziellen Linien bearbeitet.
+\textbf{IMPORTER\_SKIP\_FLOOD\_WATER}
+\\Wenn \textit{true} gesetzt ist werden keine Hochwassermarken bearbeitet.
+\textbf{IMPORTER\_SKIP\_FLOOD\_PROTECTION}
+\\Wenn \textit{true} gesetzt ist werden keine Hochwasserschutzanlagen
+bearbeitet.
+\textbf{IMPORTER\_SKIP\_BED\_HEIGHT\_SINGLE}
+\\Wenn \textit{true} gesetzt ist werden keine mittleren Sohlhöhen (Peilungen) bearbeitet.
+\textbf{IMPORTER\_SKIP\_BED\_HEIGHT\_EPOCH}
+\\Wenn \textit{true} gesetzt ist werden keine mittleren Sohlhöhen (Epochen)
+bearbeitet.
+\textbf{IMPORTER\_SKIP\_SEDIMENT\_DENSITY}
+\\Wenn \textit{true} gesetzt ist werden keine Dateien zur Sedimentdichte
+bearbeitet.
+\textbf{IMPORTER\_SKIP\_MORPHOLOGICAL\_WIDTH}
+\\Wenn \textit{true} gesetzt ist wird keine morphologische Breite bearbeitet.
+\textbf{IMPORTER\_SKIP\_FLOW\_VELOCITY}
+\\Wenn \textit{true} gesetzt ist werden keine Fließgeschwindigkeiten bearbeitet.
+\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.
+\textbf{IMPORTER\_SKIP\_WATERLEVEL\_DIFFERENCES}
+\\Wenn \textit{true} gesetzt ist werden keine Sohlhöhendifferenzen bearbeitet.
+\textbf{IMPORTER\_SKIP\_SQ\_RELATION}
+\\Wenn \textit{true} gesetzt ist werden keine Daten für die Berechnungsart
+SQ-Beziehung bearbeitet.
 \subsection{Fehler und Warnungen}
 \subsubsection{Fehler}
 \textbf{error while parsing gew}
 weitere Informationen zum Aktivieren/Deaktivieren einzelner Dateitypen beim
 Import.
 \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
 folgenden Befehl aus:\\
 \begin{lstlisting}

Mercurial > dive4elements > river

comparison flys-backend/doc/documentation/de/importer-hydr-morph.tex @ 3667:9b08db037ee5