# HG changeset patch # User Ingo Weinzierl # Date 1346067760 0 # Node ID 9b08db037ee57337f9dc44f7938f998083b26c2c # Parent 9f768a9034f4ae8523c68caeed2866f5b702e4ff Fixes and structural changes in the german documentation. flys-backend/trunk@5273 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r 9f768a9034f4 -r 9b08db037ee5 flys-backend/ChangeLog --- a/flys-backend/ChangeLog Mon Aug 27 09:55:56 2012 +0000 +++ b/flys-backend/ChangeLog Mon Aug 27 11:42:40 2012 +0000 @@ -1,3 +1,11 @@ +2012-08-27 Ingo Weinzierl + + * doc/documentation/de/title.tex, + doc/documentation/de/overview.tex, + doc/documentation/de/importer-hydr-morph.tex, + doc/documentation/de/importer-manual.tex: Smaller fixed and structural + changes. + 2012-08-27 Ingo Weinzierl * doc/documentation/de/importer-hydr-morph.tex: Added documentation from diff -r 9f768a9034f4 -r 9b08db037ee5 flys-backend/doc/documentation/de/importer-hydr-morph.tex --- a/flys-backend/doc/documentation/de/importer-hydr-morph.tex Mon Aug 27 09:55:56 2012 +0000 +++ b/flys-backend/doc/documentation/de/importer-hydr-morph.tex Mon Aug 27 11:42:40 2012 +0000 @@ -15,21 +15,43 @@ somit eine Transaktion. \textbf{Hinweis} -\\Der Import geht wie Desktop-FLYS davon aus, dass die Dateien Latin-1 encodiert -vorliegen! +\\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. + +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 -geschehen soll. Details hierzu im Anhang 'Klassifikation von Streckenfavoriten'. +XML-Datei angegeben werden. In dieser Datei werden die Typen und Regeln +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'} @@ -43,47 +65,47 @@ 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 -Praxis ist "QWD" eine sinnvolle Belegung. +mit gültigen Typen von Stammdaten enthalten. Vorbelegt ist \textit{QWTD}. In der +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. @@ -101,9 +123,75 @@ flys.backend.importer.skip.sq.relation +\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, +in der Regeln für diese Klassifikation definiert werden. Schematisch gliedert +sich diese Datei in die zwei Bereiche 'types' und 'patterns': + +\begin{lstlisting} + + + ... + ... + ... + + + ... + ... + ... + + +\end{lstlisting} + +In der Sektion 'types' werden die Kategorien vereinbart, in die klassifiziert +werden sollen. Die geschieht mit einzelnen + +\begin{lstlisting} + + + ... + +\end{lstlisting} + +Das Attribut 'default' kann 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 +den zuvor definierten Kategorien zuordnet. Hierfür können zwei Arten von +Definitionen angegeben werden: + +\begin{lstlisting} + +\end{lstlisting} + +oder + +\begin{lstlisting} + +\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 -Regeln zu, wird +der erste Treffer angewandt. Findet keine der -Regeln Anwendung, wird +die Kategorie ausgewählt, die in der -Section das Attribut +\textit{default} gesetzt hat. + +Die zweite Regel-Variante 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. +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 +\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 @@ -238,71 +326,6 @@ SQ-Beziehung bearbeitet. -\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, -in der Regeln für diese Klassifikation definiert werden. Schematisch gliedert -sich diese Datei in die zwei Bereiche 'types' und 'patterns': - -\begin{lstlisting} - - - ... - ... - ... - - - ... - ... - ... - - -\end{lstlisting} - -In der Sektion 'types' werden die Kategorien vereinbart, in die klassifiziert -werden sollen. Die geschieht mit einzelnen - -\begin{lstlisting} - - - ... - -\end{lstlisting} - -Das Attribut 'default' kann 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 -den zuvor definierten Kategorien zuordnet. Hierfür können zwei Arten von -Definitionen angegeben werden: - -\begin{lstlisting} - -\end{lstlisting} - -oder - -\begin{lstlisting} - -\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 -Regeln zu, wird -der erste Treffer angewandt. Findet keine der -Regeln Anwendung, wird -die Kategorie ausgewählt, die in der -Section das Attribut -\textit{default} gesetzt hat. - -Die zweite Regel-Variante 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. -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{Fehler und Warnungen} @@ -658,6 +681,7 @@ \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:\\ diff -r 9f768a9034f4 -r 9b08db037ee5 flys-backend/doc/documentation/de/importer-manual.tex --- a/flys-backend/doc/documentation/de/importer-manual.tex Mon Aug 27 09:55:56 2012 +0000 +++ b/flys-backend/doc/documentation/de/importer-manual.tex Mon Aug 27 11:42:40 2012 +0000 @@ -24,15 +24,15 @@ % Document DATE and VERSION % set these values when releasing a new version -\newcommand{\documentdate}{April 27th, 2010} +\newcommand{\documentdate}{27. August 2012} \newcommand{\documentversion}{1.0} -\newcommand{\documentrevision}{FIXME SVN REV} -\newcommand{\documentID}{installation-admin-manual.tex} +\newcommand{\documentrevision}{rev5271} +\newcommand{\documentID}{importer-manual.tex} %---------------------------------------------- %---------------------------------------------- % Document TITLE -\newcommand{\documenttitle}{Generic Viewer -- Installation and Operations} +\newcommand{\documenttitle}{FLYS: Datenimport von Fach- und Geodaten} \newcommand{\todo}{\textcolor{red}{ TODO }} diff -r 9f768a9034f4 -r 9b08db037ee5 flys-backend/doc/documentation/de/overview.tex --- a/flys-backend/doc/documentation/de/overview.tex Mon Aug 27 09:55:56 2012 +0000 +++ b/flys-backend/doc/documentation/de/overview.tex Mon Aug 27 11:42:40 2012 +0000 @@ -70,8 +70,9 @@ \end{enumerate} -Auf der Kommandozeile ist es beispielsweise möglich, mittels $Sqlplus$ das -\i{oracle.sql} Skript mittels folgendem Befehl einzuspielen: \\ +Auf der Kommandozeile ist es beispielsweise möglich, mittels \textit{Sqlplus} +das \textit{oracle.sql} Skript mittels folgendem Befehl einzuspielen: \\ + \begin{lstlisting} sqlplus benutzername/passwort @oracle.sql \end{lstlisting} diff -r 9f768a9034f4 -r 9b08db037ee5 flys-backend/doc/documentation/de/title.tex --- a/flys-backend/doc/documentation/de/title.tex Mon Aug 27 09:55:56 2012 +0000 +++ b/flys-backend/doc/documentation/de/title.tex Mon Aug 27 11:42:40 2012 +0000 @@ -18,7 +18,7 @@ { \sffamily\large - Dokumentation Datenimporter FLYS, BfG + Dokumentation Datenimport FLYS, BfG \vspace{1cm} { @@ -27,9 +27,11 @@ } \vspace{1cm} - Version \documentversion~-~Date: \documentdate + Version \documentversion + + Datum: \documentdate - Revision \documentrevision + Revision: \documentrevision } \vspace{4cm}