Mercurial > dive4elements > gnv-client

comparison doc/config-manual/model_of_transitions.tex @ 906:03d58951889e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added first Part of Documentation for Section Model of Transitions doc/trunk@1040 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Fri, 30 Apr 2010 11:12:46 +0000
parents
children 29a675796e76
comparison
equal deleted inserted replaced
905:0a86b992ab1f 906:03d58951889e
1 \section{Model of transitions}
2 \subsection{General principle of model of transitions}
3 - FIS -> product -> transitions in data model
4
5 \subsection{Adding a new FIS}
6 In this Section it will explained which steps has to be done to integrate a new
7 FIS into the Artifact-Server.
8 This will be done using the Configuration for an FIS which use data from
9 MEDIAN.TIMESERIES Section of the DataWareHouse e.g. MARNET or STAUN
10
11 Pay attention that for publishing the Changes to the Artifact-Server you will
12 have to restart it.
13
14 \subsubsection{Adding a new Artifactfactory}
15 First step is to add a new Artifactfactory to the Configuration conf/conf.xml
16 To do this you have to add a new XML-Fragment into the Section
17 /factories/artifact-factories which look like that:
18
19 \begin{lstlisting}
20 <artifact-factory name='fis\_NEWFISNAME'
21 description='Factory to create an artifact to be used with the FIS NEWFISNAME'
22 ttl='3600000'
23 artifact='de.intevation.artifactdatabase.ProxyArtifact'>
24 de.intevation.gnv.artifacts.GNVProductArtifactFactory
25 </artifact-factory>
26 \end{lstlisting}
27
28 In this XML-Fragment you only have to replace the placeholder NEWFISNAME with a
29 unique short Name for the new FIS.
30
31 \subsubsection{Adding a new Artifact for Artifactfactory}
32 The next Step is to define the Artifact itself.
33 For this it is necessary to add an XML-Fragment into the Section /artifacts of
34 the main Configuration-File /conf/conf.xml
35 \begin{lstlisting}
36 <artifact name='fis\_NEWFISNAME'>
37 <products>
38 ...
39 </products>
40 </artifact>
41 \end{lstlisting}
42
43 In this XML- Fragment it is also required to replave the placeholder NEWFISNAME
44 with the name which was used to configure the Artifact-Factory.
45
46 Now the ArtifactServer can serv an additional FIS without any Products yet.
47
48 To prevent needless Configuration-Work it is useful way to clone an Artifact
49 which handle the same Kind of work as the new FIS.
50
51 \subsubsection{Adding removing Products to the specific Artifact}
52 Now it is Time to configure the different Products which the FIS should be able
53 to provide.
54 To do this it is necessary to Copy the XML-Fragments of the products into the
55 XML-Element <products> of the previously integrated Artifact.
56 \begin{lstlisting}
57 <artifact name='fis\_NEWFISNAME'>
58 <products>
59 <product name= "timeSeries">
60 <artifact-factory name="timeSeries"
61 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
62 ttl="300000"
63 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
64 de.intevation.gnv.artifacts.GNVArtifactFactory
65 </artifact-factory>
66 <parameters>
67 <parameter name="sourceid"
68 value="VALUEOFSOURCEID"/>
69 <parameter name="fisname"
70 value="fis\_NEWFISNAME"/>
71 </parameters>
72 </product>
73 <product name= "verticalProfile">
74 <artifact-factory name="verticalProfile"
75 description="Artiefactfactory for Instantiating the Artifact for Verticalprofiles on TimeSeriesPoints"
76 ttl="300000"
77 artifact="de.intevation.gnv.profile.vertical.VerticalProfileArtifact">
78 de.intevation.gnv.artifacts.GNVArtifactFactory
79 </artifact-factory>
80 <parameters>
81 <parameter name="sourceid"
82 value="VALUEOFSOURCEID"/>
83 <parameter name="fisname"
84 value="fis\_NEWFISNAME"/>
85 </parameters>
86 </product>
87 </products>
88 </artifact>
89 \end{lstlisting}
90
91 In this XML Fragment you have to replace the placeholders NEWFISNAME as before
92 and VALUEOFSOURCEID with the value for the new FIS as defined in the Table
93 MEDIAN.SOURCEINFO.
94
95 \subsubsection{Putting SourceID to specific Artifact}
96 \subsection{Adding a new Product}
97 To add a new Product to the System it is necessary that the required
98 Artifactrepresentation is Implemented in the SourceCode.
99 Without doing that step it is not possible to create a new Product.
100
101 All Products are configured in separate Files that will be included into the
102 Mainconfiguration using Xlink-references.
103
104 First Step is to create a new File in the Folder products and there in the
105 subfolder where the Product belongs to (timeseries,verticalprofile,
106 horizontalprofile,horizontalcrosssection,layer,...)
107
108 Then you have tor reference this File in the File /conf/conf.xml in the Section
109 /artifacts using the following XML-Fragment.
110
111 \begin{lstlisting}
112 <artifact name="timeSeries"
113 xmlns:xlink="http://www.w3.org/1999/xlink"
114 xlink:href="${artifacts.config.dir}/products/PATHTOFILE" />
115 \end{lstlisting}
116
117 The placeholder PATHTOFILE has to be replaced with the relative Path and the
118 Name of the File starting in the Folder products.
119
120 Then it is possible to add the product to a FIS as explained in the next section.
121 Please note that the defined Name of the ArtifactFactory has to match to the
122 Name of the added Products which is also designed as an Artifact.
123
124 \subsection{Adding a additional Product to a FIS}
125 To add a additional Product to a FIS you only have to add the XML-Fragment which
126 represents the product to the Artifact-configuration of the FIS in Section
127 /artifacts/artifact/products.
128
129 \begin{lstlisting}
130 <product name= "timeSeries">
131 <artifact-factory name="timeSeries"
132 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
133 ttl="300000"
134 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
135 de.intevation.gnv.artifacts.GNVArtifactFactory
136 </artifact-factory>
137 <parameters>
138 <parameter name="sourceid"
139 value="VALUEOFSOURCEID"/>
140 <parameter name="fisname"
141 value="fis\_NEWFISNAME"/>
142 </parameters>
143 </product>
144 \end{lstlisting}
145
146 Please note that you have to replace the Placeholders as explained above.
147
http://dive4elements.wald.intevation.org