comparison doc/config-manual/general_settings.tex @ 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
comparison
equal deleted inserted replaced
936:3af26af71c62 937:052b8bba4f41
29 |--cleaner 29 |--cleaner
30 `--database 30 `--database
31 \end{verbatim} 31 \end{verbatim}
32 32
33 \subsubsection{artifact-factories} 33 \subsubsection{artifact-factories}
34
35 These Section configures the Factories for Artifacts which can be used.
36 The meaning of artifact-factories are explained in Section TODO: LINK to Model of Transition
37
34 \subsubsection{artifacts} 38 \subsubsection{artifacts}
39
40 These Section configures the Artifacts which could be reached using the Artifact-Server.
41 The meaning of artifacts are explained in Section TODO: LINK to Model of Transition
42
35 \subsubsection{gnv} 43 \subsubsection{gnv}
44
45 This Section configures all GNV-specific settings of the Artifact-Server.
46 //TODO add paragraphs and explain the child-elements.
47
36 \subsubsection{mapserver} 48 \subsubsection{mapserver}
49
50 The Section Mapserver is introduced to be able to configure all Settings which
51 are required to setup the WMS-Export of the GNV-Artifacts.
52
53 It is possible to Configure the following settings:
54
55 \begin{itemize}
56 \item server: The URL the WMS of the GNV-Artifacts will be reached from
57 Clients.
58 \end{itemize}
59
37 \subsubsection{velocity} 60 \subsubsection{velocity}
61
62 Velocity is an Library which is used in this Project.
63 Velocity has it's own Logging, so that it is necessary to configure
64 this to get Loginformations.
65
66 \begin{itemize}
67 \item logfile: The absolute Path to the Logfile of Velocity.
68 \end{itemize}
69
38 \subsubsection{ehcache} 70 \subsubsection{ehcache}
71
72 The Ehcache is used to implement an Cache storing the Thematic-Data of the
73 different Sessions.
74
75 It is possible to configure this Cache in many ways. To realize this it is
76 possible to configure the following settings:
77
78 \begin{itemize}
79 \item configuration: The absolute Path to the Configuration-File.
80 It is possible to start with \$\{artifacts.config.dir\}
81 to reference the file from the Directory which includes
82 the Configuration
83 \end{itemize}
84
85
39 \subsubsection{geo-backend} 86 \subsubsection{geo-backend}
40 87
41 queries.properties 88 The geo-backend is an separate Module of this Project. It encapsulate the logic
42 arcsdeconnectionpool.properties 89 which is required to provide the Access to the Databasebackend.
43 SQL: 90 At this Time only the Access to the ArcSDE is implemented.
44 Clarify the special mechanism of the internal functions 91
45 ST\_ASTEXT(SHAPE) 92 To setup the geo-backend the following settings are required:
46 ST\_ASTEXT(RASTER) 93
94 \begin{itemize}
95 \item backend-configuration: The absolute Path to the File which contains the
96 properties to establish the Connection to the
97 Databasebackend.
98 \item query-configuration: The absolute Path to the File which contains all
99 SQL-Statements which are required to fetch the
100 Thematic-Data
101 \end{itemize}
102
103 Both Path can start with \$\{artifacts.config.dir\} to reference the file from
104 the Directory which includes the Configuration.
105 \paragraph{Backend-Configuration (arcsdeconnectionpool.properties)}
106
107 \paragraph{Query-configuration (queries.properties)}
108
109 This File contains Key-Value-Pairs to define SQL-Statements.
110 All Queries will be handle using the Prepared-Statement-Syntax using "?"
111 to define an Place where an dynamic Value should be placed into the Statement.
112
113 There is one special Implementation to support spatial access to the ArcSDE,
114 because the ArcSDE does not support the Access to spatial Objects using the
115 definition of the Simple Feature Specification for SQL of the OGC.
116
117 It was necessary to implement this mechanism to simulate the Access.
118
119 All Queries which contains the following Literals will be handle separate
120 using the ArcSDE-API.
121
122 \begin{itemize}
123 \item ST\_ASTEXT(SHAPE): Will return the Geometry as an WellKnowText (WKT)
124 \item ST\_ASTEXT(RASTER): Will return the Raster in an readable Way.
125 \item INTERSECTS(SHAPE,"?"): Will only return the Elements which Geometry
126 intersects the given Geometry ("?" will be
127 replace with an WKT)
128 \end{itemize}
47 129
48 \subsubsection{rest-server} 130 \subsubsection{rest-server}
49 \subsubsection{cleaner} 131 \subsubsection{cleaner}
50 \subsubsection{database} 132 \subsubsection{database}
51 133
53 \subsection{Set the Communicationport} 135 \subsection{Set the Communicationport}
54 \subsection{Logging} 136 \subsection{Logging}
55 \subsection{Configure ArtifactServer using Systemproperties} 137 \subsection{Configure ArtifactServer using Systemproperties}
56 \begin{itemize} 138 \begin{itemize}
57 \item artifact.database.dir The folder where the Configuration is located- 139 \item artifact.database.dir The folder where the Configuration is located-
58 \item query.executor.factory: The absoulte Classname which QueryExecutorfactory should be used 140 \item query.executor.factory: The absolute Classname which QueryExecutorfactory should be used
59 \begin{itemize} 141 \begin{itemize}
60 \item de.intevation.gnv.geobackend.base.query.QueryExecutorFactory : 142 \item de.intevation.gnv.geobackend.base.query.QueryExecutorFactory :
61 Standardfactory without any Addons. 143 Standardfactory without any Addons.
62 \item de.intevation.gnv.geobackend.base.query.CachingQueryExecutorFactory: 144 \item de.intevation.gnv.geobackend.base.query.CachingQueryExecutorFactory:
63 Factory with Cache for SQL-Query-Results 145 Factory with Cache for SQL-Query-Results

http://dive4elements.wald.intevation.org