Mercurial > dive4elements > gnv-client
changeset 937:052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
doc/trunk@1078 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Tim Englich <tim.englich@intevation.de> |
---|---|
date | Fri, 07 May 2010 10:19:28 +0000 |
parents | 3af26af71c62 |
children | 2d84fc30ab58 |
files | doc/ChangeLog doc/config-manual/general_settings.tex |
diffstat | 2 files changed, 97 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog Fri May 07 09:36:24 2010 +0000 +++ b/doc/ChangeLog Fri May 07 10:19:28 2010 +0000 @@ -1,3 +1,11 @@ +2010-05-07 Tim Englich <tim@intevation.de> + + * general_settings.tex: + Document following Sections: + artifact-factories, artifacts, mapserver, velocity, ehcache, + geo-backend + Description of geo-backend/Backend-Configuration is missing. + 2010-05-07 Tim Englich <tim@intevation.de> * general_settings.tex:
--- a/doc/config-manual/general_settings.tex Fri May 07 09:36:24 2010 +0000 +++ b/doc/config-manual/general_settings.tex Fri May 07 10:19:28 2010 +0000 @@ -31,19 +31,101 @@ \end{verbatim} \subsubsection{artifact-factories} + +These Section configures the Factories for Artifacts which can be used. +The meaning of artifact-factories are explained in Section TODO: LINK to Model of Transition + \subsubsection{artifacts} + +These Section configures the Artifacts which could be reached using the Artifact-Server. +The meaning of artifacts are explained in Section TODO: LINK to Model of Transition + \subsubsection{gnv} + +This Section configures all GNV-specific settings of the Artifact-Server. +//TODO add paragraphs and explain the child-elements. + \subsubsection{mapserver} + +The Section Mapserver is introduced to be able to configure all Settings which +are required to setup the WMS-Export of the GNV-Artifacts. + +It is possible to Configure the following settings: + +\begin{itemize} + \item server: The URL the WMS of the GNV-Artifacts will be reached from + Clients. +\end{itemize} + \subsubsection{velocity} + +Velocity is an Library which is used in this Project. +Velocity has it's own Logging, so that it is necessary to configure +this to get Loginformations. + +\begin{itemize} + \item logfile: The absolute Path to the Logfile of Velocity. +\end{itemize} + \subsubsection{ehcache} + +The Ehcache is used to implement an Cache storing the Thematic-Data of the +different Sessions. + +It is possible to configure this Cache in many ways. To realize this it is +possible to configure the following settings: + +\begin{itemize} + \item configuration: The absolute Path to the Configuration-File. + It is possible to start with \$\{artifacts.config.dir\} + to reference the file from the Directory which includes + the Configuration +\end{itemize} + + \subsubsection{geo-backend} -queries.properties -arcsdeconnectionpool.properties -SQL: - Clarify the special mechanism of the internal functions - ST\_ASTEXT(SHAPE) - ST\_ASTEXT(RASTER) +The geo-backend is an separate Module of this Project. It encapsulate the logic +which is required to provide the Access to the Databasebackend. +At this Time only the Access to the ArcSDE is implemented. + +To setup the geo-backend the following settings are required: + +\begin{itemize} + \item backend-configuration: The absolute Path to the File which contains the + properties to establish the Connection to the + Databasebackend. + \item query-configuration: The absolute Path to the File which contains all + SQL-Statements which are required to fetch the + Thematic-Data +\end{itemize} + +Both Path can start with \$\{artifacts.config.dir\} to reference the file from +the Directory which includes the Configuration. +\paragraph{Backend-Configuration (arcsdeconnectionpool.properties)} + +\paragraph{Query-configuration (queries.properties)} + +This File contains Key-Value-Pairs to define SQL-Statements. +All Queries will be handle using the Prepared-Statement-Syntax using "?" +to define an Place where an dynamic Value should be placed into the Statement. + +There is one special Implementation to support spatial access to the ArcSDE, +because the ArcSDE does not support the Access to spatial Objects using the +definition of the Simple Feature Specification for SQL of the OGC. + +It was necessary to implement this mechanism to simulate the Access. + +All Queries which contains the following Literals will be handle separate +using the ArcSDE-API. + +\begin{itemize} + \item ST\_ASTEXT(SHAPE): Will return the Geometry as an WellKnowText (WKT) + \item ST\_ASTEXT(RASTER): Will return the Raster in an readable Way. + \item INTERSECTS(SHAPE,"?"): Will only return the Elements which Geometry + intersects the given Geometry ("?" will be + replace with an WKT) +\end{itemize} \subsubsection{rest-server} \subsubsection{cleaner} @@ -55,7 +137,7 @@ \subsection{Configure ArtifactServer using Systemproperties} \begin{itemize} \item artifact.database.dir The folder where the Configuration is located- - \item query.executor.factory: The absoulte Classname which QueryExecutorfactory should be used + \item query.executor.factory: The absolute Classname which QueryExecutorfactory should be used \begin{itemize} \item de.intevation.gnv.geobackend.base.query.QueryExecutorFactory : Standardfactory without any Addons.