dive4elements/gnv-client: doc/config-manual/model_of

annotate doc/config-manual/model_of_transitions.tex @ 944:4d1a1917282d

Added short documentation for the file timegap_definition.xml. doc/trunk@1088 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Tim Englich <tim.englich@intevation.de>
date	Mon, 10 May 2010 14:19:58 +0000
parents	8e02d5f567df
children	491b8d6cd291

rev	line source
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	1 \section{Model of transitions}
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	2 \subsection{Overview of Subject-Specific Configuration: From FIS, Products, States,
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	3 Transitions and SQL-statements}
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	4
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	5 The GNV-system provides several expert information systems (FIS). Within a FIS
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	6 users can select products for analysing and visualising different
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	7 subject-specific issues like timeseries diagrams and different types of
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	8 profiles. In order to generate these products, different kind of data out of the
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	9 dataware house is needed.
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	10
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	11 The configuration is mainly split up into two steps\footnote{Except for
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	12 integrating the MapViewer. There is a third step necessary by configuring
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	13 additional tables in the datawarehouse}:
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	14 \begin{enumerate}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	15 \item FIS and their according products (Metainformation)
943 8e02d5f567df Done some litte changes in the introduction of the Tim Englich <tim.englich@intevation.de> parents: 942 diff changeset	16 \item Products with their states, transitions, outputs and SQL-statements
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	17 (Implementation)
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	18 \end{enumerate}
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	19
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	20 %% TODO: Add a Screenshot of the GNV WebClient marking GUI elements for FIS,
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	21 %% product, states and transitions
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	22
943 8e02d5f567df Done some litte changes in the introduction of the Tim Englich <tim.englich@intevation.de> parents: 942 diff changeset	23 Main entry point for the configuration also is the file {\tt conf/conf.xml }
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	24 defining the list of FIS and the according products based on the different
943 8e02d5f567df Done some litte changes in the introduction of the Tim Englich <tim.englich@intevation.de> parents: 942 diff changeset	25 datamodels in the datawarehouse.
8e02d5f567df Done some litte changes in the introduction of the Tim Englich <tim.englich@intevation.de> parents: 942 diff changeset	26
8e02d5f567df Done some litte changes in the introduction of the Tim Englich <tim.englich@intevation.de> parents: 942 diff changeset	27 The provided datamodels are:
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	28
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	29 \begin{enumerate}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	30 \item ESRI ArcMarineBSH with following subtypes
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	31 \begin{enumerate}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	32 \item TimeSeriesPoints
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	33 \item MeshFeatures
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	34 \item Measurements/InstantaneousPoints
914 4c701fd2b3bb Added MarineFeatures as Subtype of ESRI ArcMarineBSH Tim Englich <tim.englich@intevation.de> parents: 913 diff changeset	35 \item Marine Features
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	36 \end{enumerate}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	37 \item ESRI ArcS57,
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	38 \item CONTIS
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	39 \end{enumerate}
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	40
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	41 Each product configuration consists of a datamodel specific configuration
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	42 organized in a product specific folder in {\tt conf/products} \footnote{The
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	43 special case of a {\tt Horizontales Schnittprofil} is configured in
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	44 {\tt conf/horizontalprofile/conf\_mesh\_cross.xml} }. The directory layout looks
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	45 like this:
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	46
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	47 \begin{verbatim}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	48 products/
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	49 \|-- horizontalcrosssection
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	50 \| `-- conf_mesh.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	51 \|-- horizontalprofile
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	52 \| \|-- conf_instantaneouspoint.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	53 \| \|-- conf_mesh.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	54 \| `-- conf_mesh_cross.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	55 \|-- layer
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	56 \| `-- conf.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	57 \|-- timeseries
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	58 \| \|-- conf_mesh.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	59 \| \|-- conf_timeseriespoint.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	60 \| `-- timegap_definition.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	61 \|-- verticalcrosssection
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	62 \| `-- conf_mesh.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	63 `-- verticalprofile
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	64 \|-- conf_instantaneouspoint.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	65 \|-- conf_mesh.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	66 `-- conf_timeseriespoint.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	67 \end{verbatim}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	68
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	69 The subtypes of the ArcMarineBSH based datamodel are configured in the files below:
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	70 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	71 \item TimeSeriesPoints: {\tt conf\_timeseriespoint.xml}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	72 \item Mesh: {\tt conf\_mesh.xml}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	73 \item InstantaneousPoints: {\tt conf\_instantaneouspoint.xml}
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	74 \end{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	75
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	76 Within each of these files, the steps for gathering the values for the
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	77 parameterisation are configured by defining states, transitions and outputs
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	78 (c.f. \ref{ref:config-a-product}). The definition of states, transitions and
931 4615bc4dc822 Added some FIXMEs where questions arose. Hans Plum <hans.plum@intevation.de> parents: 920 diff changeset	79 outputs reference the actual SQL-statements via an identifier. The SQL-statements
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	80 are gathered in the file {\tt conf/queries.properties}.
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	81
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	82
931 4615bc4dc822 Added some FIXMEs where questions arose. Hans Plum <hans.plum@intevation.de> parents: 920 diff changeset	83 \subsection{Explaining the background of the XML configuration}
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	84
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	85 It is possible to configure the GNV in many ways.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	86 It is possible to add or remove FIS, add or remove products from a FIS or
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	87 to manipulate the steps which must be gone until a product can be create
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	88 a diagram or generate an CSV-export.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	89
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	90 The configuration of the provided FIS are divided in three main parts.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	91
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	92 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	93 \item Configuration of the list of FIS via {\tt artifact-factories}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	94 \item Configuration of main {\tt artifacts} which will be instantiated if an
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	95 {\tt artifact-factory} was called.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	96 \item Configuration of the different {\tt artifacts} which provides products which can be
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	97 served by the FIS.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	98 \end{itemize}
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	99
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	100 \subsubsection{Configuration of a FIS}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	101 The point of entry into the system is to configure an {\tt artifact-factory}.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	102 Each {\tt artifact-factory} represents one FIS.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	103 It is possible to configure several {\tt artifact-factories}.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	104 The {\tt artifact-factories} will be configured in the section
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	105 {\tt /artifact-database/artifact-factories} of the configurationfile.
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	106
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	107 \begin{lstlisting}
931 4615bc4dc822 Added some FIXMEs where questions arose. Hans Plum <hans.plum@intevation.de> parents: 920 diff changeset	108 <artifact-factory name='fis_NEWFISNAME'
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	109 description='Factory to create an artifact to be used with the FIS NEWFISNAME'
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	110 ttl='3600000'
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	111 artifact='de.intevation.artifactdatabase.ProxyArtifact'>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	112 de.intevation.gnv.artifacts.GNVProductArtifactFactory
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	113 </artifact-factory>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	114 \end{lstlisting}
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	115
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	116 At this moment the following attributes of an {\tt artifact-factory} are configurable.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	117 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	118 \item {\tt name}: The name of the {\tt artifact}. Must be unique in one {\tt artifact-server}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	119 \item {\tt description}: Short description which job the {\tt artifact-factory} has to do.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	120 \item {\tt ttl}: The time to live: The time using milliseconds an {\tt artifact}, created using this
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	121 factory, can live without any user-interaction.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	122 \item {\tt artifact}: The name of the class of the {\tt artifact} which should be created.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	123 \end{itemize}
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	124
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	125 The next listing shows the dependencies between the FIS and the name
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	126 of the {\tt artifact-factory} which belongs to it.
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	127
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	128 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	129 \item Marnet: {\tt fis\_marnet}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	130 \item IMIS: {\tt fis\_imis}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	131 \item STAUN: {\tt fis\_staun}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	132 \item Modeldata {\tt fis\_modeldata}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	133 \item Iceclimatology: {\tt fis\_eisklimatologie}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	134 \item Ice Station Report: {\tt fis\_icestations}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	135 \item SST: {\tt fis\_sst}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	136 \item Delphin: {\tt fis\_delphin}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	137 \item Thermosalinograph: {\tt fis\_thermosalinograph}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	138 \item Chemusurvey: {\tt fis\_chemusurvey}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	139 \item GTS: {\tt fis\_gts}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	140 \item CTD: {\tt fis\_bsh\_ctd}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	141 \item XBT: {\tt fis\_bsh\_xbt}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	142 \item SeaCat: {\tt fis\_seacat}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	143 \item Sea State: {\tt fis\_seastate}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	144 \item Current Meter: {\tt fis\_currentmeter}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	145 \item Nauthis: {\tt fis\_nauthis}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	146 \item Contis: {\tt fis\_contis}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	147 \item Marine Features: {\tt fis\_marinefeatures}
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	148 \end{itemize}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	149
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	150 \subsubsection{Configuration of main Artifact}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	151 For each {\tt artifact-factory} it is necessary to configure one {\tt artifact} which will be
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	152 created using the factory.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	153 This {\tt artifact} is the representation of the specific FIS.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	154 It contains the configuration which products will be served for this FIS.
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	155
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	156 The {\tt artifacts} are configured in the section {\tt /artifact-database/artifacts} of
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	157 the configurationfile.
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	158
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	159 \begin{lstlisting}
931 4615bc4dc822 Added some FIXMEs where questions arose. Hans Plum <hans.plum@intevation.de> parents: 920 diff changeset	160 <artifact name='fis_NEWFISNAME'>
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	161 <products>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	162 ...
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	163 </products>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	164 </artifact>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	165 \end{lstlisting}
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	166
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	167 The key is to use the same name for the {\tt artifact} as used for the {\tt artifact-factory}.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	168 The name has to be unique.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	169 In the section {\tt /artifact/products} it is possible to define several products as
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	170 explained in the next section.
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	171
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	172 \paragraph{Products to an FIS}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	173 One FIS can provide several products.
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	174 To do this it is required to configure them as shown below in the section
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	175 {\tt /artifact/products}
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	176
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	177 \begin{lstlisting}
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	178 <product name= "timeSeries">
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	179 <artifact-factory name="timeSeries"
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	180 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	181 ttl="300000"
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	182 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	183 de.intevation.gnv.artifacts.GNVArtifactFactory
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	184 </artifact-factory>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	185 <parameters>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	186 <parameter name="sourceid"
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	187 value="4"/>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	188 <parameter name="fisname"
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	189 value="fis\_marnet"/>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	190 </parameters>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	191 </product>
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	192 \end{lstlisting}
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	193
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	194 Each {\tt product} is also represented by an {\tt artifact}. To create this {\tt artifact} we have to
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	195 use an {\tt artifact-factory} which is configured in each product
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	196 ({\tt /product/artifact-factory}).
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	197
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	198 Each product can have several parameters ({\tt /product/parameters/parameters}).
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	199 The {\tt parameter} named {\tt sourceid} and {\tt fisname} are required parameters.
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	200
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	201 The parameter {\tt fisname} contains the key to the name of the FIS. The key must be
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	202 unique.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	203 The parameter {\tt sourceid} contains the key to identify the FIS in the
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	204 datawarehouse. ({\tt MEDIAN.SOURCEINFO})
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	205
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	206
910 329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	207 \subsubsection{Configuration of an Product}
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	208 \label{ref:config-a-product}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	209 The {\tt products} of the different FIS are also modeled as artifact-objects.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	210 The different products which are currently available are stored in separate
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	211 files in the folder {\tt project}.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	212
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	213 In those files the workflow of each product is configured. Each step which is
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	214 required to model a new diagram is represented using a {\tt state} in the
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	215 configurationfile.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	216
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	217 To move between those {\tt states} it is required to model {\tt transitions} which define
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	218 between which states it is possible to move and which conditions must be
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	219 fulfilled.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	220
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	221 The last step is called {\tt output-state}. This state is responsible to generate the
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	222 output for the different formats which can be served from the product ({\tt Diagram,
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	223 CSV, ODV, WMS,..}.).
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	224
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	225 \paragraph{States}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	226 A {\tt state} is one step which is required to fetch the data for generating e.g. an
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	227 diagram.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	228
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	229 For example in each product it is possible to choose one or more parameters.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	230
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	231 To configure a state you have to use a XML-fragment as shown below:
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	232
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	233 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	234 <state id="timeseries_parameter" description="timeseries_parameter" state="de.intevation.gnv.state.DefaultState">
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	235 <queryID>timeseries_parameter</queryID>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	236 <dataname>parameterid</dataname>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	237 <data-multiselect>true</data-multiselect>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	238 <inputvalues>
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	239 ...
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	240 </inputvalues>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	241 </state>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	242 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	243
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	244 At this moment the following attributes of an {\tt state} are configurable.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	245 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	246 \item {\tt id}: The name of the artifact. Must be unique in one artifact-server
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	247 \item {\tt description}: Short description which job the artifact-factory has to do.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	248 \item {\tt queryID}: The id of the query which should be used to fetch the data
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	249 displayed in this state. All queries are defined in the file
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	250 conf/queries.properties
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	251 \item {\tt dataname}: The id of the data which will be displayed in this state.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	252 The id will be use to localize the description of the data.
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	253 The localization is located in module gnv-artifacts in folder
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	254 src/main/resources.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	255 \item {\tt data-multiselect}: {\tt true} it is possible to select 1 or more items.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	256 {\tt false} it is possible to select only one item.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	257 \item {\tt inputvalues}: The values which can be "feed" to this state and which
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	258 will be used as values in SQL-statements.
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	259 \end{itemize}
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	260
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	261 \paragraph{Input Values of a State}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	262 At section {\tt /state/inputvalues} it is possible to add definitions for inputvalues.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	263 Those values have two meanings for the {\tt state}.
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	264
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	265 \begin{itemize}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	266 \item They were used to fill the SQL-statements to fetch the data.
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	267 (Each entry replace one ore more "?" )
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	268 \item They were used to validate the inputdata which is "feed" to
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	269 the FIS in the current state.
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	270 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	271
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	272 WARNING: The order of the inputvalues is significant at which position the value will
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	273 be put into the SQL-statement.
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	274
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	275 It is possible to add one inputvalue twice or more often to put its value at
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	276 different positions of the SQL-statement.
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	277
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	278 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	279 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	280 <inputvalue name="featureid" type="Integer" multiselect="false" usedinquery="1"/>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	281 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	282 <inputvalue name="parameterid" type="Integer" multiselect="true" usedinquery="0"/>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	283 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	284 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	285
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	286 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	287 \item {\tt name}: Name of the value that could be feed or should be used in SQL-statment.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	288 The name must fit to one dataname configured in this state or one other
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	289 state which was visited before.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	290 \item {\tt type}: The type of the value. This is required for the validation
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	291 of the value.
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	292 This might be String, Integer, Double, Date, Point, LineString,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	293 Polygon, Coordinate, Geometry and AttributeName.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	294 Coordinate is a format which accepts geographical coordinates in
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	295 the following Syntax: 56n30 6e20
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	296 AttributeName marks a stringvalue which will be used in
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	297 SQL-statement without surrounding with "'" in the statement.
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	298 Usage is e.g. for determining the Axis (i or j) in the workflow
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	299 of Horizontalprofiles.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	300 \item {\tt multiselect}: true if more than on value can be feed or put into the SQL-statement.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	301 false if one on value will be accepted.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	302 \item {\tt usedinquery}: Number how often the value should be put into the SQL-statement:
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	303 0: Value will not out into the statement.
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	304 1: Value will put once into the statement,
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	305 2 or more: Value will be put as often as configured
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	306 into the SQL-statement (this is useful if
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	307 inner-selects are used)
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	308 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	309
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	310 The next part will explain the usage of inputvalues.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	311
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	312 This SQL-statement is configured to use in the state above, which will fetch
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	313 all parameter-ids with the according german name which are reffered to the given
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	314 TimeSeriesPoint (e.g.Arkona Basin Buoy FeatureID = 100011 )
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	315
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	316
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	317 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	318 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	319 p.PARAMETERID KEY,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	320 p.GERMANNAME \|\| ' ['\|\| p.UNIT \|\|']' VALUE,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	321 p.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	322 FROM MEDIAN.PARAMETER P,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	323 MEDIAN.TIMESERIES TS,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	324 MEDIAN.TIMESERIESVALUE TSV,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	325 MEDIAN.MEASUREMENT M,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	326 MEDIAN.TIMESERIESPOINT TSP
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	327 WHERE M.FEATUREID = TSP.FEATUREID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	328 M.MEASUREMENTID = TSV.MEASUREMENTID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	329 TS.TIMESERIESID = TSV.TIMESERIESID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	330 P.PARAMETERID = TS.PARAMETERID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	331 TSP.FEATUREID = ?
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	332 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	333 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	334
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	335 If there are put the inputvalues in it it will look like this
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	336 if we assume that the inputvalues has got the following values
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	337 which where feed by choosing this FIS ({\tt fisname}) and the Station
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	338 ({\tt featureid}: Arkona Basin Buoy ):
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	339 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	340 \item {\tt featureid}: 100011 (Marnet ==> Arkona Basin Buoy)
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	341 \item {\tt fisname}: fis\_marnet
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	342 \item {\tt parameterid}: not set because it's the value that should be
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	343 chosen in this state.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	344 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	345
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	346 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	347 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	348 p.PARAMETERID KEY,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	349 p.GERMANNAME \|\| ' ['\|\| p.UNIT \|\|']' VALUE,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	350 p.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	351 FROM MEDIAN.PARAMETER P,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	352 MEDIAN.TIMESERIES TS,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	353 MEDIAN.TIMESERIESVALUE TSV,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	354 MEDIAN.MEASUREMENT M,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	355 MEDIAN.TIMESERIESPOINT TSP
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	356 WHERE M.FEATUREID = TSP.FEATUREID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	357 M.MEASUREMENTID = TSV.MEASUREMENTID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	358 TS.TIMESERIESID = TSV.TIMESERIESID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	359 P.PARAMETERID = TS.PARAMETERID AND
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	360 TSP.FEATUREID = 100011
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	361 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	362 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	363
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	364 The value of {\tt featureid} will be inserted into the query because
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	365 the attribute {\tt usedinquery} is set to "1".
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	366
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	367 The values of the inputvalues {\tt fisname} and {\tt parameterid} will be
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	368 excluded because the attribute {\tt usedinquery} is set to "0"
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	369
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	370
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	371 If the attribute {\tt usedinquery} of the inputvalue {\tt featureid} is set to "2"
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	372 this might happen.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	373
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	374 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	375 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	376 <inputvalue name="featureid" type="Integer" multiselect="false" usedinquery="2"/>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	377 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	378 <inputvalue name="parameterid" type="Integer" multiselect="true" usedinquery="0"/>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	379 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	380 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	381
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	382 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	383 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	384 ...
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	385 TSP.FEATUREID = ? AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	386 TSP.FEATUREID = ?
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	387 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	388 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	389
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	390 This SQL-statement will be modified to
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	391
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	392 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	393 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	394 ...
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	395 TSP.FEATUREID = 100011 AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	396 TSP.FEATUREID = 100011
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	397 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	398 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	399
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	400
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	401 At the next step of the workflow it is nessesary to determine all depths where
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	402 the choosen parameters are measured.
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	403 To do this we might have the following inputvalues:
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	404
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	405 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	406 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	407 <inputvalue name="featureid" type="Integer" multiselect="false" usedinquery="2"/>
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	408 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/>
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	409 <inputvalue name="parameterid" type="Integer" multiselect="true" usedinquery="1"/>
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	410 <inputvalue name="measurementid" type="Integer" multiselect="true" usedinquery="0"/>
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	411 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	412 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	413
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	414 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	415 \item {\tt featureid}: 100011 (Marnet ==> Arkona Basin Buoy)
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	416 \item {\tt fisname}: fis\_marnet
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	417 \item {\tt parameterid}: 2 (Salzgehalt [pSal])
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	418 \item {\tt measurementid}: not set because it's the value that should be
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	419 chosen in this state.
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	420 \end{itemize}
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	421
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	422 \begin{lstlisting}
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	423 SELECT DISTINCT
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	424 M.MEASUREMENTID KEY,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	425 M.ZLOCATION VALUE,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	426 P.PARAMETERID PARAMETERID
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	427 FROM MEDIAN.MEASUREMENT M,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	428 MEDIAN.TIMESERIESVALUE TSV,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	429 MEDIAN.TIMESERIES T,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	430 MEDIAN.PARAMETER P
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	431 WHERE M.MEASUREMENTID = TSV.MEASUREMENTID AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	432 TSV.TIMESERIESID = T.TIMESERIESID AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	433 T.PARAMETERID = P.PARAMETERID AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	434 M.FEATUREID = ? AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	435 M.FEATUREID = ? AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	436 P.PARAMETERID IN (?)
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	437 ORDER BY m.ZLOCATION DESC
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	438 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	439
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	440 This SQL-statement will be modified to
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	441
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	442 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	443 SELECT DISTINCT
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	444 M.MEASUREMENTID KEY,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	445 M.ZLOCATION VALUE,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	446 P.PARAMETERID PARAMETERID
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	447 FROM MEDIAN.MEASUREMENT M,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	448 MEDIAN.TIMESERIESVALUE TSV,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	449 MEDIAN.TIMESERIES T,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	450 MEDIAN.PARAMETER P
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	451 WHERE M.MEASUREMENTID = TSV.MEASUREMENTID AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	452 TSV.TIMESERIESID = T.TIMESERIESID AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	453 T.PARAMETERID = P.PARAMETERID AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	454 M.FEATUREID = 100011 AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	455 M.FEATUREID = 100011 AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	456 P.PARAMETERID IN (2)
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	457 ORDER BY m.ZLOCATION DESC
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	458 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	459
942 c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	460 The queries which are shown above are configurable.
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	461 You can do this in the file {\tt queries.properties } which will
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	462 be explained in the next paragraph.
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	463
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	464 \paragraph{Query-configuration (queries.properties)}
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	465
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	466 This file contains key-value-pairs to define SQL-statements.
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	467 All queries will be handle using the prepared-statement-syntax using "?"
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	468 to define a place where an dynamic value should be placed into the statement.
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	469
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	470 There is one special implementation to support spatial access to the
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	471 {\tt ArcSDE}, because the {\tt ArcSDE} does not support the access to
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	472 spatial objects using the definition of the Simple Feature Specification for
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	473 SQL of the OGC.
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	474
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	475 It was necessary to implement this mechanism to realize the access to spatial-
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	476 objects.
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	477
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	478 All queries which contains the following literals will be handle separate
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	479 using the {\tt ArcSDE-API}.
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	480
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	481 \begin{itemize}
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	482 \item {\tt ST\_ASTEXT(SHAPE)}: Will return the geometry as an WellKnowText (WKT)
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	483 \item {\tt ST\_ASTEXT(RASTER)}: Will return the raster in an readable way.
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	484 \item {\tt INTERSECTS(SHAPE,"?")}: Will only return the elements which geometry
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	485 intersects the given geometry ("?" will be
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	486 replace with an WKT)
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	487 \end{itemize}
c53a39cb7809 Moved section Query-configuration to Section Model of Transitions. Tim Englich <tim.englich@intevation.de> parents: 941 diff changeset	488
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	489
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	490 \paragraph{Transitions}
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	491
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	492 To move between two states it is necessary to configure dependencies between
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	493 the different states.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	494 This dependencies are called {\tt transitions}.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	495
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	496 There are different kinds of {\tt transitions} which can be used.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	497 \begin{itemize}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	498 \item Transitions which only link two states
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	499 \item Transition which link two states with a additional condition.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	500 (e.g. If a region was selected in the Regionfilter or not )
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	501 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	502
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	503 The listing below shows a transition with an additional condition.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	504 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	505 <transition transition="de.intevation.gnv.transition.ValueCompareTransition">
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	506 <from state="timeseries_area"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	507 <to state="timeseries_without_geom"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	508 <condition inputvalue="areaid" value="n/n" operator="equal"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	509 </transition>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	510 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	511
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	512 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	513 \item {\tt from}: The {\tt id} of the {\tt state} which you have to come from
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	514 \item {\tt to}: The {\tt id} of the {\tt state} which can be reached.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	515 \item {\tt condition}: The condition which have to be fulfilled.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	516 \end{itemize}
934 c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation Tim Englich <tim.englich@intevation.de> parents: 931 diff changeset	517
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	518 At this moment only {\tt EQUAL} and {\tt NOTEQUAL} are supported as
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	519 {\tt condition} for an {\tt ValueCompare\-Transition}.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	520
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	521 \paragraph{Outputstate}
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	522
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	523 The {\tt outputstate} is an special {\tt state} which was created to define
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	524 the different possibilities of outputs for each product.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	525 An {\tt outputstate} is handled as an {\tt state} which is described above.
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	526 Additionally you are able to configure which kind of outputs should
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	527 be provided.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	528
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	529 There are several {\tt outputstates}. Each one is designed to create
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	530 the output for one special product.
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	531
915 a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	532 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	533 \item TimeSeries: {\tt TimeSeriesOutputState}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	534 \item Horizontalprofile: {\tt HorizontalProfileOutputState}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	535 \item Horizontalprofile on Meshes: {\tt HorizontalProfileMeshOutputState}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	536 \item Verticalcrosssection: {\tt VerticalCrossSectionOutputState}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	537 \item Verticalprofiles: {\tt VerticalProfileOutputState}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	538 \item Horizontalcrosssections: {\tt HorizontalCrossSectionMeshOutputState}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	539 \item Layer: {\tt LayerOutputState}
915 a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	540 \end{itemize}
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	541
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	542 All these outputstates are implemented in {\tt package de.intevation.gnv.state}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	543 and its {\tt sub\-packages}.
915 a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	544
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	545 You have to put the fullqualified name of the {\tt outputstate} to the attribute
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	546 {\tt state} as shown below.
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	547
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	548 You can configure an {\tt outputstate} as shown below:
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	549
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	550 \begin{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	551 <state id="timeseries_calculate_results" description="timeseries_interval" state="de.intevation.gnv.state.timeseries.TimeSeriesOutputState">
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	552 <queryID>timeseries_chart_data</queryID>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	553 ...
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	554 <outputsModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	555 <outputsMode name="chart" description="Chartrepresentation of the Values" mime-type="image/png">
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	556 ...
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	557 </outputsMode>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	558 </outputsModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	559 </state>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	560 \end{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	561
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	562 At section {\tt /state/outputsModes} it is possible to add one ore more
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	563 {\tt outputmodes} to one state as shown in the next paragraph.
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	564
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	565 \paragraph{OutputModes}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	566
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	567 It is possible to configure several {\tt outputmodes} in one {\tt outputstate}.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	568 Inserting or deleting the configuration of an special
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	569 {\tt outputmode} will cause that the pending item will be shown or hidden
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	570 in the {\tt GUI}.
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	571
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	572 WARNING: IT MIGHT BE POSSIBLE THAT ONE OR MORE OUTPUTMODES ARE NOT
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	573 SUPPORTED BY AN PRODUCT. IN THAT CASE IT IS NECESSARY TO
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	574 IMPLEMENT THE REQUIRED FUNCTIONALITY BEFORE IT IS POSSIBLE
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	575 TO OFFER THIS OUTPUTMODE.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	576
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	577 Currently the following {\tt outputmodes} are supported:
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	578
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	579 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	580 \item {\tt chart}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	581 \item {\tt histogram}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	582 \item {\tt csv}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	583 \item {\tt odv}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	584 \item {\tt statistics}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	585 \item {\tt wms}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	586 \item {\tt shapefile}
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	587 \end{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	588
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	589 The following example shows how to configure an {\tt outputmode chart}:
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	590
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	591 \begin{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	592 <outputsMode name="chart" description="Chartrepresentation of the Values" mime-type="image/png">
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	593 <parameters>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	594 <inputvalue name="width" type="Integer" value="600"/>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	595 <inputvalue name="height" type="Integer" value="400"/>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	596 <inputvalue name="points" type="Boolean" value="false"/>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	597 </parameters>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	598 <exportModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	599 <export name="img" description="IMG-Export der Daten" mime-type="image/png" />
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	600 <export name="pdf" description="PDF-Export der Daten" mime-type="application/pdf" />
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	601 <export name="svg" description="SVG-Export der Daten" mime-type="image/svg+xml" />
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	602 </exportModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	603 </outputsMode>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	604 \end{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	605
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	606 // TODO add simple OutputMode e.g. for CSV??
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	607
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	608 \begin{itemize}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	609 \item {\tt name}: The name of the mode. This must not be changed because it
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	610 is used by the program.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	611 \item {\tt description}: a short description of this outputmode.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	612 \item {\tt parameters}: one ore more parameters which will be shown in the
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	613 GUI e.g. for changing the size of an chart.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	614 \item {\tt exportModes} : one or more formats which can be served.
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	615 \end{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	616
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	617
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	618 \subsection{Adding a new FIS}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	619 In this section it will be explained which steps has to be done to integrate a
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	620 new FIS into the {\tt artifact-server}. This will be done using the configuration for
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	621 an FIS which use data from {\tt MEDIAN.TIMESERIES} section of the datawarehouse e.g.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	622 MARNET or STAUN
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	623
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	624 Pay attention that for publishing the changes to the {\tt artifact-server} you will
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	625 have to restart it.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	626
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	627 \subsubsection{Adding a new Artifact-factory}
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	628 First step is to add a new {\tt artifact-factory} to the configuration conf/conf.xml
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	629 To do this you have to add a new XML-fragment into the section
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	630 /factories/artifact-factories which look like that:
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	631
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	632 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	633 <artifact-factory name='fis\_NEWFISNAME'
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	634 description='Factory to create an artifact to be used with the FIS NEWFISNAME'
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	635 ttl='3600000'
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	636 artifact='de.intevation.artifactdatabase.ProxyArtifact'>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	637 de.intevation.gnv.artifacts.GNVProductArtifactFactory
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	638 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	639 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	640
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	641 In this XML-fragment you only have to replace the placeholder {\tt NEWFISNAME}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	642 with a unique short name for the new FIS.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	643
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	644 \paragraph{Example}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	645 This example shows how to add an FIS and which effects it took to the
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	646 REST-Server.
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	647
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	648 At first we add the following {\tt artifact-factory} into the file
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	649 {\tt conf/conf.xml} in section {\tt /artifact-database/artifact-factories}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	650 which add a new FIS called {\tt justanewfis} to the server:
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	651
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	652 \begin{lstlisting}
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	653 <artifact-factory name='fis\_justanewfis'
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	654 description='Factory to create an artifact to be used with the FIS NEWFISNAME'
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	655 ttl='3600000'
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	656 artifact='de.intevation.artifactdatabase.ProxyArtifact'>
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	657 de.intevation.gnv.artifacts.GNVProductArtifactFactory
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	658 </artifact-factory>
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	659 \end{lstlisting}
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	660
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	661 Then we restart the {\tt artifact-database} executing the following command:
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	662
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	663 \begin{lstlisting}
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	664 /etc/init.d/artifactdb restart
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	665 \end{lstlisting}
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	666
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	667 Then we check if the new FIS is served by the REST-Server
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	668 calling the following command:
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	669
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	670 \begin{lstlisting}
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	671 curl http://localhost:8181/factories \| xmllint --format - \| grep fis\_justanewfis
920 63bc0044ff72 Fixed some typos. Do some document-styling Tim Englich <tim.englich@intevation.de> parents: 919 diff changeset	672 \end{lstlisting}
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	673
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	674 If the FIS was added the new {\tt artifact-factory} will be found in the generated
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	675 XML-output and it will be shown.
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	676 Otherwise no XML-output will be shown.
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	677
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	678 \subsubsection{Adding a new Artifact for Artifact-factory}
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	679 The next step is to define the artifact itself.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	680 For this it is necessary to add an XML-fragment into the section
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	681 {\tt /artifacts} of the main configurationfile {\tt /conf/conf.xml}.
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	682
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	683 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	684 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	685 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	686 ...
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	687 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	688 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	689 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	690
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	691 In this XML-fragment it is also required to replace the placeholder {\tt NEWFISNAME}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	692 with the name which was used to configure the {\tt artifact-factory}.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	693
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	694 Now the {\tt artifact-server} can handle an additional FIS without any products yet.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	695
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	696 To prevent needless configuration-work it is useful way to clone an artifact
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	697 which handle the same kind of work as the new FIS.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	698
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	699
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	700 \paragraph{Example}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	701 Now we will configure an artifact to the FIS justanewfis.
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	702
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	703 For this we have to add the following XML-fragment to the file
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	704 {\tt conf/conf.xml} in section {\tt /artifact-database/artifacts}:
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	705
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	706 \begin{lstlisting}
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	707 <artifact name='fis\_justanewfis'>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	708 <products>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	709 </products>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	710 </artifact>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	711 \end{lstlisting}
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	712
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	713 Restart the artifact-database:
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	714
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	715 \begin{lstlisting}
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	716 /etc/init.d/artifactdb restart
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	717 \end{lstlisting}
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	718
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	719 Now we should be able to choose the artifact.
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	720
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	721 The Listbox with products will be empty.
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	722 \begin{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	723 curl -d "@sample-documents/create-artifact.xml" http://localhost:8181/create \| xmllint --format -
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	724 \end{lstlisting}
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	725
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	726 \subsubsection{Adding removing Products to the specific Artifact}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	727 Now it is time to configure the different products which the FIS should be able
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	728 to provide.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	729 To do this it is necessary to copy the XML-fragments of the products into the
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	730 XML-element {\tt products} of the previously integrated artifact.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	731 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	732 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	733 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	734 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	735 <artifact-factory name="timeSeries"
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	736 description="Artifactfactory for instantiating the artifact for TimeSeries on TimeSeriesPoints"
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	737 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	738 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	739 de.intevation.gnv.artifacts.GNVArtifactFactory
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	740 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	741 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	742 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	743 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	744 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	745 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	746 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	747 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	748 <product name= "verticalProfile">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	749 <artifact-factory name="verticalProfile"
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	750 description="Artifactfactory for instantiating the artifact for Verticalprofiles on TimeSeriesPoints"
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	751 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	752 artifact="de.intevation.gnv.profile.vertical.VerticalProfileArtifact">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	753 de.intevation.gnv.artifacts.GNVArtifactFactory
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	754 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	755 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	756 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	757 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	758 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	759 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	760 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	761 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	762 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	763 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	764 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	765
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	766 In this XML-fragment you have to replace the placeholders {\tt NEWFISNAME}
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	767 as before and {\tt VALUEOFSOURCEID} with the value for the new FIS as defined
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	768 in the table {\tt MEDIAN.SOURCEINFO}.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	769
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	770 \paragraph{Example}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	771 Now we will add a product to the new FIS.
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	772 To let the products work we will choose a product which
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	773 will contain the sourceid of an existing FIS (e.g 4 Marnet).
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	774
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	775 At first add the following XML-fragment to the new artifact.
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	776 \begin{lstlisting}
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	777 <product name= "timeSeries">
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	778 <artifact-factory name="timeSeries"
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	779 description="Artifactfactory for instantiating the artifact for TimeSeries on TimeSeriesPoints"
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	780 ttl="300000"
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	781 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	782 de.intevation.gnv.artifacts.GNVArtifactFactory
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	783 </artifact-factory>
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	784 <parameters>
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	785 <parameter name="sourceid"
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	786 value="4"/>
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	787 <parameter name="fisname"
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	788 value="fis\_justanewfis"/>
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	789 </parameters>
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	790 </product>
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	791 \end{lstlisting}
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	792
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	793 Restart the artifact-database:
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	794
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	795 \begin{lstlisting}
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	796 /etc/init.d/artifactdb restart
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	797 \end{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	798
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	799 If we call
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	800 \begin{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	801 curl -d "@sample-documents/create-artifact.xml" http://localhost:8181/create \| xmllint --format -
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	802 \end{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	803
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	804 the product {\tt timeSeries} should be available for the FIS {\tt justanewfis}.
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	805
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	806 Now we should be able to choose the product.
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	807 This product should work and you should be able to generate even the defined
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	808 outputformats.
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	809
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	810 \subsection{Adding a new Product}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	811 To add a new product to the system it is necessary that the required
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	812 artifact representation is implemented in the {\tt sourcecode}.
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	813 Without doing that step it is not possible to create a new product.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	814
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	815 All products are configured in separate files that will be included into the
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	816 main configuration using Xlink-references.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	817
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	818 First step is to create a new file in the folder {\tt products} and there in the
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	819 sub-folder where the product belongs to ({\tt timeseries,verticalprofile,
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	820 horizontalprofile,horizontal\-crosssection,layer,...})
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	821
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	822 Then you have tor reference this file in the file {\tt /conf/conf.xml} in the
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	823 section {\tt/artifacts} using the following XML-fragment.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	824
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	825 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	826 <artifact name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	827 xmlns:xlink="http://www.w3.org/1999/xlink"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	828 xlink:href="${artifacts.config.dir}/products/PATHTOFILE" />
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	829 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	830
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	831 The placeholder {\tt PATHTOFILE} has to be replaced with the relative path and
7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	832 the name of the file starting in the folder products.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	833
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	834 Then it is possible to add the product to a FIS as explained in the next section.
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	835 Please note that the defined name of the {\tt artifact-factory} has to match to the
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	836 name of the added products which is also designed as an artifact.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	837
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	838 \subsection{Adding a additional Product to a FIS}
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	839 To add a additional product to a FIS you only have to add the XML-fragment which
14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	840 represents the product to the artifact-configuration of the FIS in section
941 7a8f9eb9fb04 Do some Documentstyling. Added Typewriter-Style Tim Englich <tim.englich@intevation.de> parents: 940 diff changeset	841 {\tt /artifacts/artifact/products}.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	842
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	843 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	844 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	845 <artifact-factory name="timeSeries"
940 14df4bcabc3c Fixed some Mistakes Tim Englich <tim.englich@intevation.de> parents: 934 diff changeset	846 description="Artifactfactory for instantiating the artifact for TimeSeries on TimeSeriesPoints"
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	847 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	848 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	849 de.intevation.gnv.artifacts.GNVArtifactFactory
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	850 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	851 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	852 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	853 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	854 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	855 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	856 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	857 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	858 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	859
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	860 Please note that you have to replace the Placeholders as explained above.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	861

Mercurial > dive4elements > gnv-client

annotate doc/config-manual/model_of_transitions.tex @ 944:4d1a1917282d