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

comparison doc/config-manual/model_of_transitions.tex @ 941:7a8f9eb9fb04

Do some Documentstyling. Added Typewriter-Style to mark XML-Elements and other technical Items. doc/trunk@1084 c6561f87-3c4e-4783-a992-168aeb5c3f6f

author	Tim Englich <tim.englich@intevation.de>
date	Mon, 10 May 2010 12:53:17 +0000
parents	14df4bcabc3c
children	c53a39cb7809

comparison

equal deleted inserted replaced

-:14df4bcabc3c
+:7a8f9eb9fb04
 \end{enumerate}
 %% 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 +
+Main entry point for the configuration is the file {\tt conf/conf.xml }
 defining the list of FIS and the according products based on the different
 datamodels in the datawarehouse. The provided datamodels are:
 \begin{enumerate}
 \item ESRI ArcMarineBSH with following subtypes
 \item ESRI ArcS57,
 \item CONTIS
 \end{enumerate}
 Each product configuration consists of a datamodel specific configuration
-organized in a product specific folder in \verb+ conf/products+ \footnote{The
+organized in a product specific folder in {\tt conf/products} \footnote{The
-special case of a "Horizontales Schnittprofil" is configured in
+special case of a {\tt Horizontales Schnittprofil} is configured in
-conf/horizontalprofile/conf\_mesh\_cross.xml }. The directory layout looks
+{\tt conf/horizontalprofile/conf\_mesh\_cross.xml} }. The directory layout looks
 like this:
 \begin{verbatim}
 products/
 |-- horizontalcrosssection
 `-- conf_timeseriespoint.xml
 \end{verbatim}
 The subtypes of the ArcMarineBSH based datamodel are configured in the files below:
 \begin{itemize}
-\item TimeSeriesPoints: conf\_timeseriespoint.xml
+\item TimeSeriesPoints: {\tt conf\_timeseriespoint.xml}
-\item Mesh: conf\_mesh.xml
+\item Mesh: {\tt conf\_mesh.xml}
-\item InstantaneousPoints: conf\_instantaneouspoint.xml
+\item InstantaneousPoints: {\tt 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 definition of states, transitions and
 outputs reference the actual SQL-statements via an identifier. The SQL-statements
-are gathered in the file \verb+conf/queries.properties+.
+are gathered in the file {\tt conf/queries.properties}.
 \subsection{Explaining the background of the XML configuration}
 It is possible to configure the GNV in many ways.
 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 artifact-factories
+\item Configuration of the list of FIS via {\tt artifact-factories}
-\item Configuration of main artifacts which will be instantiated if an
+\item Configuration of main {\tt artifacts} which will be instantiated if an
-artifact-factory was called.
+{\tt artifact-factory} was called.
-\item Configuration of the different artifacts which provides products which can be
+\item Configuration of the different {\tt 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 artifact-factory.
+The point of entry into the system is to configure an {\tt artifact-factory}.
-Each artifact-factory represents one FIS.
+Each {\tt artifact-factory} represents one FIS.
-It is possible to configure several artifact-factories.
+It is possible to configure several {\tt artifact-factories}.
-The artifact-factories will be configured in the section
+The {\tt artifact-factories} will be configured in the section
-/artifact-database/artifact-factories of the configurationfile.
+{\tt /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 {\tt artifact-factory} are configurable.
 \begin{itemize}
-\item name: The name of the artifact. Must be unique in one artifact-server
+\item {\tt name}: The name of the {\tt artifact}. Must be unique in one {\tt artifact-server}
-\item description: Short description which job the artifact-factory has to do.
+\item {\tt description}: Short description which job the {\tt artifact-factory} has to do.
-\item  ttl: The time to live: The time using milliseconds an artifact, created using this
+\item {\tt ttl}: The time to live: The time using milliseconds an {\tt artifact}, created using this
 factory, can live without any user-interaction.
-\item artifact: The name of the class of the artifact which should be created.
+\item {\tt artifact}: The name of the class of the {\tt artifact} which should be created.
 \end{itemize}
 The next listing shows the dependencies between the FIS and the name
-of the artifact-factory which belongs to it.
+of the {\tt artifact-factory} which belongs to it.
 \begin{itemize}
-\item Marnet: fis\_marnet
+\item Marnet: {\tt fis\_marnet}
-\item IMIS: fis\_imis
+\item IMIS: {\tt fis\_imis}
-\item STAUN: fis\_staun
+\item STAUN: {\tt fis\_staun}
-\item Modeldata fis\_modeldata
+\item Modeldata {\tt fis\_modeldata}
-\item Iceclimatology: fis\_eisklimatologie
+\item Iceclimatology: {\tt fis\_eisklimatologie}
-\item Ice Station Report: fis\_icestations
+\item Ice Station Report: {\tt fis\_icestations}
-\item SST: fis\_sst
+\item SST: {\tt fis\_sst}
-\item Delphin: fis\_delphin
+\item Delphin: {\tt fis\_delphin}
-\item Thermosalinograph: fis\_thermosalinograph
+\item Thermosalinograph: {\tt fis\_thermosalinograph}
-\item Chemusurvey: fis\_chemusurvey
+\item Chemusurvey: {\tt fis\_chemusurvey}
-\item GTS: fis\_gts
+\item GTS: {\tt fis\_gts}
-\item CTD: fis\_bsh\_ctd
+\item CTD: {\tt fis\_bsh\_ctd}
-\item XBT: fis\_bsh\_xbt
+\item XBT: {\tt fis\_bsh\_xbt}
-\item SeaCat: fis\_seacat
+\item SeaCat: {\tt fis\_seacat}
-\item Sea State: fis\_seastate
+\item Sea State: {\tt fis\_seastate}
-\item Current Meter: fis\_currentmeter
+\item Current Meter: {\tt fis\_currentmeter}
-\item Nauthis: fis\_nauthis
+\item Nauthis: {\tt fis\_nauthis}
-\item Contis: fis\_contis
+\item Contis: {\tt fis\_contis}
-\item Marine Features: fis\_marinefeatures
+\item Marine Features: {\tt 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 {\tt artifact-factory} it is necessary to configure one {\tt artifact} which will be
 created using the factory.
-This artifact is the representation of the specific FIS.
+This {\tt artifact} is the representation of the specific 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 {\tt artifacts} are configured in the section {\tt /artifact-database/artifacts} of
 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 artifact-factory.
+The key is to use the same name for the {\tt artifact} as used for the {\tt artifact-factory}.
 The name has to be unique.
-In the section /artifact/products it is possible to define several products as
+In the section {\tt /artifact/products} it is possible to define several products as
 explained in the next section.
 \paragraph{Products to an FIS}
 One FIS can provide several products.
 To do this it is required to configure them as shown below in the section
-/artifact/products
+{\tt /artifact/products}
 \begin{lstlisting}
 <product name= "timeSeries">
 <artifact-factory name="timeSeries"
 description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"
 value="fis\_marnet"/>
 </parameters>
 </product>
 \end{lstlisting}
-Each product is also represented by an artifact. To create this artifact we have to
+Each {\tt product} is also represented by an {\tt artifact}. To create this {\tt artifact} we have to
-use an artifact-factory which is configured in each product
+use an {\tt artifact-factory} which is configured in each product
-(/product/artifact-factory).
+({\tt /product/artifact-factory}).
-Each product can have several parameters /product/parameters/parameters.
+Each product can have several parameters ({\tt /product/parameters/parameters}).
-The parameter named sourceid and fisname are required parameters.
+The {\tt parameter} named {\tt sourceid} and {\tt fisname} are required parameters.
-The parameter fisname contains the key to the name of the FIS. The key must be
+The parameter {\tt 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 {\tt sourceid} contains the key to identify the FIS in the
-datawarehouse. (MEDIAN.SOURCEINFO)
+datawarehouse. ({\tt 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 {\tt products} of the different FIS are also modeled as artifact-objects.
 The different products which are currently available are stored in separate
-files in the folder project.
+files in the folder {\tt project}.
 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
+required to model a new diagram is represented using a {\tt state} in the
 configurationfile.
-To move between those states it is required to model transitions which define
+To move between those {\tt states} it is required to model {\tt transitions} which define
 between which states it is possible to move and which conditions must be
 fulfilled.
-The last step is called output-state. This state is responsible to generate the
+The last step is called {\tt 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 ({\tt Diagram,
-CSV, ODV, WMS,...).
+CSV, ODV, WMS,..}.).
 \paragraph{States}
-A state is one step which is required to fetch the data for generating e.g. an
+A {\tt state} is one step which is required to fetch the data for generating e.g. an
 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 state are configurable.
+At this moment the following attributes of an {\tt state} are configurable.
 \begin{itemize}
-\item id: The name of the artifact. Must be unique in one artifact-server
+\item {\tt id}: The name of the artifact. Must be unique in one artifact-server
-\item description: Short description which job the artifact-factory has to do.
+\item {\tt 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 {\tt 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
 conf/queries.properties
-\item dataname: The id of the data which will be displayed in this state.
+\item {\tt 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 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 {\tt data-multiselect}: {\tt true} it is possible to select 1 or more items.
-false it is possible to select only one item.
+{\tt false} it is possible to select only one item.
-\item inputvalues: The values which can be "feed" to this state and which
+\item {\tt 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}
-At section /state/inputvalues it is possible to add definitions for inputvalues.
+At section {\tt /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 {\tt state}.
 \begin{itemize}
 \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
 <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 {\tt 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
+\item {\tt 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.
 Coordinate is a format which accepts geographical coordinates in
 the following Syntax: 56n30 6e20
 AttributeName marks a stringvalue which will be used in
 SQL-statement without surrounding with "'" in the statement.
 Usage is e.g. for determining the Axis (i or j) in the workflow
 of Horizontalprofiles.
-\item multiselect: true if more than on value can be feed or put into the SQL-statement.
+\item {\tt 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:
+\item {\tt 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 statement,
 2 or more: Value will be put as often as configured
 into the SQL-statement (this is useful if
 inner-selects are used)
 ORDER BY P.GERMANNAME
 \end{lstlisting}
 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
+which where feed by choosing this FIS ({\tt fisname}) and the Station
-(featureid: Arkona Basin Buoy ):
+({\tt featureid}: Arkona Basin Buoy ):
 \begin{itemize}
-\item featureid: 100011 (Marnet ==> Arkona Basin Buoy)
+\item {\tt featureid}: 100011 (Marnet ==> Arkona Basin Buoy)
-\item fisname: fis\_marnet
+\item {\tt fisname}: fis\_marnet
-\item parameterid: not set because it's the value that should be
+\item {\tt parameterid}: not set because it's the value that should be
 chosen in this state.
 \end{itemize}
 \begin{lstlisting}
 SELECT DISTINCT
 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 {\tt featureid} will be inserted into the query because
-the attribute usedinquery is set to "1".
+the attribute {\tt usedinquery} is set to "1".
-The values of the inputvalues fisname and parameterid will be
+The values of the inputvalues {\tt fisname} and {\tt parameterid} will be
-excluded because the attribute usedinquery is set to "0"
+excluded because the attribute {\tt usedinquery} is set to "0"
-If the attribute usedinquery of the inputvalue featureid is set to "2"
+If the attribute {\tt usedinquery} of the inputvalue {\tt featureid} is set to "2"
 this might happen.
 \begin{lstlisting}
 <inputvalues>
 <inputvalue name="featureid" type="Integer" multiselect="false" usedinquery="2"/>
 <inputvalue name="measurementid" type="Integer" multiselect="true" usedinquery="0"/>
 </inputvalues>
 \end{lstlisting}
 \begin{itemize}
-\item featureid: 100011 (Marnet ==> Arkona Basin Buoy)
+\item {\tt featureid}: 100011 (Marnet ==> Arkona Basin Buoy)
-\item fisname: fis\_marnet
+\item {\tt fisname}: fis\_marnet
-\item parameterid: 2 (Salzgehalt [pSal])
+\item {\tt parameterid}: 2 (Salzgehalt [pSal])
-\item measurementid: not set because it's the value that should be
+\item {\tt measurementid}: not set because it's the value that should be
 chosen in this state.
 \end{itemize}
 \begin{lstlisting}
 SELECT DISTINCT
 \paragraph{Transitions}
 To move between two states it is necessary to configure dependencies between
 the different states.
-This dependencies are called transitions.
+This dependencies are called {\tt transitions}.
-There are different kinds of transitions which can be used.
+There are different kinds of {\tt transitions} which can be used.
 \begin{itemize}
 \item Transitions which only link two states
 \item Transition which link two states with a additional condition.
 (e.g. If a region was selected in the Regionfilter or not )
 \end{itemize}
 <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 {\tt from}: The {\tt id} of the {\tt state} which you have to come from
-\item to:   The id of the state which can be reached.
+\item {\tt to}:   The {\tt id} of the {\tt state} which can be reached.
-\item condition: The condition which have to be fulfilled.
+\item {\tt 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 {\tt EQUAL} and {\tt NOTEQUAL} are supported as
-ValueCompareTransition.
+{\tt condition} for an {\tt ValueCompare\-Transition}.
 \paragraph{Outputstate}
-The outputstate is an special state which was created to define
+The {\tt outputstate} is an special {\tt 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.
+An {\tt outputstate} is handled as an {\tt 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 {\tt outputstates}. Each one is designed to create
 the output for one special product.
 \begin{itemize}
-\item TimeSeries: TimeSeriesOutputState
+\item TimeSeries: {\tt TimeSeriesOutputState}
-\item Horizontalprofile: HorizontalProfileOutputState
+\item Horizontalprofile: {\tt HorizontalProfileOutputState}
-\item Horizontalprofile on Meshes: HorizontalProfileMeshOutputState
+\item Horizontalprofile on Meshes: {\tt HorizontalProfileMeshOutputState}
-\item Verticalcrosssection:VerticalCrossSectionOutputState
+\item Verticalcrosssection: {\tt VerticalCrossSectionOutputState}
-\item Verticalprofiles: VerticalProfileOutputState
+\item Verticalprofiles: {\tt VerticalProfileOutputState}
-\item Horizontalcrosssections: HorizontalCrossSectionMeshOutputState
+\item Horizontalcrosssections: {\tt HorizontalCrossSectionMeshOutputState}
-\item Layer: LayerOutputState
+\item Layer: {\tt LayerOutputState}
 \end{itemize}
-All these outputstates are implemented in package de.intevation.gnv.state
+All these outputstates are implemented in {\tt package de.intevation.gnv.state}
-and its subpackages.
+and its {\tt sub\-packages}.
-You have to put the fullqualified name of the outputstate to the attribute state
+You have to put the fullqualified name of the {\tt outputstate} to the attribute
-as shown below.
+{\tt state} as shown below.
-You can configure an outputstate as shown below:
+You can configure an {\tt 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 {\tt /state/outputsModes} it is possible to add one ore more
-to one state as shown in the next paragraph.
+{\tt outputmodes} 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 {\tt outputmodes} in one {\tt outputstate}.
 Inserting or deleting the configuration of an special
-outputmode will cause that the pending item will be shown or hidden
+{\tt outputmode} will cause that the pending item will be shown or hidden
-in the GUI.
+in the {\tt 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 {\tt outputmodes} are supported:
 \begin{itemize}
-\item chart
+\item {\tt chart}
-\item histogram
+\item {\tt histogram}
-\item csv
+\item {\tt csv}
-\item odv
+\item {\tt odv}
-\item statistics
+\item {\tt statistics}
-\item wms
+\item {\tt wms}
-\item shapefile
+\item {\tt shapefile}
 \end{itemize}
-The following example shows how to configure an outputmode chart:
+The following example shows how to configure an {\tt 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 {\tt name}: The name of the mode. This must not be changed because it
-by the program.
+is used by the program.
-\item description: a short description of this outputmode.
+\item {\tt description}: a short description of this outputmode.
-\item parameters: one ore more parameters which will be shown in the GUI e.g.
+\item {\tt parameters}: one ore more parameters which will be shown in the
-for changing the size of an chart.
+GUI e.g. for changing the size of an chart.
-\item exportModes: one or more formats which can be served.
+\item {\tt 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
-new FIS into the artifact-server.  This will be done using the configuration for
+new FIS into the {\tt 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 {\tt 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 {\tt artifact-server} you will
 have to restart it.
 \subsubsection{Adding a new Artifact-factory}
-First step is to add a new artifact-factory to the configuration conf/conf.xml
+First step is to add a new {\tt artifact-factory} to the configuration conf/conf.xml
 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'
 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 {\tt NEWFISNAME}
-unique short name for the new FIS.
+with a unique short name for the new FIS.
 \paragraph{Example}
 This example shows how to add an FIS and which effects it took to the
 REST-Server.
-At first we add the following artifact-factory into the file conf/conf.xml
+At first we add the following {\tt artifact-factory} into the file
-in section /artifact-database/artifact-factories which add a new
+{\tt conf/conf.xml} in section {\tt /artifact-database/artifact-factories}
-FIS called justanewfis to the server:
+which add a new FIS called {\tt 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 {\tt 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 artifact-factory will be found in the generated
+If the FIS was added the new {\tt artifact-factory} will be found in the generated
 XML-output and it will be shown.
 Otherwise no XML-output will be shown.
 \subsubsection{Adding a new Artifact for Artifact-factory}
 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
-the main configurationfile /conf/conf.xml
+{\tt /artifacts} of the main configurationfile {\tt /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 {\tt NEWFISNAME}
-with the name which was used to configure the artifact-factory.
+with the name which was used to configure the {\tt artifact-factory}.
-Now the artifact-server can handle an additional FIS without any products yet.
+Now the {\tt artifact-server} 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 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
-in section /artifact-database/artifacts:
+{\tt conf/conf.xml} in section {\tt /artifact-database/artifacts}:
 \begin{lstlisting}
 <artifact name='fis\_justanewfis'>
 <products>
 </products>
 \subsubsection{Adding removing Products to the specific Artifact}
 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
-XML-element <products> of the previously integrated artifact.
+XML-element {\tt products} of the previously integrated artifact.
 \begin{lstlisting}
 <artifact name='fis\_NEWFISNAME'>
 <products>
 <product name= "timeSeries">
 <artifact-factory name="timeSeries"
 </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 {\tt NEWFISNAME}
-and VALUEOFSOURCEID with the value for the new FIS as defined in the table
+as before and {\tt VALUEOFSOURCEID} with the value for the new FIS as defined
-MEDIAN.SOURCEINFO.
+in the table {\tt MEDIAN.SOURCEINFO}.
 \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).
 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 {\tt timeSeries} should be available for the FIS {\tt 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.
 \subsection{Adding a new Product}
 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 {\tt 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
 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 {\tt products} and there in the
-sub-folder where the product belongs to (timeseries,verticalprofile,
+sub-folder where the product belongs to ({\tt timeseries,verticalprofile,
-horizontalprofile,horizontalcrosssection,layer,...)
+horizontalprofile,horizontal\-crosssection,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 {\tt /conf/conf.xml} in the
-/artifacts using the following XML-fragment.
+section {\tt/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 {\tt PATHTOFILE} has to be replaced with the relative path and
-name of the file starting in the folder products.
+the 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 artifact-factory has to match to the
+Please note that the defined name of the {\tt artifact-factory} has to match to the
 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
 represents the product to the artifact-configuration of the FIS in section
-/artifacts/artifact/products.
+{\tt /artifacts/artifact/products}.
 \begin{lstlisting}
 <product name= "timeSeries">
 <artifact-factory name="timeSeries"
 description="Artifactfactory for instantiating the artifact for TimeSeries on TimeSeriesPoints"

Mercurial > dive4elements > gnv-client

comparison doc/config-manual/model_of_transitions.tex @ 941:7a8f9eb9fb04