Mercurial > dive4elements > gnv-client
changeset 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 (2010-05-03) |
parents | babeef4f8480 |
children | 329a510ba5a2 |
files | doc/ChangeLog doc/config-manual/model_of_transitions.tex |
diffstat | 2 files changed, 86 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog Mon May 03 12:35:48 2010 +0000 +++ b/doc/ChangeLog Mon May 03 14:11:33 2010 +0000 @@ -1,3 +1,8 @@ +2010-05-03 Tim Englich <tim@intevation.de> + + * config-manual/model_of_transitions.tex: + Added Description of Configuration for OutputStates and OutputModes. + 2010-05-03 Tim Englich <tim@intevation.de> * config-manual/model_of_transitions.tex:
--- a/doc/config-manual/model_of_transitions.tex Mon May 03 12:35:48 2010 +0000 +++ b/doc/config-manual/model_of_transitions.tex Mon May 03 14:11:33 2010 +0000 @@ -151,7 +151,7 @@ false ist is possible to select only one Item. \item inputvalues: The Values which can be "feed" //TODO: How to explain this to this State. - \end{itemize} +\end{itemize} \paragraph{Transitions} @@ -184,6 +184,86 @@ \paragraph{Outputstate} +The OutputState is an special State which was created to define +the different possibilities of Outputs for each Product. +An OutputState is handled as an State which is described above. +Additionally you are able to configure which kind of outputs should +be provided. + +There are several OutputStates. Each one is designed to create +the output for one special Product (Verticalprofile, TimeSeries,...) + +//TODO: Listing of each OutputStates? + +You can configure an OutputState as shown below: + +\begin{lstlisting} +<state id="timeseries_calculate_results" description="timeseries_interval" state="de.intevation.gnv.state.timeseries.TimeSeriesOutputState"> + <queryID>timeseries_chart_data</queryID> + ... + <outputsModes> + <outputsMode name="chart" description="Chartrepresentation of the Values" mime-type="image/png"> + ... + </outputsMode> + </outputsModes> + </state> +\end{lstlisting} + +At Section /state/outputsModes it is possible to add one ore more OutputModes +to one State as shown in the next Paragraph. + +\paragraph{OutputModes} + +It is possible to configure several OutputModes in one OutputState. +Inserting or deleting the Configuration of an special +OutputMode will cause that the pending Item will be shown or hidden +in the GUI. + +WARNING: IT MIGHT BE POSSIBLE THAT ONE OR MORE OUTPUTMODES ARE NOT + SUPPORTED BY AN PRODUCT. IN THAT CASE IT IS NECESSARY TO + IMPLEMENT THE REQUIRED FUNCTIONALITY BEFORE IT IS POSSIBLE + TO OFFER THIS OUTPUTMODE. + +Currently the following outputmodes are supported: + +\begin{itemize} + \item chart + \item histogram + \item csv + \item odv + \item statistics + \item wms + \item shapefile +\end{itemize} + +The following Example shows the Configuration for the OutputMode Chart. + +\begin{lstlisting} +<outputsMode name="chart" description="Chartrepresentation of the Values" mime-type="image/png"> + <parameters> + <inputvalue name="width" type="Integer" value="600"/> + <inputvalue name="height" type="Integer" value="400"/> + <inputvalue name="points" type="Boolean" value="false"/> + </parameters> + <exportModes> + <export name="img" description="IMG-Export der Daten" mime-type="image/png" /> + <export name="pdf" description="PDF-Export der Daten" mime-type="application/pdf" /> + <export name="svg" description="SVG-Export der Daten" mime-type="image/svg+xml" /> + </exportModes> +</outputsMode> +\end{lstlisting} + +// TODO add simple OutputMode e.g. for CSV?? + +\begin{itemize} + \item name: The name of the Mode. This must not be changed because it is used + by the Programm. + \item description: a short description of this OutputMode. + \item parameters: one ore more parameters which will be shown in the GUI e.g. + for changing the Size of an Chart. + \item exportModes: one or more formats which can be served. +\end{itemize} + \subsection{Adding a new FIS} In this Section it will be explained which steps has to be done to integrate a