Mercurial > dive4elements > gnv-client

annotate doc/config-manual/model_of_transitions.tex @ 940:14df4bcabc3c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed some Mistakes doc/trunk@1083 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Mon, 10 May 2010 10:43:01 +0000
parents c2ce233cd9cf
children 7a8f9eb9fb04
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)
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
16 \item products with their states, transitions, outputs and SQL-statements
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
911
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
23 Main entry point for the configuration is the file \verb+ conf/conf.xml +
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
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
25 datamodels in the datawarehouse. 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
26
911
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
27 \begin{enumerate}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
28 \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
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 TimeSeriesPoints
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
31 \item MeshFeatures
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
32 \item Measurements/InstantaneousPoints
914
4c701fd2b3bb Added MarineFeatures as Subtype of ESRI ArcMarineBSH
Tim Englich <tim.englich@intevation.de>
parents: 913
diff changeset
33 \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
34 \end{enumerate}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
35 \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
36 \item CONTIS
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
37 \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
38
911
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
39 Each product configuration consists of a datamodel specific configuration
912
3ca45a124985 Fixed compilation error
Hans Plum <hans.plum@intevation.de>
parents: 911
diff changeset
40 organized in a product specific folder in \verb+ conf/products+ \footnote{The
911
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
41 special case of a "Horizontales Schnittprofil" is configured in
912
3ca45a124985 Fixed compilation error
Hans Plum <hans.plum@intevation.de>
parents: 911
diff changeset
42 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
43 like this:
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
44
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
45 \begin{verbatim}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
46 products/
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
47 |-- horizontalcrosssection
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
48 | `-- 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
49 |-- horizontalprofile
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
50 | |-- 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
51 | |-- 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
52 | `-- 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
53 |-- layer
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
54 | `-- conf.xml
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
55 |-- timeseries
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
56 | |-- 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
57 | |-- 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
58 | `-- 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
59 |-- verticalcrosssection
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
60 | `-- 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
61 `-- verticalprofile
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
62 |-- 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
63 |-- 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
64 `-- 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
65 \end{verbatim}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
66
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
67 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
68 \begin{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
69 \item TimeSeriesPoints: conf\_timeseriespoint.xml
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
70 \item Mesh: conf\_mesh.xml
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
71 \item InstantaneousPoints: conf\_instantaneouspoint.xml
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
72 \end{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
73
911
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
74 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
75 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
76 (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
77 outputs reference the actual SQL-statements via an identifier. The SQL-statements
4615bc4dc822 Added some FIXMEs where questions arose.
Hans Plum <hans.plum@intevation.de>
parents: 920
diff changeset
78 are gathered in the file \verb+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
79
910
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
80
931
4615bc4dc822 Added some FIXMEs where questions arose.
Hans Plum <hans.plum@intevation.de>
parents: 920
diff changeset
81 \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
82
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
83 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
84 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
85 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
86 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
87
920
63bc0044ff72 Fixed some typos. Do some document-styling
Tim Englich <tim.englich@intevation.de>
parents: 919
diff changeset
88 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
89
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
90 \begin{itemize}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
91 \item Configuration of the list of FIS via artifact-factories
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
92 \item Configuration of main artifacts which will be instantiated if an
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
93 artifact-factory was called.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
94 \item Configuration of the different 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
95 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
96 \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
97
910
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
98 \subsubsection{Configuration of a FIS}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
99 The point of entry into the system is to configure an artifact-factory.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
100 Each artifact-factory represents one FIS.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
101 It is possible to configure several artifact-factories.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
102 The artifact-factories will be configured in the section
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
103 /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
104
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
105 \begin{lstlisting}
931
4615bc4dc822 Added some FIXMEs where questions arose.
Hans Plum <hans.plum@intevation.de>
parents: 920
diff changeset
106 <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
107 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
108 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
109 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
110 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
111 </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
112 \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
113
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
114 At this moment the following attributes of an 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
115 \begin{itemize}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
116 \item name: The name of the artifact. Must be unique in one artifact-server
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
117 \item description: Short description which job the artifact-factory has to do.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
118 \item ttl: The time to live: The time using milliseconds an artifact, created using this
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
119 factory, can live without any user-interaction.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
120 \item artifact: The name of the class of the 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
121 \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
122
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
123 The next listing shows the dependencies between the FIS and the name
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
124 of the 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
125
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
126 \begin{itemize}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
127 \item Marnet: fis\_marnet
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
128 \item IMIS: fis\_imis
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
129 \item STAUN: fis\_staun
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
130 \item Modeldata fis\_modeldata
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
131 \item Iceclimatology: fis\_eisklimatologie
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
132 \item Ice Station Report: fis\_icestations
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
133 \item SST: fis\_sst
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
134 \item Delphin: fis\_delphin
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
135 \item Thermosalinograph: fis\_thermosalinograph
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
136 \item Chemusurvey: fis\_chemusurvey
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
137 \item GTS: fis\_gts
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
138 \item CTD: fis\_bsh\_ctd
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
139 \item XBT: fis\_bsh\_xbt
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
140 \item SeaCat: fis\_seacat
911
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
141 \item Sea State: fis\_seastate
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
142 \item Current Meter: fis\_currentmeter
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
143 \item Nauthis: fis\_nauthis
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
144 \item Contis: fis\_contis
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
145 \item Marine Features: fis\_marinefeatures
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
146 \end{itemize}
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure
Hans Plum <hans.plum@intevation.de>
parents: 910
diff changeset
147
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
148 \subsubsection{Configuration of main Artifact}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
149 For each artifact-factory it is necessary to configure one artifact which will be
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
150 created using the factory.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
151 This artifact is the representation of the specific FIS.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
152 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
153
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
154 The artifacts are configured in the section /artifact-database/artifacts of
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
155 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
156
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
157 \begin{lstlisting}
931
4615bc4dc822 Added some FIXMEs where questions arose.
Hans Plum <hans.plum@intevation.de>
parents: 920
diff changeset
158 <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
159 <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
160 ...
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 </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
163 \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
164
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
165 The key is to use the same name for the artifact as used for the artifact-factory.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
166 The name has to be unique.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
167 In the section /artifact/products it is possible to define several products as
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
168 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
169
910
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
170 \paragraph{Products to an FIS}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
171 One FIS can provide several products.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
172 To do this it is required to configure them as shown below in the 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
173 /artifact/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
174
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
175 \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
176 <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
177 <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
178 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
179 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
180 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
181 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
182 </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
183 <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
184 <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
185 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
186 <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
187 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
188 </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
189 </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
190 \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
191
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
192 Each product is also represented by an artifact. To create this artifact we have to
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
193 use an artifact-factory which is configured in each product
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
194 (/product/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
195
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
196 Each product can have several parameters /product/parameters/parameters.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
197 The parameter named sourceid and 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
198
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
199 The parameter 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
200 unique.
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
201 The parameter sourceid contains the key to identify the FIS in the
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
202 datawarehouse. (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
203
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
204
910
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
205 \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
206 \label{ref:config-a-product}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
207 The products of the different FIS are also modeled as artifact-objects.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
208 The different products which are currently available are stored in separate
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
209 files in the folder project.
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
210
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
211 In those files the workflow of each product is configured. Each step which is
920
63bc0044ff72 Fixed some typos. Do some document-styling
Tim Englich <tim.englich@intevation.de>
parents: 919
diff changeset
212 required to model a new diagram is represented using a state in the
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
213 configurationfile.
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
214
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
215 To move between those states it is required to model transitions which define
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
216 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
217 fulfilled.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
218
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
219 The last step is called output-state. This state is responsible to generate the
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
220 output for the different formats which can be served from the product (Diagram,
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
221 CSV, ODV, WMS,...).
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
222
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
223 \paragraph{States}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
224 A state is one step which is required to fetch the data for generating e.g. an
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
225 diagram.
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
226
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
227 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
228
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
229 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
230
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
231 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
232 <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
233 <queryID>timeseries_parameter</queryID>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
234 <dataname>parameterid</dataname>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
235 <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
236 <inputvalues>
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
237 ...
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
238 </inputvalues>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
239 </state>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
240 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
241
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
242 At this moment the following attributes of an state are configurable.
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
243 \begin{itemize}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
244 \item id: The name of the artifact. Must be unique in one artifact-server
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
245 \item description: Short description which job the artifact-factory has to do.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
246 \item queryID: The id of the query which should be used to fetch the data
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
247 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
248 conf/queries.properties
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
249 \item dataname: The id of the data which will be displayed in this state.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
250 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
251 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
252 src/main/resources.
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
253 \item data-multiselect: true it is possible to select 1 or more items.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
254 false it is possible to select only one item.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
255 \item inputvalues: The values which can be "feed" to this state and which
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
256 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
257 \end{itemize}
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
258
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
259 \paragraph{Input Values of a State}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
260 At section /state/inputvalues it is possible to add definitions for inputvalues.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
261 Those values have two meanings for the state.
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
262
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
263 \begin{itemize}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
264 \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
265 (Each entry replace one ore more "?" )
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
266 \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
267 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
268 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
269
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
270 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
271 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
272
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
273 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
274 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
275
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
276 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
277 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
278 <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
279 <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
280 <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
281 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
282 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
283
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
284 \begin{itemize}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
285 \item name: Name of the value that could be feed or should be used in SQL-statment.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
286 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
287 state which was visited before.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
288 \item type: The type of the value. This is required for the validation
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
289 of the value.
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
290 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
291 Polygon, Coordinate, Geometry and AttributeName.
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
292 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
293 the following Syntax: 56n30 6e20
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
294 AttributeName marks a stringvalue which will be used in
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
295 SQL-statement without surrounding with "'" in the statement.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
296 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
297 of Horizontalprofiles.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
298 \item multiselect: true if more than on value can be feed or put into the SQL-statement.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
299 false if one on value will be accepted.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
300 \item usedinquery: Number how often the value should be put into the SQL-statement:
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
301 0: Value will not out into the statement.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
302 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
303 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
304 into the SQL-statement (this is useful if
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
305 inner-selects are used)
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
306 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
307
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
308 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
309
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
310 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
311 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
312 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
313
934
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
314
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
315 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
316 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
317 p.PARAMETERID KEY,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
318 p.GERMANNAME || ' ['|| p.UNIT ||']' VALUE,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
319 p.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
320 FROM MEDIAN.PARAMETER P,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
321 MEDIAN.TIMESERIES TS,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
322 MEDIAN.TIMESERIESVALUE TSV,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
323 MEDIAN.MEASUREMENT M,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
324 MEDIAN.TIMESERIESPOINT TSP
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
325 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
326 M.MEASUREMENTID = TSV.MEASUREMENTID AND
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
327 TS.TIMESERIESID = TSV.TIMESERIESID AND
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
328 P.PARAMETERID = TS.PARAMETERID AND
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
329 TSP.FEATUREID = ?
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
330 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
331 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
332
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
333 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
334 if we assume that the inputvalues has got the following values
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
335 which where feed by choosing this FIS (fisname) and the Station
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
336 (featureid: Arkona Basin Buoy ):
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
337 \begin{itemize}
934
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
338 \item featureid: 100011 (Marnet ==> Arkona Basin Buoy)
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
339 \item fisname: fis\_marnet
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
340 \item parameterid: not set because it's the value that should be
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
341 chosen in this state.
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
342 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
343
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
344 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
345 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
346 p.PARAMETERID KEY,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
347 p.GERMANNAME || ' ['|| p.UNIT ||']' VALUE,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
348 p.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
349 FROM MEDIAN.PARAMETER P,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
350 MEDIAN.TIMESERIES TS,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
351 MEDIAN.TIMESERIESVALUE TSV,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
352 MEDIAN.MEASUREMENT M,
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
353 MEDIAN.TIMESERIESPOINT TSP
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
354 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
355 M.MEASUREMENTID = TSV.MEASUREMENTID AND
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
356 TS.TIMESERIESID = TSV.TIMESERIESID AND
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
357 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
358 TSP.FEATUREID = 100011
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
359 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
360 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
361
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
362 The value of featureid will be inserted into the query because
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
363 the attribute 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
364
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
365 The values of the inputvalues fisname and parameterid will be
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
366 excluded because the attribute 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
367
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
368
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
369 If the attribute usedinquery of the inputvalue 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
370 this might happen.
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
371
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
372 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
373 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
374 <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
375 <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
376 <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
377 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
378 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
379
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
380 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
381 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
382 ...
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
383 TSP.FEATUREID = ? AND
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
384 TSP.FEATUREID = ?
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
385 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
386 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
387
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
388 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
389
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
390 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
391 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
392 ...
934
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
393 TSP.FEATUREID = 100011 AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
394 TSP.FEATUREID = 100011
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
395 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
396 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
397
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
398
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
399 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
400 the choosen parameters are measured.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
401 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
402
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
403 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
404 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
405 <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
406 <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
407 <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
408 <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
409 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
410 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
411
934
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
412 \begin{itemize}
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
413 \item featureid: 100011 (Marnet ==> Arkona Basin Buoy)
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
414 \item fisname: fis\_marnet
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
415 \item parameterid: 2 (Salzgehalt [pSal])
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
416 \item measurementid: not set because it's the value that should be
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
417 chosen in this state.
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
418 \end{itemize}
913
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
419
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
420 \begin{lstlisting}
934
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
421 SELECT DISTINCT
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
422 M.MEASUREMENTID KEY,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
423 M.ZLOCATION VALUE,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
424 P.PARAMETERID PARAMETERID
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
425 FROM MEDIAN.MEASUREMENT M,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
426 MEDIAN.TIMESERIESVALUE TSV,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
427 MEDIAN.TIMESERIES T,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
428 MEDIAN.PARAMETER P
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
429 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
430 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
431 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
432 M.FEATUREID = ? AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
433 M.FEATUREID = ? AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
434 P.PARAMETERID IN (?)
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
435 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
436 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
437
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
438 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
439
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
440 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
441 SELECT DISTINCT
934
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
442 M.MEASUREMENTID KEY,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
443 M.ZLOCATION VALUE,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
444 P.PARAMETERID PARAMETERID
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
445 FROM MEDIAN.MEASUREMENT M,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
446 MEDIAN.TIMESERIESVALUE TSV,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
447 MEDIAN.TIMESERIES T,
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
448 MEDIAN.PARAMETER P
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
449 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
450 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
451 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
452 M.FEATUREID = 100011 AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
453 M.FEATUREID = 100011 AND
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
454 P.PARAMETERID IN (2)
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
455 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
456 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States
Tim Englich <tim.englich@intevation.de>
parents: 912
diff changeset
457
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
458
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
459 \paragraph{Transitions}
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
460
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
461 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
462 the different states.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
463 This dependencies are called transitions.
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
464
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
465 There are different kinds of 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
466 \begin{itemize}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
467 \item Transitions which only link two states
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
468 \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
469 (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
470 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
471
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
472 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
473 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
474 <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
475 <from state="timeseries_area"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
476 <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
477 <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
478 </transition>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
479 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
480
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
481 \begin{itemize}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
482 \item from: The id of the state which you have to come from
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
483 \item to: The id of the state which can be reached.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
484 \item 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
485 \end{itemize}
934
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
486
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
487 At this moment only EQUAL and NOTEQUAL are supported as condition for an
934
c2ce233cd9cf Answerd Questions and increase some Sections of the Documentation
Tim Englich <tim.englich@intevation.de>
parents: 931
diff changeset
488 ValueCompareTransition.
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{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
491
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
492 The outputstate is an special state which was created to define
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
493 the different possibilities of outputs for each product.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
494 An outputstate is handled as an 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
495 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
496 be provided.
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
497
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
498 There are several outputstates. Each one is designed to create
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
499 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
500
915
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
501 \begin{itemize}
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
502 \item TimeSeries: TimeSeriesOutputState
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
503 \item Horizontalprofile: HorizontalProfileOutputState
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
504 \item Horizontalprofile on Meshes: HorizontalProfileMeshOutputState
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
505 \item Verticalcrosssection:VerticalCrossSectionOutputState
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
506 \item Verticalprofiles: VerticalProfileOutputState
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
507 \item Horizontalcrosssections: HorizontalCrossSectionMeshOutputState
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
508 \item Layer: LayerOutputState
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
509 \end{itemize}
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
510
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
511 All these outputstates are implemented in package de.intevation.gnv.state
915
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
512 and its subpackages.
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
513
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
514 You have to put the fullqualified name of the outputstate to the attribute state
915
a6f86fa053a1 Added listing of all supported OutputStates
Tim Englich <tim.englich@intevation.de>
parents: 914
diff changeset
515 as shown below.
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
516
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
517 You can configure an outputstate as shown below:
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
518
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
519 \begin{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
520 <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
521 <queryID>timeseries_chart_data</queryID>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
522 ...
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
523 <outputsModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
524 <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
525 ...
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
526 </outputsMode>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
527 </outputsModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
528 </state>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
529 \end{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
530
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
531 At section /state/outputsModes it is possible to add one ore more outputmodes
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
532 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
533
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
534 \paragraph{OutputModes}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
535
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
536 It is possible to configure several outputmodes in one outputstate.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
537 Inserting or deleting the configuration of an special
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
538 outputmode will cause that the pending item will be shown or hidden
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
539 in the GUI.
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
540
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
541 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
542 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
543 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
544 TO OFFER THIS OUTPUTMODE.
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
545
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
546 Currently the following outputmodes are supported:
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
547
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
548 \begin{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
549 \item chart
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
550 \item histogram
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
551 \item csv
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
552 \item odv
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
553 \item statistics
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
554 \item wms
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
555 \item shapefile
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
556 \end{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
557
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
558 The following example shows how to configure an outputmode chart:
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
559
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
560 \begin{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
561 <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
562 <parameters>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
563 <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
564 <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
565 <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
566 </parameters>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
567 <exportModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
568 <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
569 <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
570 <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
571 </exportModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
572 </outputsMode>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
573 \end{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
574
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
575 // 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
576
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
577 \begin{itemize}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
578 \item name: The name of the mode. This must not be changed because it is used
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
579 by the program.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
580 \item description: a short description of this outputmode.
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
581 \item parameters: one ore more parameters which will be shown in the GUI e.g.
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
582 for changing the size of an chart.
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
583 \item exportModes: one or more formats which can be served.
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
584 \end{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
585
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
586
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
587 \subsection{Adding a new FIS}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
588 In this section it will be explained which steps has to be done to integrate a
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
589 new FIS into the artifact-server. This will be done using the configuration for
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
590 an FIS which use data from 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
591 MARNET or STAUN
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
592
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
593 Pay attention that for publishing the changes to the 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
594 have to restart it.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
595
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
596 \subsubsection{Adding a new Artifact-factory}
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
597 First step is to add a new artifact-factory to the configuration conf/conf.xml
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
598 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
599 /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
600
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
601 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
602 <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
603 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
604 ttl='3600000'
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
605 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
606 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
607 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
608 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
609
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
610 In this XML-fragment you only have to replace the placeholder NEWFISNAME with a
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
611 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
612
916
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server
Tim Englich <tim.englich@intevation.de>
parents: 915
diff changeset
613 \paragraph{Example}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
614 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
615 REST-Server.
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server
Tim Englich <tim.englich@intevation.de>
parents: 915
diff changeset
616
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
617 At first we add the following artifact-factory into the file conf/conf.xml
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
618 in section /artifact-database/artifact-factories which add a new
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
619 FIS called 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
620
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server
Tim Englich <tim.englich@intevation.de>
parents: 915
diff changeset
621 \begin{lstlisting}
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server
Tim Englich <tim.englich@intevation.de>
parents: 915
diff changeset
622 <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
623 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
624 ttl='3600000'
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server
Tim Englich <tim.englich@intevation.de>
parents: 915
diff changeset
625 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
626 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
627 </artifact-factory>
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server
Tim Englich <tim.englich@intevation.de>
parents: 915
diff changeset
628 \end{lstlisting}
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server
Tim Englich <tim.englich@intevation.de>
parents: 915
diff changeset
629
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
630 Then we restart the 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
631
920
63bc0044ff72 Fixed some typos. Do some document-styling
Tim Englich <tim.englich@intevation.de>
parents: 919
diff changeset
632 \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
633 /etc/init.d/artifactdb restart
920
63bc0044ff72 Fixed some typos. Do some document-styling
Tim Englich <tim.englich@intevation.de>
parents: 919
diff changeset
634 \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
635
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server
Tim Englich <tim.englich@intevation.de>
parents: 915
diff changeset
636 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
637 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
638
920
63bc0044ff72 Fixed some typos. Do some document-styling
Tim Englich <tim.englich@intevation.de>
parents: 919
diff changeset
639 \begin{lstlisting}
919
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
640 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
641 \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
642
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
643 If the FIS was added the new artifact-factory will be found in the generated
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
644 XML-output and it will be shown.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
645 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
646
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
647 \subsubsection{Adding a new Artifact for Artifact-factory}
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
648 The next step is to define the artifact itself.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
649 For this it is necessary to add an XML-fragment into the section /artifacts of
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
650 the main configurationfile /conf/conf.xml
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
651 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
652 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
653 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
654 ...
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
655 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
656 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
657 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
658
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
659 In this XML-fragment it is also required to replace the placeholder NEWFISNAME
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
660 with the name which was used to configure the artifact-factory.
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
661
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
662 Now the 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
663
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
664 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
665 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
666
917
8c813d136298 Added Example for adding a Artifact for the FIS with no Products
Tim Englich <tim.englich@intevation.de>
parents: 916
diff changeset
667
8c813d136298 Added Example for adding a Artifact for the FIS with no Products
Tim Englich <tim.englich@intevation.de>
parents: 916
diff changeset
668 \paragraph{Example}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
669 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
670
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
671 For this we have to add the following XML-fragment to the file conf/conf.xml
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
672 in section /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
673
8c813d136298 Added Example for adding a Artifact for the FIS with no Products
Tim Englich <tim.englich@intevation.de>
parents: 916
diff changeset
674 \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
675 <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
676 <products>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products
Tim Englich <tim.englich@intevation.de>
parents: 916
diff changeset
677 </products>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products
Tim Englich <tim.englich@intevation.de>
parents: 916
diff changeset
678 </artifact>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products
Tim Englich <tim.englich@intevation.de>
parents: 916
diff changeset
679 \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
680
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
681 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
682
919
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
683 \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
684 /etc/init.d/artifactdb restart
919
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
685 \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
686
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
687 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
688
917
8c813d136298 Added Example for adding a Artifact for the FIS with no Products
Tim Englich <tim.englich@intevation.de>
parents: 916
diff changeset
689 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
690 \begin{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
691 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
692 \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
693
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
694 \subsubsection{Adding removing Products to the specific Artifact}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
695 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
696 to provide.
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
697 To do this it is necessary to copy the XML-fragments of the products into the
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
698 XML-element <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
699 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
700 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
701 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
702 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
703 <artifact-factory name="timeSeries"
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
704 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
705 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
706 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
707 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
708 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
709 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
710 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
711 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
712 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
713 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
714 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
715 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
716 <product name= "verticalProfile">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
717 <artifact-factory name="verticalProfile"
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
718 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
719 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
720 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
721 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
722 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
723 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
724 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
725 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
726 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
727 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
728 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
729 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
730 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
731 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
732 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
733
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
734 In this XML-fragment you have to replace the placeholders NEWFISNAME as before
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
735 and VALUEOFSOURCEID with the value for the new FIS as defined in the table
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
736 MEDIAN.SOURCEINFO.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
737
918
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
738 \paragraph{Example}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
739 Now we will add a product to the new FIS.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
740 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
741 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
742
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
743 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
744 \begin{lstlisting}
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
745 <product name= "timeSeries">
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
746 <artifact-factory name="timeSeries"
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
747 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
748 ttl="300000"
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
749 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
750 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
751 </artifact-factory>
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
752 <parameters>
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
753 <parameter name="sourceid"
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
754 value="4"/>
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
755 <parameter name="fisname"
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
756 value="fis\_justanewfis"/>
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
757 </parameters>
919
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
758 </product>
918
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
759 \end{lstlisting}
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
760
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
761 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
762
919
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
763 \begin{lstlisting}
918
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
764 /etc/init.d/artifactdb restart
919
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
765 \end{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
766
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
767 If we call
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
768 \begin{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
769 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
770 \end{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS
Tim Englich <tim.englich@intevation.de>
parents: 918
diff changeset
771
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
772 the product timeSeries should be available for the FIS justanewfis.
918
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
773
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
774 Now we should be able to choose the product.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
775 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
776 outputformats.
918
8a63b0d53003 Added Example for adding a new Product to a FIS
Tim Englich <tim.englich@intevation.de>
parents: 917
diff changeset
777
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
778 \subsection{Adding a new Product}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
779 To add a new product to the system it is necessary that the required
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
780 artifact representation is implemented in the sourcecode.
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
781 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
782
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
783 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
784 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
785
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
786 First step is to create a new file in the folder products and there in the
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
787 sub-folder where the product belongs to (timeseries,verticalprofile,
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
788 horizontalprofile,horizontalcrosssection,layer,...)
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
789
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
790 Then you have tor reference this file in the file /conf/conf.xml in the section
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
791 /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
792
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
793 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
794 <artifact name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
795 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
796 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
797 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
798
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
799 The placeholder PATHTOFILE has to be replaced with the relative path and the
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
800 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
801
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
802 Then it is possible to add the product to a FIS as explained in the next section.
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
803 Please note that the defined name of the artifact-factory has to match to the
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
804 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
805
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
806 \subsection{Adding a additional Product to a FIS}
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
807 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
808 represents the product to the artifact-configuration of the FIS in section
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
809 /artifacts/artifact/products.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
810
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
811 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
812 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
813 <artifact-factory name="timeSeries"
940
14df4bcabc3c Fixed some Mistakes
Tim Englich <tim.englich@intevation.de>
parents: 934
diff changeset
814 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
815 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
816 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
817 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
818 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
819 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
820 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
821 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
822 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
823 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
824 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
825 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
826 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
827
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
828 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
829
http://dive4elements.wald.intevation.org