Mercurial > dive4elements > gnv-client
diff 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 |
line wrap: on
line diff
--- a/gnv-artifacts/doc/conf/products/timeseries/conf_timeseriespoint.xml Fri Nov 13 09:57:25 2009 +0000 +++ b/gnv-artifacts/doc/conf/products/timeseries/conf_timeseriespoint.xml Fri Nov 13 13:01:01 2009 +0000 @@ -1,19 +1,77 @@ <?xml version="1.0" encoding="UTF-8"?> +<!-- This is the Artifact which represents the required Businesslogic to + collect the required Data for rendering specified OutputFormats + for TimeSeries on TimeSeriesPoint-Data. + * Charts + * Statistics + * CSV + * ODV --> <artifact name="timeSeries"> <transitions> + + <!-- The required Transitionsteps which must be done until rendering + the OutputFormats. Each Transition is represented one required + Step. One Steps can consume specified InputParameters an after + that it can calculate new Data which will be used as possible + InputValues in the next Transition-Step from each Transition it + is only possible to move to those Transitions which are Configured + in the rechableTransitions-Tag --> + + <!-- Description of the Transition-Attributes: + * id: The id of the Transition. This must be unique in one Artifact. + It is used to reference the Transition eg. in + reachableTransitions. + * description: A short description which should describe the Transition + * transition: The Class which must be load to handle the required logic, + This class will be load using reflection. --> + <transition id="timeseries_area" description="timeseries_area_one" transition="de.intevation.gnv.transition.DefaultTransition"> + + <!-- The QueryID which identifies the Query which is configured in + the Queries-Properties-File. + It is possible to define no Query. + In this case you have to remove this Element from the + Configuration.--> <queryID>area_filter</queryID> + + <!-- The ID of the Data which will be fetched using this Transition. + The Name must be unique in one Artifact. + The Name is used for the localization and must be set into the + several PropertiesFiles for the localization. --> <dataname>areaid</dataname> + + <!-- This Flag will be used to switch between single and + multiselect possibility of the Data which will be fetched + using this transition. --> <data-multiselect>false</data-multiselect> - <data-noselect>true</data-noselect> + + <!-- Optional Flag which can be used to set that is is possible + to select no entry in the Data which will be fetched using + this transition. --> + <data-noselect>true</data-noselect> + <reachableTransitions> + <!-- reachableTransitions are those Transition which can be + reached as next Step. The Transition notifies in + describe-output which Transitions can be reached. + The User / calling program can choose which Transition + he/it wants to use next --> <transition>timeseries_subarea</transition> </reachableTransitions> + <inputvalues> + <!-- At this place it is necessary to configure the Elements + which must be feed and can be used in this transition. + It is possible to set if the Values should be used in + the DatabaseQuery of this Transition and how often it + must be used. + The order of the Elements is also the Order of usage setting + the Values into the SQL-Query. --> <inputvalue name="sourceid" type="Integer" multiselect="false" usedinquery="0"/> <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/> </inputvalues> </transition> + <transition id="timeseries_subarea" description="timeseries_subaera" transition="de.intevation.gnv.transition.DefaultTransition"> <queryID>subarea_filter</queryID> <dataname>subareaid</dataname> @@ -22,6 +80,9 @@ <transition>timeseries_timeseriespoint</transition> </reachableTransitions> <alternativeTransition> + <!-- It is possible to configure an alternative Transition which + will be used if the feed put the Information that no Data + was selected. --> <transition id="timeseries_without_geom" description="timeseries_mesh_without_geom" transition="de.intevation.gnv.transition.DefaultTransition"> <queryID>timeseries_timeseriespoint</queryID> <dataname>featureid</dataname> @@ -96,6 +157,9 @@ </inputvalues> </transition> + <!-- Last Transition is the Output-Transition. At this place the differen OutputModes are configured. + For each OutputMode it might be necessary to configure separat Databasequery which collect the + Data. --> <transition id="timeseries_calculate_results" description="timeseries_interval" transition="de.intevation.gnv.transition.timeseries.TimeSeriesOutputTransition"> <queryID>timeseries_chart_data</queryID> <queryID-odv>timeseries_odv_data</queryID-odv> @@ -117,6 +181,8 @@ <outputsMode name="odv" description="ODV-Export der Daten" mime-type="text/plain"/> <outputsMode name="statistics" description="Statistik zu den Daten" mime-type="text/xml"/> </outputsModes> + <!-- Definition of the TimeGaps which are required to render the Charts properly. + each Parameter in each FIS can have --> <time-gap-definition xlink:href="${artifacts.config.dir}/products/timeseries/timegap_definition.xml" /> </transition>