Mercurial > dive4elements > gnv-client

annotate doc/config-manual/model_of_transitions.tex @ 910:329a510ba5a2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added Mapping between the Configuration an the shown Objects in the 5 System into the Documentation. doc/trunk@1044 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Mon, 03 May 2010 14:54:38 +0000
parents fcde68463722
children 11ebb00c8bf4
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}
910
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
2 \subsection{Relation between System and Configuration}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
3
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
4 The Generic Viewer provides several FIS.
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
5
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
6 In the Configurationdocument each FIS is provided by an ArtifactFactory.
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
7
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
8 The next listing shows the dependencies between the FIS and the Name
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
9 of the Artifactfactory which belongs to it.
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
10
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
11 \begin{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
12 \item Marnet: fis\_marnet
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
13 \item IMIS: fis\_imis
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
14 \item STAUN: fis\_staun
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
15 \item Modeldata fis\_modeldata
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
16 \item Iceclimatology: fis\_eisklimatologie
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
17 \item Ice Station Report: fis\_icestations
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
18 \item SST: fis\_sst
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
19 \item Delphin: fis\_delphin
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
20 \item Thermosalinograph: fis\_thermosalinograph
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
21 \item Chemusurvey: fis\_chemusurvey
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
22 \item GTS: fis\_gts
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
23 \item CTD: fis\_bsh\_ctd
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
24 \item XBT: fis\_bsh\_xbt
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
25 \item SeaCat: is\_seacat
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
26 \item Sea State: fis\_seastate
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
27 \item Current Meter: fis\_currentmeter
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
28 \item Nauthis: fis\_nauthis
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
29 \item Contis: fis\_contis
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
30 \item Marine Features: fis\_marinefeatures
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
31 \end{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
32
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
33 The Products of each FIS can be configured in the Artifact which belongs to
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
34 each Artifactfactory.
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
35
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
36 There are three main groups where the different FIS can be devided to:
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
37
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
38 \begin{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
39 \item TimeSeriesPoints
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
40 \item Mesh
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
41 \item InstantaneousPoints
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
42 \end{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
43
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
44 Each product is configured in separate Files stored in subfolders of the
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
45 Folder conf/products.
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
46
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
47 The Configurationfiles are put into separate foldes sorted by the kind of
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
48 Product they provide:
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
49
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
50 \begin{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
51 \item horizontalcrosssection
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
52 \item horizontalprofile
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
53 \item layer
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
54 \item timeseries
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
55 \item verticalcrosssection
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
56 \item verticalprofile
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
57 \end{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
58
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
59 The Name of the File links to the main group of an FIS it belongs to.
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
60
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
61 \begin{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
62 \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
63 \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
64 \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
65 \end{itemize}
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
66
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
67 The Configuration of each Product contains the different Steps which are
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
68 required to generate the output of an Product.
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
69
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
70 \subsection{General principle of model of transitions}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
71 - FIS -> product -> transitions in data model
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
72
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
73 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
74 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
75 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
76 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
77
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
78 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
79
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
80 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
81 \item Configuration of the Artifactfactories which represents the FIS.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
82 \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
83 Artifactfactory was called.
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
84 \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
85 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
86 \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
87
910
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
88 \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
89 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
90 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
91 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
92 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
93 /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
94
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 \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
96 <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
97 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
98 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
99 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
100 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
101 </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
102 \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
103
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 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
105 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
106 \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
107 \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
108 \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
109 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
110 \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
111 \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
112
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 // TODO: List of Artifacts which currently used in this Configuration?
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
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
115 \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
116 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
117 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
118 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
119 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
120
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
121 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
122 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
123
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
124 \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
125 <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
126 <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
127 ...
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
128 </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
129 </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
130 \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
131
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
132 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
133 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
134 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
135 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
136
910
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
137 \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
138 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
139 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
140 /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
141
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
142 \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
143 <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
144 <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
145 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
146 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
147 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
148 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
149 </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
150 <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
151 <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
152 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
153 <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
154 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
155 </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
156 </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
157 \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
158
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
159 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
160 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
161 (/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
162
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
163 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
164 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
165
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 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
167 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
168 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
169 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
170
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
171
910
329a510ba5a2 Added Mapping between the Configuration an the shown Objects in the
Tim Englich <tim.englich@intevation.de>
parents: 909
diff changeset
172 \subsubsection{Configuration of an Product}
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
173 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
174 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
175 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
176
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
177 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
178 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
179 Configuration-File.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
180
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
181 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
182 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
183 fulfilled.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
184
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
185 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
186 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
187 CSV, ODV, WMS,...).
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
188
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
189 \paragraph{States}
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
190 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
191 Diagramm.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
192
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
193 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
194
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
195 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
196
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
197 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
198 <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
199 <queryID>timeseries_parameter</queryID>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
200 <dataname>parameterid</dataname>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
201 <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
202 <inputvalues>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
203 <inputvalue name="featureid" type="Integer" multiselect="false"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
204 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
205 <inputvalue name="parameterid" type="Integer" multiselect="true" usedinquery="0"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
206 </inputvalues>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
207 </state>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
208 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
209
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
210 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
211 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
212 \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
213 \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
214 \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
215 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
216 \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
217 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
218 \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
219 false ist is possible to select only one Item.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
220 \item inputvalues: The Values which can be "feed" //TODO: How to explain this
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
221 to this State.
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
222 \end{itemize}
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
223
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
224
907
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
225 \paragraph{Transitions}
908
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 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
228 the different States.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
229 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
230
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
231 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
232 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
233 \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
234 \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
235 (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
236 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
237
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
238 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
239 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
240 <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
241 <from state="timeseries_area"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
242 <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
243 <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
244 </transition>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
245 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
246
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
247 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
248 \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
249 \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
250 \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
251 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
252
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
253 \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
254
909
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
255 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
256 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
257 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
258 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
259 be provided.
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
260
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
261 There are several OutputStates. Each one is designed to create
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
262 the output for one special Product (Verticalprofile, TimeSeries,...)
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
263
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
264 //TODO: Listing of each OutputStates?
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
265
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
266 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
267
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
268 \begin{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
269 <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
270 <queryID>timeseries_chart_data</queryID>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
271 ...
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
272 <outputsModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
273 <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
274 ...
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
275 </outputsMode>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
276 </outputsModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
277 </state>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
278 \end{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
279
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
280 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
281 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
282
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
283 \paragraph{OutputModes}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
284
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
285 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
286 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
287 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
288 in the GUI.
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
289
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
290 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
291 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
292 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
293 TO OFFER THIS OUTPUTMODE.
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
294
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
295 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
296
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
297 \begin{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
298 \item chart
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
299 \item histogram
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
300 \item csv
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
301 \item odv
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
302 \item statistics
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
303 \item wms
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
304 \item shapefile
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
305 \end{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
306
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
307 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
308
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
309 \begin{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
310 <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
311 <parameters>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
312 <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
313 <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
314 <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
315 </parameters>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
316 <exportModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
317 <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
318 <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
319 <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
320 </exportModes>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
321 </outputsMode>
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
322 \end{lstlisting}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
323
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
324 // 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
325
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
326 \begin{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
327 \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
328 by the Programm.
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
329 \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
330 \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
331 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
332 \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
333 \end{itemize}
fcde68463722 Added description for Configuration of OutputStates and OutputModes
Tim Englich <tim.englich@intevation.de>
parents: 908
diff changeset
334
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
335
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
336 \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
337 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
338 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
339 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
340 MARNET or STAUN
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
341
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
342 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
343 have to restart it.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
344
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
345 \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
346 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
347 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
348 /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
349
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
350 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
351 <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
352 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
353 ttl='3600000'
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
354 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
355 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
356 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
357 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
358
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
359 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
360 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
361
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
362 \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
363 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
364 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
365 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
366 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
367 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
368 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
369 ...
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
370 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
371 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
372 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
373
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
374 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
375 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
376
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
377 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
378
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
379 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
380 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
381
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
382 \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
383 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
384 to provide.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
385 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
386 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
387 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
388 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
389 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
390 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
391 <artifact-factory name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
392 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
393 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
394 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
395 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
396 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
397 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
398 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
399 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
400 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
401 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
402 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
403 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
404 <product name= "verticalProfile">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
405 <artifact-factory name="verticalProfile"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
406 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
407 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
408 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
409 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
410 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
411 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
412 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
413 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
414 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
415 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
416 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
417 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
418 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
419 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
420 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
421
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
422 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
423 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
424 MEDIAN.SOURCEINFO.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
425
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
426 \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
427 \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
428 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
429 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
430 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
431
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
432 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
433 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
434
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
435 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
436 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
437 horizontalprofile,horizontalcrosssection,layer,...)
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
438
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
439 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
440 /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
441
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
442 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
443 <artifact name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
444 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
445 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
446 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
447
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
448 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
449 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
450
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
451 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
452 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
453 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
454
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
455 \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
456 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
457 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
458 /artifacts/artifact/products.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
459
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
460 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
461 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
462 <artifact-factory name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
463 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
464 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
465 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
466 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
467 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
468 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
469 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
470 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
471 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
472 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
473 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
474 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
475 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
476
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
477 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
478
http://dive4elements.wald.intevation.org