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

comparison doc/config-manual/model_of_transitions.tex @ 940:14df4bcabc3c

Fixed some Mistakes doc/trunk@1083 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Tim Englich <tim.englich@intevation.de>
date	Mon, 10 May 2010 10:43:01 +0000
parents	c2ce233cd9cf
children	7a8f9eb9fb04

comparison

equal deleted inserted replaced

-:2fc4999cf922
+:14df4bcabc3c
 \subsection{Explaining the background of the XML configuration}
 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
+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 diagram or generate an CSV-Export.
+a diagram or generate an CSV-export.
 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 the list of FIS via artifact-factories
-\item Configuration of main Artifacts which will be instantiated if an
+\item Configuration of main artifacts which will be instantiated if an
-Artifactfactory was called.
+artifact-factory was called.
-\item Configuration of the different Artifacts which provides Products which can be
+\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 Entry into the system is to configure an Artifactfactory.
+The point of entry into the system is to configure an artifact-factory.
-Each Artifactfactory represents one FIS.
+Each artifact-factory represents one FIS.
-It is possible to configure several Artifactfactories.
+It is possible to configure several artifact-factories.
-The Artifactfactories will be configured in the Section
+The artifact-factories will be configured in the section
-/artifact-database/artifact-factories of the Configurationfile.
+/artifact-database/artifact-factories of the configurationfile.
 \begin{lstlisting}
 <artifact-factory name='fis_NEWFISNAME'
 description='Factory to create an artifact to be used with the FIS NEWFISNAME'
 ttl='3600000'
 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 configurable.
+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 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 description: Short description which job the artifact-factory has to do.
-\item  ttl: The Time to Live: The Time using Milliseconds an Artifact, created using this
+\item  ttl: The time to live: The time using milliseconds an artifact, created using this
-factory, can live without any User interaction.
+factory, can live without any user-interaction.
-\item artifact: The Name of the Class of the Artifact which should be created.
+\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
+The next listing shows the dependencies between the FIS and the name
-of the Artifactfactory which belongs to it.
+of the artifact-factory which belongs to it.
 \begin{itemize}
 \item Marnet: fis\_marnet
 \item IMIS: fis\_imis
 \item STAUN: fis\_staun
 \item Thermosalinograph: fis\_thermosalinograph
 \item Chemusurvey: fis\_chemusurvey
 \item GTS: fis\_gts
 \item CTD: fis\_bsh\_ctd
 \item XBT: fis\_bsh\_xbt
-\item SeaCat: is\_seacat
+\item SeaCat: fis\_seacat
 \item Sea State: fis\_seastate
 \item Current Meter: fis\_currentmeter
 \item Nauthis: fis\_nauthis
 \item Contis: fis\_contis
 \item Marine Features: fis\_marinefeatures
 \end{itemize}
 \subsubsection{Configuration of main Artifact}
-For each Artifact-Factory it is necessary to configure one Artifact which will be
+For each artifact-factory it is necessary to configure one artifact which will be
-created using the Factory.
+created using the factory.
-This Artifact is the representation of the specific FIS.
+This artifact is the representation of the specific FIS.
-It contains the Configuration which products will be served for this 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 artifacts are configured in the section /artifact-database/artifacts of
-the Configurationfile.
+the configurationfile.
 \begin{lstlisting}
 <artifact name='fis_NEWFISNAME'>
 <products>
 ...
 </products>
 </artifact>
 \end{lstlisting}
-The Key is to use the same Name for the Artifact as used for the Artifactfactory.
+The key is to use the same name for the artifact as used for the artifact-factory.
-The Name has to be unique.
+The name has to be unique.
-In the Section /artifact/products it is possible to define several Products as
+In the section /artifact/products it is possible to define several products as
-explained in the next Section.
+explained in the next section.
 \paragraph{Products to an FIS}
-One FIS can provide several Products.
+One FIS can provide several products.
-To do this it is required to configure them as shown below in the Section
+To do this it is required to configure them as shown below in the section
 /artifact/products
 \begin{lstlisting}
 <product name= "timeSeries">
 <artifact-factory name="timeSeries"
 value="fis\_marnet"/>
 </parameters>
 </product>
 \end{lstlisting}
-Each Product is also represented by an Artifact. To create this Artifact we have to
+Each product is also represented by an artifact. To create this artifact we have to
-use an Artifact-Factory which is configured in each product
+use an artifact-factory which is configured in each product
 (/product/artifact-factory).
-Each Product can have several parameters /product/parameters/parameters.
+Each product can have several parameters /product/parameters/parameters.
-The Parameter named sourceid and fisname are required Parameters.
+The parameter named sourceid and fisname are required parameters.
-The Parameter fisname contains the key to the Name of the FIS. The Key must be
+The parameter fisname contains the key to the name of the FIS. The key must be
 unique.
-The Parameter sourceid contains the key to identify the FIS in the
+The parameter sourceid contains the key to identify the FIS in the
-DataWareHouse. (MEDIAN.SOURCEINFO)
+datawarehouse. (MEDIAN.SOURCEINFO)
 \subsubsection{Configuration of an Product}
 \label{ref:config-a-product}
-The Products of the different FIS are also modeled as Artifact-Objects.
+The products of the different FIS are also modeled as artifact-objects.
-The different Products which are currently available are stored in separate
+The different products which are currently available are stored in separate
-Files in the Folder project.
+files in the folder project.
-In those Files the Workflow of each product is configured.  Each step which is
+In those files the workflow of each product is configured.  Each step which is
 required to model a new diagram is represented using a state in the
-Configuration-File.
+configurationfile.
-To move between those States it is required to model Transitions which define
+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
+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
+The last step is called output-state. This state is responsible to generate the
-output for the different Formats which can be served from the Product (Diagram,
+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
+A state is one step which is required to fetch the data for generating e.g. an
-Diagram.
+diagram.
-For example in each Product it is Possible to choose one or more Parameters.
+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:
+To configure a state you have to use a XML-fragment as shown below:
 \begin{lstlisting}
 <state id="timeseries_parameter" description="timeseries_parameter" state="de.intevation.gnv.state.DefaultState">
 <queryID>timeseries_parameter</queryID>
 <dataname>parameterid</dataname>
 ...
 </inputvalues>
 </state>
 \end{lstlisting}
-At this moment the following Attributes of an Artifact-Factory are configurable.
+At this moment the following attributes of an state are configurable.
 \begin{itemize}
-\item id: The Name of the Artifact. Must be unique in one Artifact-Server
+\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 description: Short description which job the artifact-factory has to do.
-\item queryID: The ID of the Query which should be used to fetch the Data
+\item queryID: The id of the query which should be used to fetch the data
-displayed in this state. All Queries are defined in the File
+displayed in this state. All queries are defined in the file
 conf/queries.properties
-\item dataname: The ID of the Data which will be displayed in this State.
+\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.
+The id will be use to localize the description of the data.
-The Localization is located in Module gnv-artifacts in Folder
+The localization is located in module gnv-artifacts in folder
 src/main/resources.
-\item data-multiselect: true it is possible to select 1 or more Items.
+\item data-multiselect: true it is possible to select 1 or more items.
-false it 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
+\item inputvalues: The values which can be "feed" to this state and which
-will be used as Values in SQL-statements.
+will be used as values in SQL-statements.
 \end{itemize}
 \paragraph{Input Values of a State}
-At Section /state/inputvalues it is possible to add Definitions for InputValues.
+At section /state/inputvalues it is possible to add definitions for inputvalues.
-Those values have two meanings for the State.
+Those values have two meanings for the state.
 \begin{itemize}
-\item They were used to fill the SQL-Statements to fetch the Data
+\item They were used to fill the SQL-statements to fetch the data.
 (Each entry replace one ore more "?" )
-\item They were used to validate the Inputdata which is "feed" to
+\item They were used to validate the inputdata which is "feed" to
-the FIS in the current State
+the FIS in the current state.
 \end{itemize}
-WARNING: The Order of the InputValues is significant at which position the Value will
+WARNING: The order of the inputvalues is significant at which position the value will
-be put into the SQL-Statement.
+be put into the SQL-statement.
-It is possible to add one InputValue twice or more often to put its value at
+It is possible to add one inputvalue twice or more often to put its value at
 different positions of the SQL-statement.
 \begin{lstlisting}
 <inputvalues>
 <inputvalue name="featureid" type="Integer" multiselect="false" usedinquery="1"/>
 <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
+The name must fit to one dataname configured in this state or one other
-State which was visited before.
+state which was visited before.
-\item type: The type of the Value. This is required for the Validation
+\item type: The type of the value. This is required for the validation
-of the Value.
+of the value.
 This might be String, Integer, Double, Date, Point, LineString,
 Polygon, Coordinate, Geometry and AttributeName.
-Coordinate is a Format which accepts Geographical Coodinates in
+Coordinate is a format which accepts geographical coordinates in
 the following Syntax: 56n30 6e20
-AttributeName marks a StringValue which will be used in
+AttributeName marks a stringvalue which will be used in
-SQL-Statement without surrounding with "'" in the Statement.
+SQL-statement without surrounding with "'" in the statement.
-Usage is e.g. for determining the Axis (i or j) in the Workflow
+Usage is e.g. for determining the Axis (i or j) in the workflow
-of HorizontalProfiles.
+of Horizontalprofiles.
-\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.
+false if one on value will be accepted.
-\item usedinquery: Number how often the value should be put into the SQL-Statement:
+\item usedinquery: Number how often the value should be put into the SQL-statement:
-0: Value will not out into the Statement.
+0: Value will not out into the statement.
-1: Value will put once into the Statement,
+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
+into the SQL-statement (this is useful if
-Inner-Selects are used)
+inner-selects are used)
 \end{itemize}
 The next part will explain the usage of inputvalues.
-This SQL-statement is configured to use in the State above, which will fetch
+This SQL-statement is configured to use in the state above, which will fetch
-all ParameterIDs with the according german name which are reffered to the given
+all parameter-ids with the according german name which are reffered to the given
 TimeSeriesPoint (e.g.Arkona Basin Buoy FeatureID = 100011 )
 \begin{lstlisting}
 SELECT DISTINCT
 P.PARAMETERID = TS.PARAMETERID AND
 TSP.FEATUREID = ?
 ORDER BY P.GERMANNAME
 \end{lstlisting}
-If there are put the Inputvalues in it it will look like this
+If there are put the inputvalues in it it will look like this
 if we assume that the inputvalues has got the following values
 which where feed by choosing this FIS (fisname) and the Station
 (featureid: Arkona Basin Buoy ):
 \begin{itemize}
 \item featureid: 100011 (Marnet ==> Arkona Basin Buoy)
 P.PARAMETERID = TS.PARAMETERID AND
 TSP.FEATUREID = 100011
 ORDER BY P.GERMANNAME
 \end{lstlisting}
-The value of featureid will be inserted into the Query because
+The value of featureid will be inserted into the query because
-the Attribute usedinquery is set to "1".
+the attribute usedinquery is set to "1".
 The values of the inputvalues fisname and parameterid will be
-excluded because the Attribute usedinquery is set to "0"
+excluded because the attribute usedinquery is set to "0"
-If the Attribute usedinquery of the inputvalue featureid is set to "2"
+If the attribute usedinquery of the inputvalue featureid is set to "2"
 this might happen.
 \begin{lstlisting}
 <inputvalues>
 <inputvalue name="featureid" type="Integer" multiselect="false" usedinquery="2"/>
 TSP.FEATUREID = 100011
 ORDER BY P.GERMANNAME
 \end{lstlisting}
-At the next Step of the Workflow it is nessesary to determine all depths where
+At the next step of the workflow it is nessesary to determine all depths where
-the choosen parameters are meaured.
+the choosen parameters are measured.
-To do this we might have the following InputValues:
+To do this we might have the following inputvalues:
 \begin{lstlisting}
 <inputvalues>
 <inputvalue name="featureid" type="Integer" multiselect="false" usedinquery="2"/>
 <inputvalue name="fisname" type="String" multiselect="false" usedinquery="0"/>
 \end{lstlisting}
 \paragraph{Transitions}
-To move between two States it is necessary to configure dependencies between
+To move between two states it is necessary to configure dependencies between
-the different States.
+the different states.
-This dependencies are called. Transitions.
+This dependencies are called transitions.
-There are different Kind of Transitions which can be used.
+There are different kinds of transitions which can be used.
 \begin{itemize}
-\item Transitions which only link two States
+\item Transitions which only link two states
-\item Transition which link two States with a additional 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.
+The listing below shows a transition with an additional condition.
 \begin{lstlisting}
 <transition transition="de.intevation.gnv.transition.ValueCompareTransition">
 <from state="timeseries_area"/>
 <to state="timeseries_without_geom"/>
 <condition inputvalue="areaid" value="n/n" operator="equal"/>
 </transition>
 \end{lstlisting}
 \begin{itemize}
-\item from: The ID of the State which you have to come from
+\item from: The id of the state which you have to come from
-\item to:   The ID of the State which can be reached.
+\item to:   The id of the state which can be reached.
-\item condition: The Condition which have to be fulfilled.
+\item condition: The condition which have to be fulfilled.
 \end{itemize}
-At this Moment only EQUAL and NOTEQUAL are supported as condition for an
+At this moment only EQUAL and NOTEQUAL are supported as condition for an
 ValueCompareTransition.
 \paragraph{Outputstate}
-The OutputState is an special State which was created to define
+The outputstate is an special state which was created to define
-the different possibilities of Outputs for each Product.
+the different possibilities of outputs for each product.
-An OutputState is handled as an State which is described above.
+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
+There are several outputstates. Each one is designed to create
-the output for one special Product.
+the output for one special product.
 \begin{itemize}
 \item TimeSeries: TimeSeriesOutputState
 \item Horizontalprofile: HorizontalProfileOutputState
 \item Horizontalprofile on Meshes: HorizontalProfileMeshOutputState
 \item Verticalprofiles: VerticalProfileOutputState
 \item Horizontalcrosssections: HorizontalCrossSectionMeshOutputState
 \item Layer: LayerOutputState
 \end{itemize}
-All these Outputstates are Implemented in package de.intevation.gnv.state
+All these outputstates are implemented in package de.intevation.gnv.state
 and its subpackages.
-You have to put the fullqualified 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:
+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>
 ...
 </outputsMode>
 </outputsModes>
 </state>
 \end{lstlisting}
-At Section /state/outputsModes it is possible to add one ore more OutputModes
+At section /state/outputsModes it is possible to add one ore more outputmodes
-to one State as shown in the next Paragraph.
+to one state as shown in the next paragraph.
 \paragraph{OutputModes}
-It is possible to configure several OutputModes in one OutputState.
+It is possible to configure several outputmodes in one outputstate.
-Inserting or deleting the Configuration of an special
+Inserting or deleting the configuration of an special
-OutputMode will cause that the pending Item will be shown or hidden
+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:
+Currently the following outputmodes are supported:
 \begin{itemize}
 \item chart
 \item histogram
 \item csv
 \item statistics
 \item wms
 \item shapefile
 \end{itemize}
-The following Example shows the Configuration for the OutputMode Chart.
+The following example shows how to configure an outputmode chart:
 \begin{lstlisting}
 <outputsMode name="chart" description="Chartrepresentation of the Values" mime-type="image/png">
 <parameters>
 <inputvalue name="width" type="Integer" value="600"/>
 \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
+\item name: The name of the mode. This must not be changed because it is used
-by the Program.
+by the program.
-\item description: a short description of this OutputMode.
+\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.
+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
+In this section it will be explained which steps has to be done to integrate a
-new FIS into the Artifact-Server.  This will be done using the Configuration for
+new FIS into the artifact-server.  This will be done using the configuration for
-an FIS which use data from MEDIAN.TIMESERIES Section of the DataWareHouse e.g.
+an FIS which use data from MEDIAN.TIMESERIES section of the datawarehouse e.g.
 MARNET or STAUN
-Pay attention that for publishing the Changes to the Artifact-Server you will
+Pay attention that for publishing the changes to the artifact-server you will
 have to restart it.
-\subsubsection{Adding a new Artifactfactory}
+\subsubsection{Adding a new Artifact-factory}
-First step is to add a new Artifactfactory to the Configuration conf/conf.xml
+First step is to add a new artifact-factory to the configuration conf/conf.xml
-To do this you have to add a new XML-Fragment into the Section
+To do this you have to add a new XML-fragment into the section
 /factories/artifact-factories  which look like that:
 \begin{lstlisting}
 <artifact-factory name='fis\_NEWFISNAME'
 description='Factory to create an artifact to be used with the FIS NEWFISNAME'
 artifact='de.intevation.artifactdatabase.ProxyArtifact'>
 de.intevation.gnv.artifacts.GNVProductArtifactFactory
 </artifact-factory>
 \end{lstlisting}
-In this XML-Fragment you only have to replace the placeholder NEWFISNAME with a
+In this XML-fragment you only have to replace the placeholder NEWFISNAME with a
-unique short Name for the new FIS.
+unique short name for the new FIS.
 \paragraph{Example}
-This Example shows how to add an FIS and which effects it took to the
+This example shows how to add an FIS and which effects it took to the
 REST-Server.
-At first we add the following Artifactfactory into the file conf/conf.xml
+At first we add the following artifact-factory into the file conf/conf.xml
-in Section /artifact-database/artifact-factories which add a new
+in section /artifact-database/artifact-factories which add a new
-FIS called justanewfis to the Server:
+FIS called justanewfis to the server:
 \begin{lstlisting}
 <artifact-factory name='fis\_justanewfis'
 description='Factory to create an artifact to be used with the FIS NEWFISNAME'
 ttl='3600000'
 artifact='de.intevation.artifactdatabase.ProxyArtifact'>
 de.intevation.gnv.artifacts.GNVProductArtifactFactory
 </artifact-factory>
 \end{lstlisting}
-Then we restart the Artifact-database executing the following command:
+Then we restart the artifact-database executing the following command:
 \begin{lstlisting}
 /etc/init.d/artifactdb restart
 \end{lstlisting}
 \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
+If the FIS was added the new artifact-factory will be found in the generated
-XML-Output and it will be shown.
+XML-output and it will be shown.
-Otherwise no XML-Output will be shown.
+Otherwise no XML-output will be shown.
-\subsubsection{Adding a new Artifact for Artifactfactory}
+\subsubsection{Adding a new Artifact for Artifact-factory}
-The next Step is to define the Artifact itself.
+The next step is to define the artifact itself.
-For this it is necessary to add an XML-Fragment into the Section /artifacts of
+For this it is necessary to add an XML-fragment into the section /artifacts of
-the main Configuration-File /conf/conf.xml
+the main configurationfile /conf/conf.xml
 \begin{lstlisting}
 <artifact name='fis\_NEWFISNAME'>
 <products>
 ...
 </products>
 </artifact>
 \end{lstlisting}
-In this XML- Fragment it is also required to replace 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.
+with the name which was used to configure the artifact-factory.
-Now the ArtifactServer can handle an additional FIS without any Products yet.
+Now the artifact-server can handle an additional FIS without any products yet.
-To prevent needless Configuration-Work it is useful way to clone an Artifact
+To prevent needless configuration-work it is useful way to clone an artifact
-which handle the same Kind of work as the new FIS.
+which handle the same kind of work as the new FIS.
 \paragraph{Example}
-Now we will configure an Artifact to the FIS justanewfis.
+Now we will configure an artifact to the FIS justanewfis.
-For this we have to add the following XML-Fragment to the File conf/conf.xml
+For this we have to add the following XML-fragment to the file conf/conf.xml
-in Section /artifact-database/artifacts:
+in section /artifact-database/artifacts:
 \begin{lstlisting}
 <artifact name='fis\_justanewfis'>
 <products>
 </products>
 </artifact>
 \end{lstlisting}
-Restart the Artifact-Database:
+Restart the artifact-database:
 \begin{lstlisting}
 /etc/init.d/artifactdb restart
 \end{lstlisting}
-Now we should be able to choose the Artifact.
+Now we should be able to choose the artifact.
 The Listbox with products will be empty.
 \begin{lstlisting}
 curl -d "@sample-documents/create-artifact.xml"  http://localhost:8181/create | xmllint --format -
 \end{lstlisting}
 \subsubsection{Adding removing Products to the specific Artifact}
-Now it is Time to configure the different Products which the FIS should be able
+Now it is time to configure the different products which the FIS should be able
 to provide.
-To do this it is necessary to Copy the XML-Fragments of the products into the
+To do this it is necessary to copy the XML-fragments of the products into the
-XML-Element <products> of the previously integrated Artifact.
+XML-element <products> of the previously integrated artifact.
 \begin{lstlisting}
 <artifact name='fis\_NEWFISNAME'>
 <products>
 <product name= "timeSeries">
 <artifact-factory name="timeSeries"
-description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
+description="Artifactfactory for instantiating the artifact for TimeSeries on TimeSeriesPoints"
 ttl="300000"
 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
 de.intevation.gnv.artifacts.GNVArtifactFactory
 </artifact-factory>
 <parameters>
 value="fis\_NEWFISNAME"/>
 </parameters>
 </product>
 <product name= "verticalProfile">
 <artifact-factory name="verticalProfile"
-description="Artiefactfactory for Instantiating the Artifact for Verticalprofiles on TimeSeriesPoints"
+description="Artifactfactory for instantiating the artifact for Verticalprofiles on TimeSeriesPoints"
 ttl="300000"
 artifact="de.intevation.gnv.profile.vertical.VerticalProfileArtifact">
 de.intevation.gnv.artifacts.GNVArtifactFactory
 </artifact-factory>
 <parameters>
 </product>
 </products>
 </artifact>
 \end{lstlisting}
-In this XML-Fragment you have to replace the placeholders NEWFISNAME as before
+In this XML-fragment you have to replace the placeholders NEWFISNAME as before
-and VALUEOFSOURCEID with the value for the new FIS as defined in the Table
+and VALUEOFSOURCEID with the value for the new FIS as defined in the table
 MEDIAN.SOURCEINFO.
 \paragraph{Example}
-Now we will add a Product to the new FIS.
+Now we will add a product to the new FIS.
-To let the Products work we will choose a Product which
+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"
+description="Artifactfactory for instantiating the artifact for TimeSeries on TimeSeriesPoints"
 ttl="300000"
 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
 de.intevation.gnv.artifacts.GNVArtifactFactory
 </artifact-factory>
 <parameters>
 value="fis\_justanewfis"/>
 </parameters>
 </product>
 \end{lstlisting}
-Restart the Artifact-Database:
+Restart the artifact-database:
 \begin{lstlisting}
 /etc/init.d/artifactdb restart
 \end{lstlisting}
 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 the FIS justanewfis.
+the product timeSeries should be available for the FIS justanewfis.
-Now we should be able to choose the Product.
+Now we should be able to choose the product.
-This Product should work and you should be able to generate even the defined
+This product should work and you should be able to generate even the defined
-Outputformats.
+outputformats.
 \subsection{Adding a new Product}
-To add a new Product to the System it is necessary that the required
+To add a new product to the system it is necessary that the required
-Artifact representation 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.
+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
+All products are configured in separate files that will be included into the
-main configuration using Xlink-References.
+main configuration using Xlink-references.
-First Step is to create a new File in the Folder products and there in the
+First step is to create a new file in the folder products and there in the
-sub-folder 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
+Then you have tor reference this file in the file /conf/conf.xml in the section
-/artifacts using the following XML-Fragment.
+/artifacts using the following XML-fragment.
 \begin{lstlisting}
 <artifact name="timeSeries"
 xmlns:xlink="http://www.w3.org/1999/xlink"
 xlink:href="${artifacts.config.dir}/products/PATHTOFILE" />
 \end{lstlisting}
-The placeholder PATHTOFILE has to be replaced with the relative Path and the
+The placeholder PATHTOFILE has to be replaced with the relative path and the
-Name of the File starting in the Folder products.
+name of the file starting in the folder products.
 Then it is possible to add the product to a FIS as explained in the next section.
-Please note that the defined Name of the ArtifactFactory has to match to the
+Please note that the defined name of the artifact-factory has to match to the
-Name of the added Products which is also designed as an Artifact.
+name of the added products which is also designed as an artifact.
 \subsection{Adding a additional Product to a FIS}
-To add a additional Product to a FIS you only have to add the XML-Fragment which
+To add a additional product to a FIS you only have to add the XML-fragment which
-represents the product to the Artifact-configuration of the FIS in Section
+represents the product to the artifact-configuration of the FIS in section
 /artifacts/artifact/products.
 \begin{lstlisting}
 <product name= "timeSeries">
 <artifact-factory name="timeSeries"
-description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
+description="Artifactfactory for instantiating the artifact for TimeSeries on TimeSeriesPoints"
 ttl="300000"
 artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
 de.intevation.gnv.artifacts.GNVArtifactFactory
 </artifact-factory>
 <parameters>

Mercurial > dive4elements > gnv-client

comparison doc/config-manual/model_of_transitions.tex @ 940:14df4bcabc3c