Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/doc/conf/products/timeseries/conf_timeseriespoint.xml @ 257:b198ca47f363
Added Documentation of Configuration-Files
gnv-artifacts/trunk@334 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Tim Englich <tim.englich@intevation.de> |
|---|---|
| date | Fri, 13 Nov 2009 13:01:01 +0000 |
| parents | 3d6d89bcbf42 |
| children | 9147e3931723 |
comparison
equal
deleted
inserted
replaced
| 256:008709f79611 | 257:b198ca47f363 |
|---|---|
| 1 <?xml version="1.0" encoding="UTF-8"?> | 1 <?xml version="1.0" encoding="UTF-8"?> |
| 2 <!-- This is the Artifact which represents the required Businesslogic to | |
| 3 collect the required Data for rendering specified OutputFormats | |
| 4 for TimeSeries on TimeSeriesPoint-Data. | |
| 5 * Charts | |
| 6 * Statistics | |
| 7 * CSV | |
| 8 * ODV --> | |
| 2 <artifact name="timeSeries"> | 9 <artifact name="timeSeries"> |
| 3 <transitions> | 10 <transitions> |
| 11 | |
| 12 <!-- The required Transitionsteps which must be done until rendering | |
| 13 the OutputFormats. Each Transition is represented one required | |
| 14 Step. One Steps can consume specified InputParameters an after | |
| 15 that it can calculate new Data which will be used as possible | |
| 16 InputValues in the next Transition-Step from each Transition it | |
| 17 is only possible to move to those Transitions which are Configured | |
| 18 in the rechableTransitions-Tag --> | |
| 19 | |
| 20 <!-- Description of the Transition-Attributes: | |
| 21 * id: The id of the Transition. This must be unique in one Artifact. | |
| 22 It is used to reference the Transition eg. in | |
| 23 reachableTransitions. | |
| 24 * description: A short description which should describe the Transition | |
| 25 * transition: The Class which must be load to handle the required logic, | |
| 26 This class will be load using reflection. --> | |
| 27 | |
| 4 <transition id="timeseries_area" description="timeseries_area_one" transition="de.intevation.gnv.transition.DefaultTransition"> | 28 <transition id="timeseries_area" description="timeseries_area_one" transition="de.intevation.gnv.transition.DefaultTransition"> |
| 29 | |
| 30 <!-- The QueryID which identifies the Query which is configured in | |
| 31 the Queries-Properties-File. | |
| 32 It is possible to define no Query. | |
| 33 In this case you have to remove this Element from the | |
| 34 Configuration.--> | |
| 5 <queryID>area_filter</queryID> | 35 <queryID>area_filter</queryID> |
| 36 | |
| 37 <!-- The ID of the Data which will be fetched using this Transition. | |
| 38 The Name must be unique in one Artifact. | |
| 39 The Name is used for the localization and must be set into the | |
| 40 several PropertiesFiles for the localization. --> | |
| 6 <dataname>areaid</dataname> | 41 <dataname>areaid</dataname> |
| 42 | |
| 43 <!-- This Flag will be used to switch between single and | |
| 44 multiselect possibility of the Data which will be fetched | |
| 45 using this transition. --> | |
| 7 <data-multiselect>false</data-multiselect> | 46 <data-multiselect>false</data-multiselect> |
| 8 <data-noselect>true</data-noselect> | 47 |
| 48 <!-- Optional Flag which can be used to set that is is possible | |
| 49 to select no entry in the Data which will be fetched using | |
| 50 this transition. --> | |
| 51 <data-noselect>true</data-noselect> | |
| 52 | |
| 9 <reachableTransitions> | 53 <reachableTransitions> |
| 54 <!-- reachableTransitions are those Transition which can be | |
| 55 reached as next Step. The Transition notifies in | |
| 56 describe-output which Transitions can be reached. | |
| 57 The User / calling program can choose which Transition | |
| 58 he/it wants to use next --> | |
| 10 <transition>timeseries_subarea</transition> | 59 <transition>timeseries_subarea</transition> |
| 11 </reachableTransitions> | 60 </reachableTransitions> |
| 61 | |
| 12 <inputvalues> | 62 <inputvalues> |
| 63 <!-- At this place it is necessary to configure the Elements | |
| 64 which must be feed and can be used in this transition. | |
| 65 It is possible to set if the Values should be used in | |
| 66 the DatabaseQuery of this Transition and how often it | |
| 67 must be used. | |
| 68 The order of the Elements is also the Order of usage setting | |
| 69 the Values into the SQL-Query. --> | |
| 13 <inputvalue name="sourceid" type="Integer" multiselect="false" usedinquery="0"/> | 70 <inputvalue name="sourceid" type="Integer" multiselect="false" usedinquery="0"/> |
| 14 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/> | 71 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/> |
| 15 </inputvalues> | 72 </inputvalues> |
| 16 </transition> | 73 </transition> |
| 74 | |
| 17 <transition id="timeseries_subarea" description="timeseries_subaera" transition="de.intevation.gnv.transition.DefaultTransition"> | 75 <transition id="timeseries_subarea" description="timeseries_subaera" transition="de.intevation.gnv.transition.DefaultTransition"> |
| 18 <queryID>subarea_filter</queryID> | 76 <queryID>subarea_filter</queryID> |
| 19 <dataname>subareaid</dataname> | 77 <dataname>subareaid</dataname> |
| 20 <data-multiselect>false</data-multiselect> | 78 <data-multiselect>false</data-multiselect> |
| 21 <reachableTransitions> | 79 <reachableTransitions> |
| 22 <transition>timeseries_timeseriespoint</transition> | 80 <transition>timeseries_timeseriespoint</transition> |
| 23 </reachableTransitions> | 81 </reachableTransitions> |
| 24 <alternativeTransition> | 82 <alternativeTransition> |
| 83 <!-- It is possible to configure an alternative Transition which | |
| 84 will be used if the feed put the Information that no Data | |
| 85 was selected. --> | |
| 25 <transition id="timeseries_without_geom" description="timeseries_mesh_without_geom" transition="de.intevation.gnv.transition.DefaultTransition"> | 86 <transition id="timeseries_without_geom" description="timeseries_mesh_without_geom" transition="de.intevation.gnv.transition.DefaultTransition"> |
| 26 <queryID>timeseries_timeseriespoint</queryID> | 87 <queryID>timeseries_timeseriespoint</queryID> |
| 27 <dataname>featureid</dataname> | 88 <dataname>featureid</dataname> |
| 28 <data-multiselect>false</data-multiselect> | 89 <data-multiselect>false</data-multiselect> |
| 29 <reachableTransitions> | 90 <reachableTransitions> |
| 94 <inputvalue name="parameterid" type="Integer" multiselect="true"/> | 155 <inputvalue name="parameterid" type="Integer" multiselect="true"/> |
| 95 <inputvalue name="measurementid" type="Integer" multiselect="true"/> | 156 <inputvalue name="measurementid" type="Integer" multiselect="true"/> |
| 96 </inputvalues> | 157 </inputvalues> |
| 97 </transition> | 158 </transition> |
| 98 | 159 |
| 160 <!-- Last Transition is the Output-Transition. At this place the differen OutputModes are configured. | |
| 161 For each OutputMode it might be necessary to configure separat Databasequery which collect the | |
| 162 Data. --> | |
| 99 <transition id="timeseries_calculate_results" description="timeseries_interval" transition="de.intevation.gnv.transition.timeseries.TimeSeriesOutputTransition"> | 163 <transition id="timeseries_calculate_results" description="timeseries_interval" transition="de.intevation.gnv.transition.timeseries.TimeSeriesOutputTransition"> |
| 100 <queryID>timeseries_chart_data</queryID> | 164 <queryID>timeseries_chart_data</queryID> |
| 101 <queryID-odv>timeseries_odv_data</queryID-odv> | 165 <queryID-odv>timeseries_odv_data</queryID-odv> |
| 102 <inputvalues> | 166 <inputvalues> |
| 103 <inputvalue name="parameterid" type="Integer" multiselect="true"/> | 167 <inputvalue name="parameterid" type="Integer" multiselect="true"/> |
| 115 </outputsMode> | 179 </outputsMode> |
| 116 <outputsMode name="csv" description="CSV-Export der Daten" mime-type="text/plain"/> | 180 <outputsMode name="csv" description="CSV-Export der Daten" mime-type="text/plain"/> |
| 117 <outputsMode name="odv" description="ODV-Export der Daten" mime-type="text/plain"/> | 181 <outputsMode name="odv" description="ODV-Export der Daten" mime-type="text/plain"/> |
| 118 <outputsMode name="statistics" description="Statistik zu den Daten" mime-type="text/xml"/> | 182 <outputsMode name="statistics" description="Statistik zu den Daten" mime-type="text/xml"/> |
| 119 </outputsModes> | 183 </outputsModes> |
| 184 <!-- Definition of the TimeGaps which are required to render the Charts properly. | |
| 185 each Parameter in each FIS can have --> | |
| 120 <time-gap-definition xlink:href="${artifacts.config.dir}/products/timeseries/timegap_definition.xml" /> | 186 <time-gap-definition xlink:href="${artifacts.config.dir}/products/timeseries/timegap_definition.xml" /> |
| 121 </transition> | 187 </transition> |
| 122 | 188 |
| 123 </transitions> | 189 </transitions> |
| 124 </artifact> | 190 </artifact> |