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

annotate doc/config-manual/model_of_transitions.tex @ 919:29a4a1a99a22

Added Sample calls for creating an FIS doc/trunk@1054 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Tim Englich <tim.englich@intevation.de>
date	Tue, 04 May 2010 13:36:36 +0000
parents	8a63b0d53003
children	63bc0044ff72

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
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	20 %% TODO: Add a screenshoot of the GNV WebClient marking GUI elements for FIS,
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
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	76 (c.f. \ref{ref:config-a-product}). The defintion of states, transitions and
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	77 outputs reference the actual SQL-statements via identifier. The SQL-statements
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	78 are gathered in the file \verb+conf/queries.txt+.
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
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	81 \subsection{General principle of model of transitions}
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.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	84 It is possible to add or remove FIS, add or remove Products from a FIS or
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
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	86 a diagramm or generate an CSV-Export.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	87
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	88 The configuration of the provided FIS are devided in three main parts.
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}
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	91 \item Configuration of the list of FIS via Artifactfactories
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	92 \item Configuration of main Artifacts which will be instantiated if an
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	93 Artifactfactory was called.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 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}
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	99 The Point of Enty into the system is to configure an Artifactfactory.
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	100 Each Artifactfactory represents one FIS.
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	101 It is possible to configure several Artifactfactories.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	102 The Artifactfactories will be configured 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	103 /artifact-database/artifact-factories of the Configurationfile.
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}
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	106 <artifact-factory name='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	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
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	114 At this moment the following Attributes of an Artifact-Factory are configurabel.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	115 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	116 \item name: The Name of the Artifact. Must be unique in one Artifact-Server
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	117 \item description: Short description which Job the Artifactfactory has to do.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	118 \item ttl: The Time to Live: The Time using Milliseconds an Artifact, created using this
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	119 factory, can live without any Userinteraction.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	120 \item artifact: The Name of the Class of the Artifact which should be created.
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
911 11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	123 The next listing shows the dependencies between the FIS and the Name
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	124 of the Artifactfactory which belongs to it.
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
11ebb00c8bf4 Added overview of the subject-sepcific configuration and its file structure Hans Plum <hans.plum@intevation.de> parents: 910 diff changeset	140 \item SeaCat: is\_seacat
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}
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	149 For each Artifact-Factory it is necessary to configure one Artifact which will be
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	150 created using the Factory.
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	151 This Artifact is the representation of the specific FIS.
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	152 It contains the Configuration which products will be serverd for ths 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
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	154 The Artifacts are configured in the Section /artifact-database/artifacts of
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	155 the Configurationfile.
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}
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	158 <artifact name='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	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
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	165 The Key is to use the same Name for the Artifact as used for the Artifactfactory.
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	166 The Name has to be unique.
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	167 In the Section /artifact/products it is possible to define several Products as
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	168 explained in the next Section.
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}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the Tim Englich <tim.englich@intevation.de> parents: 909 diff changeset	171 One FIS can provide several Products.
907 29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	172 To do this it is required to configure them as shown below in the Section
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
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	192 Each Product is also represented by an Artifact. To create this Artifact we have to
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	193 use an Artifact-Factory which is configured in each 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	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
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	196 Each Product can have several parameters /product/parameters/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	197 The Parameter named sourceid and fisname are required 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	198
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	199 The Parameter fisname contains the key to the Name of the FIS. The Key must be
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.
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	201 The Parameter sourceid contains the key to identify the FIS in the
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS. Tim Englich <tim.englich@intevation.de> parents: 906 diff changeset	202 DataWareHouse. (MEDIAN.SOURCEINFO)
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}
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	207 The Products of the different FIS are also modeled as Artifact-Objects.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	208 The different Products which are currently avaliable are stored in separate
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	209 Files in the Folder project.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	210
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	211 In those Files the Workflow of each product is configured. Each step which is
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	212 required to model a new Diagramm is represented using a state in the
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	213 Configuration-File.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	214
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	215 To move between those States it is required to model Transitions which define
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	216 between which States it is possible to move and which conditions must be
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
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	219 The Last step is called OutputState. This State is responsible to generate the
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	220 output for the different Formats which can be served from the Product (Diagramm,
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}
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	224 A state is one Step which is required to fetch the Data for generating e.g. an
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	225 Diagramm.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	226
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	227 For example in each Product it is Possible to choose one or more Parameters.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	228
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	229 To configure a State you have to use a XML-Fragment as shown below:
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
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	242 At this moment the following Attributes of an Artifact-Factory are configurabel.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	243 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	244 \item id: The Name of the Artifact. Must be unique in one Artifact-Server
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	245 \item description: Short description which Job the Artifactfactory has to do.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	246 \item queryID: The ID of the Query which should be used to fetch the Data
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	247 displayed in this state. //TODO: Reference to queries.properties
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	248 \item dataname: The ID of the Data which will be displaied in this State.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	249 The ID will be use to localize the description of the Data.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	250 \item data-multiselect: true it is possible to select 1 or more Items.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	251 false ist is possible to select only one Item.
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	252 \item inputvalues: The Values which can be "feed" to this State and which
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	253 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	254 \end{itemize}
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	255
913 2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	256 \paragraph{Input Values of a State}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	257 At Section /state/inputvalues it is possible to add Definitions for InputValues.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	258 Those values have two meanings for the State.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	259
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	260 \begin{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	261 \item They were used to fill the SQL-Statements to fetch the Data
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	262 (Each entry replace one ore more "?" )
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	263 \item They were used to validate the Inputdata which is "feed" to
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	264 the FIS in the current State
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	265 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	266
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	267 WARNING: The Order of the InputValues is significant at which position the Value will
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	268 be put into the SQL-Statement.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	269
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	270 It is possible to add one InputValue twice or more often to put its value at
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	271 different positions of the SQl-Statement.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	272
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	273 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	274 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	275 <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	276 <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	277 <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	278 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	279 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	280
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	281 \begin{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	282 \item name: Name of the Value that could be feed or should be used in SQl-statment.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	283 The name must fit to one dataname configured in this State or one other
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	284 State which was visited before.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	285 \item type: The type of the Value. This is required for the Validation
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	286 of the Value.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	287 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	288 Polygon, Coordinate, Geometry and AttributeName.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	289 \item multiselect: true if more than on Value can be feed or put into the SQl-statement.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	290 false if one on Value will be accepted.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	291 \item usedinquery: Number how often the value should be put into the SQL-Statement:
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	292 0: Value will not out into the Statement.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	293 1: Value will put once into the Staement,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	294 2 or more: Value will be put as often as configured
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	295 into the SQL-Statement (this is useful if
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	296 Inner-Selects are used)
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	297 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	298
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	299 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	300
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	301 This SQL-statment is configured to use in the State above.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	302
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	303 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	304 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	305 p.PARAMETERID KEY,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	306 p.GERMANNAME \|\| ' ['\|\| p.UNIT \|\|']' VALUE,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	307 p.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	308 FROM MEDIAN.PARAMETER P,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	309 MEDIAN.TIMESERIES TS,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	310 MEDIAN.TIMESERIESVALUE TSV,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	311 MEDIAN.MEASUREMENT M,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	312 MEDIAN.TIMESERIESPOINT TSP
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	313 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	314 M.MEASUREMENTID = TSV.MEASUREMENTID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	315 TS.TIMESERIESID = TSV.TIMESERIESID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	316 P.PARAMETERID = TS.PARAMETERID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	317 TSP.FEATUREID = ?
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	318 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	319 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	320
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	321 If there are put the Inputvalues in it it will look like this
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	322 if we assume that the inputvalues has got the following values:
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	323 \begin{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	324 \item featureid: 4 (Marnet)
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	325 \item fisname: fis\_marnet
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	326 \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	327 chosen in this state.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	328 \end{itemize}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	329
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	330 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	331 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	332 p.PARAMETERID KEY,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	333 p.GERMANNAME \|\| ' ['\|\| p.UNIT \|\|']' VALUE,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	334 p.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	335 FROM MEDIAN.PARAMETER P,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	336 MEDIAN.TIMESERIES TS,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	337 MEDIAN.TIMESERIESVALUE TSV,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	338 MEDIAN.MEASUREMENT M,
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	339 MEDIAN.TIMESERIESPOINT TSP
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	340 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	341 M.MEASUREMENTID = TSV.MEASUREMENTID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	342 TS.TIMESERIESID = TSV.TIMESERIESID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	343 P.PARAMETERID = TS.PARAMETERID AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	344 TSP.FEATUREID = 4
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	345 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	346 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	347
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	348 The value of featureid will be inserted into the Query because
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	349 the Attribute usedinquery is set to "1".
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	350
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	351 The values of the inputvalues fisname and parameterid will be
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	352 excluded because the Attribute usedinquery is set to "0"
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	353
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	354
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	355 If the Attribute usedinquery of the inputvalue featureid is set to "2"
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	356 this might happen.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	357
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	358 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	359 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	360 <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	361 <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	362 <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	363 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	364 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	365
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	366
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	367 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	368 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	369 ...
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	370 TSP.FEATUREID = ? AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	371 TSP.FEATUREID = ?
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	372 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	373 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	374
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	375 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	376
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	377 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	378 SELECT DISTINCT
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 TSP.FEATUREID = 4 AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	381 TSP.FEATUREID = 4
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	382 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	383 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	384
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	385
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	386 If the Attribute usedinquery of the inputvalue fisname additionally is set to "1"
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	387 this might happen.
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	388
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	389 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	390 <inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	391 <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	392 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="1"/>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	393 <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	394 </inputvalues>
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	395 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	396
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 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	399 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	400 ...
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	401 TSP.FEATUREID = ? AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	402 TSP.FEATUREID = ? AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	403 NOCOLUMNINDB = ?
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	404 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	405 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	406
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	407 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	408
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	409 \begin{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	410 SELECT DISTINCT
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	411 ...
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	412 TSP.FEATUREID = 4 AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	413 TSP.FEATUREID = 4 AND
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	414 NOCOLUMNINDB = 'fis\_marnet'
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	415 ORDER BY P.GERMANNAME
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	416 \end{lstlisting}
2d3c95787578 Added description for Configuration of InputValue of States Tim Englich <tim.englich@intevation.de> parents: 912 diff changeset	417
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	418
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	419 \paragraph{Transitions}
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	420
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	421 To move between two States it is necessary to configure dependencies between
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	422 the different States.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	423 This dependencies are called. Transitions.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	424
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	425 There are different Kind of Transitions which can be used.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	426 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	427 \item Transitions which only link two States
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	428 \item Transition which link two States with a aditional Condition.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	429 (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	430 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	431
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	432 The listing below shows a Transition with an additional Condition.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	433 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	434 <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	435 <from state="timeseries_area"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	436 <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	437 <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	438 </transition>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	439 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	440
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	441 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	442 \item from: The ID of the State which you have to come from
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	443 \item to: The ID of the State which can be reached.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	444 \item condition: The Condition which have to be fulfilled.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	445 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	446
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	447 \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	448
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	449 The OutputState is an special State which was created to define
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	450 the different possibilities of Outputs for each Product.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	451 An OutputState is handled as an State which is described above.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	452 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	453 be provided.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	454
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	455 There are several OutputStates. Each one is designed to create
915 a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	456 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	457
915 a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	458 \begin{itemize}
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	459 \item TimeSeries: TimeSeriesOutputState
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	460 \item Horizontalprofile: HorizontalProfileOutputState
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	461 \item Horizontalprofile on Meshes: HorizontalProfileMeshOutputState
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	462 \item Verticalcrosssection:VerticalCrossSectionOutputState
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	463 \item Verticalprofiles: VerticalProfileOutputState
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	464 \item Horizontalcrosssections: HorizontalCrossSectionMeshOutputState
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	465 \item Layer: LayerOutputState
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	466 \end{itemize}
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	467
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	468 All these Outputstates are Implemented in package de.intevation.gnv.state
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	469 and its subpackages.
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	470
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	471 You have to put the fullqulified name of the Outputstate to the Attribute State
a6f86fa053a1 Added listing of all supported OutputStates Tim Englich <tim.englich@intevation.de> parents: 914 diff changeset	472 as shown below.
909 fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	473
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	474 You can configure an OutputState as shown below:
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	475
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	476 \begin{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	477 <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	478 <queryID>timeseries_chart_data</queryID>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	479 ...
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	480 <outputsModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	481 <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	482 ...
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	483 </outputsMode>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	484 </outputsModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	485 </state>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	486 \end{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	487
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	488 At Section /state/outputsModes it is possible to add one ore more OutputModes
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	489 to one State as shown in the next Paragraph.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	490
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	491 \paragraph{OutputModes}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	492
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	493 It is possible to configure several OutputModes in one OutputState.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	494 Inserting or deleting the Configuration of an special
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	495 OutputMode will cause that the pending Item will be shown or hidden
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	496 in the GUI.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	497
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	498 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	499 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	500 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	501 TO OFFER THIS OUTPUTMODE.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	502
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	503 Currently the following outputmodes are supported:
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	504
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	505 \begin{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	506 \item chart
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	507 \item histogram
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	508 \item csv
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	509 \item odv
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	510 \item statistics
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	511 \item wms
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	512 \item shapefile
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	513 \end{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	514
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	515 The following Example shows the Configuration for the OutputMode Chart.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	516
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	517 \begin{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	518 <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	519 <parameters>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	520 <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	521 <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	522 <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	523 </parameters>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	524 <exportModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	525 <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	526 <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	527 <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	528 </exportModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	529 </outputsMode>
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	530 \end{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	531
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	532 // 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	533
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	534 \begin{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	535 \item name: The name of the Mode. This must not be changed because it is used
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	536 by the Programm.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	537 \item description: a short description of this OutputMode.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	538 \item parameters: one ore more parameters which will be shown in the GUI e.g.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	539 for changing the Size of an Chart.
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	540 \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	541 \end{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes Tim Englich <tim.englich@intevation.de> parents: 908 diff changeset	542
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	543
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	544 \subsection{Adding a new FIS}
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	545 In this Section it will be explained which steps has to be done to integrate a
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	546 new FIS into the Artifact-Server. This will be done using the Configuration for
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	547 an FIS which use data from MEDIAN.TIMESERIES Section of the DataWareHouse e.g.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	548 MARNET or STAUN
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	549
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	550 Pay attention that for publishing the Changes to the Artifact-Server you will
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	551 have to restart it.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	552
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	553 \subsubsection{Adding a new Artifactfactory}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	554 First step is to add a new Artifactfactory to the Configuration conf/conf.xml
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	555 To do this you have to add a new XML-Fragment into the Section
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	556 /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	557
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	558 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	559 <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	560 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	561 ttl='3600000'
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	562 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	563 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	564 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	565 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	566
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	567 In this XML-Fragment you only have to replace the placeholder NEWFISNAME with a
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	568 unique short Name for the new FIS.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	569
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	570 \paragraph{Example}
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	571 This Example shows how to add an FIS and which effects it took to the
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	572 REST-Server.
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	573
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	574 At first we add the follwing Artifactfactory into the file conf/conf.xml
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	575 in Section /artifact-database/artifact-factories which add a new
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	576 FIS called justanewfis to the Server:
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	577
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	578 \begin{lstlisting}
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	579 <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	580 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	581 ttl='3600000'
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	582 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	583 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	584 </artifact-factory>
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	585 \end{lstlisting}
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	586
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	587 Then we restart the Artifact-database executing the followinig command:
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	588
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	589 /etc/init.d/artifactdb restart
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	590
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	591 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	592 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	593
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	594 curl http://localhost:8181/factories \| xmllint --format - \| grep fis\_justanewfis
916 a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	595
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	596 If the FIS was added the new Artifactfactory will be found in the generated
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	597 XML-Output and it will be shown.
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	598 Otherwise no XML-Output will be shown.
a03d2006d7c6 Added Example for adding a new FIS to the REST-Server Tim Englich <tim.englich@intevation.de> parents: 915 diff changeset	599
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	600 \subsubsection{Adding a new Artifact for Artifactfactory}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	601 The next Step is to define the Artifact itself.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	602 For this it is necessary to add an XML-Fragment into the Section /artifacts of
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	603 the main Configuration-File /conf/conf.xml
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	604 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	605 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	606 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	607 ...
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	608 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	609 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	610 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	611
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	612 In this XML- Fragment it is also required to replave the placeholder NEWFISNAME
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	613 with the name which was used to configure the Artifact-Factory.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	614
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	615 Now the ArtifactServer can serv an additional FIS without any Products yet.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	616
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	617 To prevent needless Configuration-Work it is useful way to clone an Artifact
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	618 which handle the same Kind of work as the new FIS.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	619
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	620
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	621 \paragraph{Example}
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	622 Now we will configure an Artifact to the 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	623
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	624 For this we have to add the following XML-Fragment to the File conf/conf.xml
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	625 in Section /artifact-database/artifacts:
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	626
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	627 \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	628 <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	629 <products>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	630 </products>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	631 </artifact>
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	632 \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	633
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	634 Restart the Artifact-Database:
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	635
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	636 \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	637 /etc/init.d/artifactdb restart
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	638 \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	639
8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	640 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	641
917 8c813d136298 Added Example for adding a Artifact for the FIS with no Products Tim Englich <tim.englich@intevation.de> parents: 916 diff changeset	642 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	643 \begin{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	644 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	645 \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	646
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	647 \subsubsection{Adding removing Products to the specific Artifact}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	648 Now it is Time to configure the different Products which the FIS should be able
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	649 to provide.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	650 To do this it is necessary to Copy the XML-Fragments of the products into the
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	651 XML-Element <products> of the previously integrated Artifact.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	652 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	653 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	654 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	655 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	656 <artifact-factory name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	657 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	658 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	659 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	660 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	661 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	662 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	663 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	664 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	665 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	666 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	667 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	668 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	669 <product name= "verticalProfile">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	670 <artifact-factory name="verticalProfile"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	671 description="Artiefactfactory for Instantiating the Artifact for Verticalprofiles on TimeSeriesPoints"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	672 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	673 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	674 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	675 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	676 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	677 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	678 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	679 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	680 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	681 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	682 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	683 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	684 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	685 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	686
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	687 In this XML-Fragment you have to replace the placeholders NEWFISNAME as before
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	688 and VALUEOFSOURCEID with the value for the new FIS as defined in the Table
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	689 MEDIAN.SOURCEINFO.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	690
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	691 \paragraph{Example}
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	692 Now we will add a Product to the new FIS.
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	693 To let the Products work we will choose a Product which
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	694 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	695
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	696 At first add the following XMl-Fragment to the new Artifact.
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	697 \begin{lstlisting}
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	698 <product name= "timeSeries">
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	699 <artifact-factory name="timeSeries"
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	700 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	701 ttl="300000"
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	702 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	703 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	704 </artifact-factory>
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	705 <parameters>
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	706 <parameter name="sourceid"
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	707 value="4"/>
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	708 <parameter name="fisname"
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	709 value="fis\_justanewfis"/>
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	710 </parameters>
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	711 </product>
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	712 \end{lstlisting}
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	713
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	714 Restart the Artifact-Database:
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	715
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	716 \begin{lstlisting}
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	717 /etc/init.d/artifactdb restart
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	718 \end{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	719
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	720 If we call
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	721 \begin{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	722 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	723 \end{lstlisting}
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	724
29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	725 The Product timeSeries should be available for ths FIS justanewfis.
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	726
919 29a4a1a99a22 Added Sample calls for creating an FIS Tim Englich <tim.englich@intevation.de> parents: 918 diff changeset	727 Now we should be able to choose the Product.
918 8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	728 This Product should work and you should be able to generate even the defined
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	729 Outputformats.
8a63b0d53003 Added Example for adding a new Product to a FIS Tim Englich <tim.englich@intevation.de> parents: 917 diff changeset	730
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	731 \subsubsection{Putting SourceID to specific Artifact}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	732 \subsection{Adding a new Product}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	733 To add a new Product to the System it is necessary that the required
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	734 Artifactrepresentation is Implemented in the SourceCode.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	735 Without doing that step it is not possible to create a new Product.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	736
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	737 All Products are configured in separate Files that will be included into the
908 babeef4f8480 Added description fpr Configuration of Products, States and Transitions Tim Englich <tim.englich@intevation.de> parents: 907 diff changeset	738 Mainconfiguration using Xlink-References.
906 03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	739
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	740 First Step is to create a new File in the Folder products and there in the
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	741 subfolder where the Product belongs to (timeseries,verticalprofile,
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	742 horizontalprofile,horizontalcrosssection,layer,...)
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	743
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	744 Then you have tor reference this File in the File /conf/conf.xml in the Section
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	745 /artifacts using the following XML-Fragment.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	746
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	747 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	748 <artifact name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	749 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	750 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	751 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	752
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	753 The placeholder PATHTOFILE has to be replaced with the relative Path and the
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	754 Name of the File starting in the Folder products.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	755
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	756 Then it is possible to add the product to a FIS as explained in the next section.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	757 Please note that the defined Name of the ArtifactFactory has to match to the
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	758 Name of the added Products which is also designed as an Artifact.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	759
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	760 \subsection{Adding a additional Product to a FIS}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	761 To add a additional Product to a FIS you only have to add the XML-Fragment which
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	762 represents the product to the Artifact-configuration of the FIS in Section
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	763 /artifacts/artifact/products.
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	764
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	765 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	766 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	767 <artifact-factory name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	768 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	769 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	770 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	771 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	772 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	773 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	774 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	775 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	776 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	777 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	778 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	779 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	780 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	781
03d58951889e Added first Part of Documentation for Section Model of Transitions Tim Englich <tim.englich@intevation.de> parents: diff changeset	782 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	783

Mercurial > dive4elements > gnv-client

annotate doc/config-manual/model_of_transitions.tex @ 919:29a4a1a99a22