dive4elements/gnv-client: doc/config-manual/model_of

comparison doc/config-manual/model_of_transitions.tex @ 920:63bc0044ff72

Fixed some typos. Do some document-styling doc/trunk@1055 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Tim Englich <tim.englich@intevation.de>
date	Tue, 04 May 2010 14:10:35 +0000
parents	29a4a1a99a22
children	4615bc4dc822

comparison

equal deleted inserted replaced

-:29a4a1a99a22
+:63bc0044ff72
 \item FIS and their according products (Metainformation)
 \item products with their states, transitions, outputs and SQL-statements
 (Implementation)
 \end{enumerate}
-%% TODO: Add a screenshoot of the GNV WebClient marking GUI elements for FIS,
+%% TODO: Add a Screenshot of the GNV WebClient marking GUI elements for FIS,
 %% product, states and transitions
 Main entry point for the configuration is the file \verb+ conf/conf.xml +
 defining the list of FIS and the according products based on the different
 datamodels in the datawarehouse. The provided datamodels are:
 \item InstantaneousPoints: conf\_instantaneouspoint.xml
 \end{itemize}
 Within each of these files, the steps for gathering the values for the
 parameterisation are configured by defining states, transitions and outputs
-(c.f. \ref{ref:config-a-product}).  The defintion of states, transitions and
+(c.f. \ref{ref:config-a-product}).  The definition of states, transitions and
 outputs reference the actual SQL-statements via identifier. The SQL-statements
 are gathered in the file \verb+conf/queries.txt+.
 \subsection{General principle of model of transitions}
 It is possible to configure the GNV in many ways.
 It is possible to add or remove FIS, add or remove Products from a FIS or
 to manipulate the steps which must be gone until a product can be create
-a diagramm or generate an CSV-Export.
+a diagram or generate an CSV-Export.
-The configuration of the provided FIS are devided in three main parts.
+The configuration of the provided FIS are divided in three main parts.
 \begin{itemize}
 \item Configuration of the list of FIS via Artifactfactories
 \item Configuration of main Artifacts which will be instantiated if an
 Artifactfactory was called.
 \item Configuration of the different Artifacts which provides Products which can be
 served by the FIS.
 \end{itemize}
 \subsubsection{Configuration of a FIS}
-The Point of Enty into the system is to configure an Artifactfactory.
+The Point of Entry into the system is to configure an Artifactfactory.
 Each Artifactfactory represents one FIS.
 It is possible to configure several Artifactfactories.
 The Artifactfactories will be configured in the Section
 /artifact-database/artifact-factories of the Configurationfile.
 artifact='de.intevation.artifactdatabase.ProxyArtifact'>
 de.intevation.gnv.artifacts.GNVProductArtifactFactory
 </artifact-factory>
 \end{lstlisting}
-At this moment the following Attributes of an Artifact-Factory are configurabel.
+At this moment the following Attributes of an Artifact-Factory are configurable.
 \begin{itemize}
 \item name: The Name of the Artifact. Must be unique in one Artifact-Server
 \item description: Short description which Job the Artifactfactory has to do.
 \item  ttl: The Time to Live: The Time using Milliseconds an Artifact, created using this
-factory, can live without any Userinteraction.
+factory, can live without any User interaction.
 \item artifact: The Name of the Class of the Artifact which should be created.
 \end{itemize}
 The next listing shows the dependencies between the FIS and the Name
 of the Artifactfactory which belongs to it.
 \subsubsection{Configuration of main Artifact}
 For each Artifact-Factory it is necessary to configure one Artifact which will be
 created using the Factory.
 This Artifact is the representation of the specific FIS.
-It contains the Configuration which products will be serverd for ths FIS.
+It contains the Configuration which products will be served for this FIS.
 The Artifacts are configured in the Section /artifact-database/artifacts of
 the Configurationfile.
 \begin{lstlisting}
 \subsubsection{Configuration of an Product}
 \label{ref:config-a-product}
 The Products of the different FIS are also modeled as Artifact-Objects.
-The different Products which are currently avaliable are stored in separate
+The different Products which are currently available are stored in separate
 Files in the Folder project.
 In those Files the Workflow of each product is configured.  Each step which is
-required to model a new Diagramm is represented using a state in the
+required to model a new diagram is represented using a state in the
 Configuration-File.
 To move between those States it is required to model Transitions which define
 between which States it is possible to move and which conditions must be
 fulfilled.
 The Last step is called OutputState. This State is responsible to generate the
-output for the different Formats which can be served from the Product (Diagramm,
+output for the different Formats which can be served from the Product (Diagram,
 CSV, ODV, WMS,...).
 \paragraph{States}
 A state is one Step which is required to fetch the Data for generating e.g. an
-Diagramm.
+Diagram.
 For example in each Product it is Possible to choose one or more Parameters.
 To configure a State you have to use a XML-Fragment as shown below:
 ...
 </inputvalues>
 </state>
 \end{lstlisting}
-At this moment the following Attributes of an Artifact-Factory are configurabel.
+At this moment the following Attributes of an Artifact-Factory are configurable.
 \begin{itemize}
 \item id: The Name of the Artifact. Must be unique in one Artifact-Server
 \item description: Short description which Job the Artifactfactory has to do.
 \item queryID: The ID of the Query which should be used to fetch the Data
-displayed in this state. //TODO: Reference to queries.properties
+displayed in this state. All Queries are defined in the File
-\item dataname: The ID of the Data which will be displaied in this State.
+conf/queries.properties
+\item dataname: The ID of the Data which will be displayed in this State.
 The ID will be use to localize the description of the Data.
 \item data-multiselect: true it is possible to select 1 or more Items.
-false ist is possible to select only one Item.
+false it is possible to select only one Item.
 \item inputvalues: The Values which can be "feed" to this State and which
 will be used as Values in SQL-statements.
 \end{itemize}
 \paragraph{Input Values of a State}
 WARNING: The Order of the InputValues is significant at which position the Value will
 be put into the SQL-Statement.
 It is possible to add one InputValue twice or more often to put its value at
-different positions of the SQl-Statement.
+different positions of the SQL-statement.
 \begin{lstlisting}
 <inputvalues>
 <inputvalue name="featureid" type="Integer" multiselect="false" usedinquery="1"/>
 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/>
 <inputvalue name="parameterid" type="Integer" multiselect="true" usedinquery="0"/>
 </inputvalues>
 \end{lstlisting}
 \begin{itemize}
-\item name: Name of the Value that could be feed or should be used in SQl-statment.
+\item name: Name of the Value that could be feed or should be used in SQL-statment.
 The name must fit to one dataname configured in this State or one other
 State which was visited before.
 \item type: The type of the Value. This is required for the Validation
 of the Value.
 This might be String, Integer, Double, Date, Point, LineString,
 Polygon, Coordinate, Geometry and AttributeName.
-\item multiselect: true if more than on Value can be feed or put into the SQl-statement.
+\item multiselect: true if more than on Value can be feed or put into the SQL-statement.
 false if one on Value will be accepted.
 \item usedinquery: Number how often the value should be put into the SQL-Statement:
 0: Value will not out into the Statement.
-1: Value will put once into the Staement,
+1: Value will put once into the Statement,
 2 or more: Value will be put as often as configured
 into the SQL-Statement (this is useful if
 Inner-Selects are used)
 \end{itemize}
 The next part will explain the usage of inputvalues.
-This SQL-statment is configured to use in the State above.
+This SQL-statement is configured to use in the State above.
 \begin{lstlisting}
 SELECT DISTINCT
 p.PARAMETERID KEY,
 p.GERMANNAME || '  ['|| p.UNIT ||']' VALUE,
 This dependencies are called. Transitions.
 There are different Kind of Transitions which can be used.
 \begin{itemize}
 \item Transitions which only link two States
-\item Transition which link two States with a aditional Condition.
+\item Transition which link two States with a additional Condition.
 (e.g. If a region was selected in the Regionfilter or not )
 \end{itemize}
 The listing below shows a Transition with an additional Condition.
 \begin{lstlisting}
 \end{itemize}
 All these Outputstates are Implemented in package de.intevation.gnv.state
 and its subpackages.
-You have to put the fullqulified name of the Outputstate to the Attribute State
+You have to put the fullqualified name of the Outputstate to the Attribute State
 as shown below.
 You can configure an OutputState as shown below:
 \begin{lstlisting}
 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:
+Currently the following OutputModes are supported:
 \begin{itemize}
 \item chart
 \item histogram
 \item csv
 // 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.
+by the Program.
 \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}
 \paragraph{Example}
 This Example shows how to add an FIS and which effects it took to the
 REST-Server.
-At first we add the follwing Artifactfactory into the file conf/conf.xml
+At first we add the following Artifactfactory into the file conf/conf.xml
 in Section /artifact-database/artifact-factories which add a new
 FIS called justanewfis to the Server:
 \begin{lstlisting}
 <artifact-factory name='fis\_justanewfis'
 artifact='de.intevation.artifactdatabase.ProxyArtifact'>
 de.intevation.gnv.artifacts.GNVProductArtifactFactory
 </artifact-factory>
 \end{lstlisting}
-Then we restart the Artifact-database executing the followinig command:
+Then we restart the Artifact-database executing the following command:
+\begin{lstlisting}
 /etc/init.d/artifactdb restart
+\end{lstlisting}
 Then we check if the new FIS is served by the REST-Server
 calling the following command:
+\begin{lstlisting}
 curl http://localhost:8181/factories | xmllint --format - | grep fis\_justanewfis
+\end{lstlisting}
 If the FIS was added the new Artifactfactory will be found in the generated
 XML-Output and it will be shown.
 Otherwise no XML-Output will be shown.
 ...
 </products>
 </artifact>
 \end{lstlisting}
-In this XML- Fragment it is also required to replave the placeholder NEWFISNAME
+In this XML- Fragment it is also required to replace the placeholder NEWFISNAME
 with the name which was used to configure the Artifact-Factory.
-Now the ArtifactServer can serv an additional FIS without any Products yet.
+Now the ArtifactServer can handle an additional FIS without any Products yet.
 To prevent needless Configuration-Work it is useful way to clone an Artifact
 which handle the same Kind of work as the new FIS.
 \paragraph{Example}
 Now we will add a Product to the new FIS.
 To let the Products work we will choose a Product which
 will contain the sourceid of an existing FIS (e.g 4 Marnet).
-At first add the following XMl-Fragment to the new Artifact.
+At first add the following XML-Fragment to the new Artifact.
 \begin{lstlisting}
 <product name= "timeSeries">
 <artifact-factory name="timeSeries"
 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
 ttl="300000"
 If we call
 \begin{lstlisting}
 curl -d "@sample-documents/create-artifact.xml"  http://localhost:8181/create | xmllint --format -
 \end{lstlisting}
-The Product timeSeries should be available for ths FIS justanewfis.
+The Product timeSeries should be available for the FIS justanewfis.
 Now we should be able to choose the Product.
 This Product should work and you should be able to generate even the defined
 Outputformats.
-\subsubsection{Putting SourceID to specific Artifact}
 \subsection{Adding a new Product}
 To add a new Product to the System it is necessary that the required
-Artifactrepresentation is Implemented in the SourceCode.
+Artifact representation is Implemented in the SourceCode.
 Without doing that step it is not possible to create a new Product.
 All Products are configured in separate Files that will be included into the
-Mainconfiguration using Xlink-References.
+main configuration using Xlink-References.
 First Step is to create a new File in the Folder products and there in the
-subfolder where the Product belongs to (timeseries,verticalprofile,
+sub-folder where the Product belongs to (timeseries,verticalprofile,
 horizontalprofile,horizontalcrosssection,layer,...)
 Then you have tor reference this File in the File /conf/conf.xml in the Section
 /artifacts using the following XML-Fragment.

Mercurial > dive4elements > gnv-client

comparison doc/config-manual/model_of_transitions.tex @ 920:63bc0044ff72