Mercurial > dive4elements > gnv-client

annotate doc/config-manual/model_of_transitions.tex @ 908:babeef4f8480

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added description fpr Configuration of Products, States and Transitions doc/trunk@1042 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Mon, 03 May 2010 12:35:48 +0000
parents 29a675796e76
children fcde68463722
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}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
2 \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
3 - 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
4
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
5 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
6 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
7 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
8 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
9
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
10 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
11
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
12 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
13 \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
14 \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
15 Artifactfactory was called.
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
16 \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
17 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
18 \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
19
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
20 \subsubsection{Configuration of ArtifactFactories}
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
21 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
22 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
23 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
24 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
25 /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
26
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
27 \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
28 <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
29 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
30 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
31 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
32 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
33 </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
34 \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
35
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
36 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
37 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
38 \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
39 \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
40 \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
41 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
42 \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
43 \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
44
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
45 // 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
46
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
47 \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
48 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
49 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
50 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
51 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
52
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
53 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
54 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
55
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
56 \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
57 <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
58 <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
59 ...
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
60 </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
61 </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
62 \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
63
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
64 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
65 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
66 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
67 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
68
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
69 \paragraph{Products to an 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
70 One Artifact can provide several 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
71 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
72 /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
73
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
74 \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
75 <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
76 <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
77 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
78 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
79 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
80 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
81 </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
82 <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
83 <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
84 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
85 <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
86 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
87 </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
88 </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
89 \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
90
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
91 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
92 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
93 (/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
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 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
96 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
97
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts 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 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
99 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
100 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
101 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
102
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts 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 \subsubsection{Configuration of the Product-Artifacts}
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
105 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
106 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
107 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
108
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
109 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
110 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
111 Configuration-File.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
112
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
113 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
114 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
115 fulfilled.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
116
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
117 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
118 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
119 CSV, ODV, WMS,...).
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
120
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
121 \paragraph{States}
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
122 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
123 Diagramm.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
124
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
125 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
126
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
127 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
128
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
129 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
130 <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
131 <queryID>timeseries_parameter</queryID>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
132 <dataname>parameterid</dataname>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
133 <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
134 <inputvalues>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
135 <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
136 <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
137 <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
138 </inputvalues>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
139 </state>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
140 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
141
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
142 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
143 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
144 \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
145 \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
146 \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
147 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
148 \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
149 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
150 \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
151 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
152 \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
153 to this State.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
154 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
155
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
156
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
157 \paragraph{Transitions}
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
158
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
159 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
160 the different States.
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
161 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
162
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
163 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
164 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
165 \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
166 \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
167 (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
168 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
169
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
170 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
171 \begin{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
172 <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
173 <from state="timeseries_area"/>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
174 <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
175 <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
176 </transition>
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
177 \end{lstlisting}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
178
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
179 \begin{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
180 \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
181 \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
182 \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
183 \end{itemize}
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
184
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
185 \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
186
29a675796e76 Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.
Tim Englich <tim.englich@intevation.de>
parents: 906
diff changeset
187
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
188 \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
189 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
190 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
191 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
192 MARNET or STAUN
906
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
193
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
194 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
195 have to restart it.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
196
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
197 \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
198 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
199 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
200 /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
201
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
202 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
203 <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
204 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
205 ttl='3600000'
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
206 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
207 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
208 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
209 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
210
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
211 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
212 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
213
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
214 \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
215 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
216 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
217 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
218 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
219 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
220 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
221 ...
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
222 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
223 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
224 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
225
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
226 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
227 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
228
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
229 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
230
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
231 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
232 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
233
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
234 \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
235 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
236 to provide.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
237 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
238 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
239 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
240 <artifact name='fis\_NEWFISNAME'>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
241 <products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
242 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
243 <artifact-factory name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
244 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
245 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
246 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
247 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
248 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
249 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
250 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
251 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
252 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
253 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
254 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
255 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
256 <product name= "verticalProfile">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
257 <artifact-factory name="verticalProfile"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
258 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
259 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
260 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
261 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
262 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
263 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
264 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
265 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
266 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
267 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
268 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
269 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
270 </products>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
271 </artifact>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
272 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
273
908
babeef4f8480 Added description fpr Configuration of Products, States and Transitions
Tim Englich <tim.englich@intevation.de>
parents: 907
diff changeset
274 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
275 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
276 MEDIAN.SOURCEINFO.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
277
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
278 \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
279 \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
280 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
281 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
282 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
283
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
284 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
285 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
286
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
287 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
288 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
289 horizontalprofile,horizontalcrosssection,layer,...)
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
290
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
291 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
292 /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
293
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
294 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
295 <artifact name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
296 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
297 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
298 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
299
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
300 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
301 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
302
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
303 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
304 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
305 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
306
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
307 \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
308 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
309 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
310 /artifacts/artifact/products.
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
311
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
312 \begin{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
313 <product name= "timeSeries">
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
314 <artifact-factory name="timeSeries"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
315 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
316 ttl="300000"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
317 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
318 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
319 </artifact-factory>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
320 <parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
321 <parameter name="sourceid"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
322 value="VALUEOFSOURCEID"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
323 <parameter name="fisname"
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
324 value="fis\_NEWFISNAME"/>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
325 </parameters>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
326 </product>
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
327 \end{lstlisting}
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
328
03d58951889e Added first Part of Documentation for Section Model of Transitions
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
329 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
330
http://dive4elements.wald.intevation.org