Mercurial > dive4elements > gnv-client
comparison doc/config-manual/model_of_transitions.tex @ 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.
doc/trunk@1041 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Tim Englich <tim.englich@intevation.de> |
|---|---|
| date | Fri, 30 Apr 2010 12:18:47 +0000 |
| parents | 03d58951889e |
| children | babeef4f8480 |
comparison
equal
deleted
inserted
replaced
| 906:03d58951889e | 907:29a675796e76 |
|---|---|
| 1 \section{Model of transitions} | 1 \section{Model of transitions} |
| 2 \subsection{General principle of model of transitions} | 2 \subsection{General principle of model of transitions} |
| 3 - FIS -> product -> transitions in data model | 3 - FIS -> product -> transitions in data model |
| 4 | 4 The configuration of the provided FIS are devided in three parts. |
| 5 | |
| 6 * Configuration of the Artifactfactories which represents the FIS. | |
| 7 * Configuration of main Artifacts which will be instantiated if an | |
| 8 Artifactfactory was called. | |
| 9 * Configuration of the different Artifacts which provides Products which can be | |
| 10 served by the FIS. | |
| 11 | |
| 12 \subsubsection{Configuration of ArtifactFactories} | |
| 13 The Point of Enty into the system is to configure an Artifactfactory. | |
| 14 Each Artifactfactory represents one FIS. | |
| 15 It is possible to configure several Artifactfactories. | |
| 16 The Artifactfactories will be vonfigured in the Section | |
| 17 /artifact-database/artifact-factories of the Configurationfile. | |
| 18 | |
| 19 \begin{lstlisting} | |
| 20 <artifact-factory name='fis\_marnet' | |
| 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 At this moment the following Attributes of an Artifact-Factory are configurabel. | |
| 29 * name: The Name of the Artifact. Must be unique in one Artifact-Server | |
| 30 * description: Short description which Job the Artifactfactory has to do. | |
| 31 * ttl: The Time to Live: The Time using Milliseconds an Artifact created by this | |
| 32 factory can live without any Userinteraction. | |
| 33 * artifact: The Name of the Class of the Artifact which should be created. | |
| 34 | |
| 35 // TODO: List of Artifacts which currently used in this Configuration? | |
| 36 | |
| 37 \subsubsection{Configuration of main Artifact} | |
| 38 To each Artifact-Factory it is necessary to configure one Artifact which will be | |
| 39 created from the Factory. | |
| 40 This Artifact is the representation of the specific FIS. | |
| 41 It contains the Configuration which product will be serverd for ths FIS. | |
| 42 | |
| 43 The Artifacts are configured in the Section /artifact-database/artifacts of | |
| 44 the Configurationfile. | |
| 45 | |
| 46 \begin{lstlisting} | |
| 47 <artifact name='fis\_marnet'> | |
| 48 <products> | |
| 49 ... | |
| 50 </products> | |
| 51 </artifact> | |
| 52 \end{lstlisting} | |
| 53 | |
| 54 The Key is to use the same Name for the Artifact as used for the Artifactfactory. | |
| 55 The Name has to be unique. | |
| 56 In the Section /artifact/products it is possible to define several Products as | |
| 57 explained in the next Section. | |
| 58 | |
| 59 \paragraph{Products to an Artifact} | |
| 60 One Artifact can provide several Products. | |
| 61 To do this it is required to configure them as shown below in the Section | |
| 62 /artifact/products | |
| 63 | |
| 64 \begin{lstlisting} | |
| 65 <product name= "timeSeries"> | |
| 66 <artifact-factory name="timeSeries" | |
| 67 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints" | |
| 68 ttl="300000" | |
| 69 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact"> | |
| 70 de.intevation.gnv.artifacts.GNVArtifactFactory | |
| 71 </artifact-factory> | |
| 72 <parameters> | |
| 73 <parameter name="sourceid" | |
| 74 value="4"/> | |
| 75 <parameter name="fisname" | |
| 76 value="fis\_marnet"/> | |
| 77 </parameters> | |
| 78 </product> | |
| 79 \end{lstlisting} | |
| 80 | |
| 81 Each Product is represented by an Artifact. To create this Artifact we have to | |
| 82 use an Artifact-Factory which is configured in each product | |
| 83 (/product/artifact-factory). | |
| 84 | |
| 85 Each Product can have several parameters /product/parameters/parameters. | |
| 86 The Parameter named sourceid and fisname are required Parameters. | |
| 87 | |
| 88 The Parameter fisname contains the key to the Name of the FIS. The Key must be | |
| 89 unique. | |
| 90 The Parameter sourceid contains the key to identify the FIS in the | |
| 91 DataWareHouse. (MEDIAN.SOURCEINFO) | |
| 92 | |
| 93 | |
| 94 \subsubsection{Configuration of the Product-Artifacts} | |
| 95 \paragraph{States} | |
| 96 \paragraph{Transitions} | |
| 97 \paragraph{Outputstate} | |
| 98 | |
| 99 | |
| 5 \subsection{Adding a new FIS} | 100 \subsection{Adding a new FIS} |
| 6 In this Section it will explained which steps has to be done to integrate a new | 101 In this Section it will explained which steps has to be done to integrate a new |
| 7 FIS into the Artifact-Server. | 102 FIS into the Artifact-Server. |
| 8 This will be done using the Configuration for an FIS which use data from | 103 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 | 104 MEDIAN.TIMESERIES Section of the DataWareHouse e.g. MARNET or STAUN |