Mercurial > dive4elements > gnv-client
comparison doc/config-manual/model_of_transitions.tex @ 909:fcde68463722
Added description for Configuration of OutputStates and OutputModes
doc/trunk@1043 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Tim Englich <tim.englich@intevation.de> |
|---|---|
| date | Mon, 03 May 2010 14:11:33 +0000 |
| parents | babeef4f8480 |
| children | 329a510ba5a2 |
comparison
equal
deleted
inserted
replaced
| 908:babeef4f8480 | 909:fcde68463722 |
|---|---|
| 149 The ID will be use to localize the description of the Data. | 149 The ID will be use to localize the description of the Data. |
| 150 \item data-multiselect: true it is possible to select 1 or more Items. | 150 \item data-multiselect: true it is possible to select 1 or more Items. |
| 151 false ist is possible to select only one Item. | 151 false ist is possible to select only one Item. |
| 152 \item inputvalues: The Values which can be "feed" //TODO: How to explain this | 152 \item inputvalues: The Values which can be "feed" //TODO: How to explain this |
| 153 to this State. | 153 to this State. |
| 154 \end{itemize} | 154 \end{itemize} |
| 155 | 155 |
| 156 | 156 |
| 157 \paragraph{Transitions} | 157 \paragraph{Transitions} |
| 158 | 158 |
| 159 To move between two States it is necessary to configure dependencies between | 159 To move between two States it is necessary to configure dependencies between |
| 181 \item to: The ID of the State which can be reached. | 181 \item to: The ID of the State which can be reached. |
| 182 \item condition: The Condition which have to be fulfilled. | 182 \item condition: The Condition which have to be fulfilled. |
| 183 \end{itemize} | 183 \end{itemize} |
| 184 | 184 |
| 185 \paragraph{Outputstate} | 185 \paragraph{Outputstate} |
| 186 | |
| 187 The OutputState is an special State which was created to define | |
| 188 the different possibilities of Outputs for each Product. | |
| 189 An OutputState is handled as an State which is described above. | |
| 190 Additionally you are able to configure which kind of outputs should | |
| 191 be provided. | |
| 192 | |
| 193 There are several OutputStates. Each one is designed to create | |
| 194 the output for one special Product (Verticalprofile, TimeSeries,...) | |
| 195 | |
| 196 //TODO: Listing of each OutputStates? | |
| 197 | |
| 198 You can configure an OutputState as shown below: | |
| 199 | |
| 200 \begin{lstlisting} | |
| 201 <state id="timeseries_calculate_results" description="timeseries_interval" state="de.intevation.gnv.state.timeseries.TimeSeriesOutputState"> | |
| 202 <queryID>timeseries_chart_data</queryID> | |
| 203 ... | |
| 204 <outputsModes> | |
| 205 <outputsMode name="chart" description="Chartrepresentation of the Values" mime-type="image/png"> | |
| 206 ... | |
| 207 </outputsMode> | |
| 208 </outputsModes> | |
| 209 </state> | |
| 210 \end{lstlisting} | |
| 211 | |
| 212 At Section /state/outputsModes it is possible to add one ore more OutputModes | |
| 213 to one State as shown in the next Paragraph. | |
| 214 | |
| 215 \paragraph{OutputModes} | |
| 216 | |
| 217 It is possible to configure several OutputModes in one OutputState. | |
| 218 Inserting or deleting the Configuration of an special | |
| 219 OutputMode will cause that the pending Item will be shown or hidden | |
| 220 in the GUI. | |
| 221 | |
| 222 WARNING: IT MIGHT BE POSSIBLE THAT ONE OR MORE OUTPUTMODES ARE NOT | |
| 223 SUPPORTED BY AN PRODUCT. IN THAT CASE IT IS NECESSARY TO | |
| 224 IMPLEMENT THE REQUIRED FUNCTIONALITY BEFORE IT IS POSSIBLE | |
| 225 TO OFFER THIS OUTPUTMODE. | |
| 226 | |
| 227 Currently the following outputmodes are supported: | |
| 228 | |
| 229 \begin{itemize} | |
| 230 \item chart | |
| 231 \item histogram | |
| 232 \item csv | |
| 233 \item odv | |
| 234 \item statistics | |
| 235 \item wms | |
| 236 \item shapefile | |
| 237 \end{itemize} | |
| 238 | |
| 239 The following Example shows the Configuration for the OutputMode Chart. | |
| 240 | |
| 241 \begin{lstlisting} | |
| 242 <outputsMode name="chart" description="Chartrepresentation of the Values" mime-type="image/png"> | |
| 243 <parameters> | |
| 244 <inputvalue name="width" type="Integer" value="600"/> | |
| 245 <inputvalue name="height" type="Integer" value="400"/> | |
| 246 <inputvalue name="points" type="Boolean" value="false"/> | |
| 247 </parameters> | |
| 248 <exportModes> | |
| 249 <export name="img" description="IMG-Export der Daten" mime-type="image/png" /> | |
| 250 <export name="pdf" description="PDF-Export der Daten" mime-type="application/pdf" /> | |
| 251 <export name="svg" description="SVG-Export der Daten" mime-type="image/svg+xml" /> | |
| 252 </exportModes> | |
| 253 </outputsMode> | |
| 254 \end{lstlisting} | |
| 255 | |
| 256 // TODO add simple OutputMode e.g. for CSV?? | |
| 257 | |
| 258 \begin{itemize} | |
| 259 \item name: The name of the Mode. This must not be changed because it is used | |
| 260 by the Programm. | |
| 261 \item description: a short description of this OutputMode. | |
| 262 \item parameters: one ore more parameters which will be shown in the GUI e.g. | |
| 263 for changing the Size of an Chart. | |
| 264 \item exportModes: one or more formats which can be served. | |
| 265 \end{itemize} | |
| 186 | 266 |
| 187 | 267 |
| 188 \subsection{Adding a new FIS} | 268 \subsection{Adding a new FIS} |
| 189 In this Section it will be explained which steps has to be done to integrate a | 269 In this Section it will be explained which steps has to be done to integrate a |
| 190 new FIS into the Artifact-Server. This will be done using the Configuration for | 270 new FIS into the Artifact-Server. This will be done using the Configuration for |