1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
|
<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<!-- ********************************************************************
$Id: postgis_aggs_mm.xml.xsl 5082 2009-12-30 15:31:27Z robe $
********************************************************************
Copyright 2008, Regina Obe
License: BSD
Purpose: This is an xsl transform that generates index listing of aggregate functions and mm /sql compliant functions xml section from reference_new.xml to then
be processed by doc book
******************************************************************** -->
<xsl:output method="xml" indent="yes" encoding="utf-8" />
<!-- We deal only with the reference chapter -->
<xsl:template match="/">
<xsl:apply-templates select="/book/chapter[@id='reference']" />
</xsl:template>
<xsl:template match="chapter">
<chapter>
<title>PostGIS Special Functions Index</title>
<sect1 id="PostGIS_Aggregate_Functions">
<title>PostGIS Aggregate Functions</title>
<para>The functions given below are spatial aggregate functions provided with PostGIS that can be used just like any other sql aggregate function such as sum, average.</para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<!-- For each function prototype if it takes a geometry set then catalog it as an aggregate function -->
<xsl:for-each select="refsynopsisdiv/funcsynopsis/funcprototype">
<xsl:choose>
<xsl:when test="contains(paramdef/type,'geometry set')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refid" /></link> - <xsl:value-of select="$comment" /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</xsl:for-each>
</itemizedlist>
</sect1>
<sect1 id="PostGIS_SQLMM_Functions">
<title>PostGIS SQL-MM Compliant Functions</title>
<para>The functions given below are PostGIS functions that conform to the SQL/MM 3 standard</para>
<note>
<para>SQL-MM defines the default SRID of all geometry constructors as 0.
PostGIS uses a default SRID of -1.</para>
</note>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<!-- For each section if there is note that it implements SQL/MM catalog it -->
<xsl:for-each select="refsection">
<xsl:for-each select="para">
<xsl:choose>
<xsl:when test="contains(.,'implements the SQL/MM')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refid" /></link> - <xsl:value-of select="$comment" /> <xsl:value-of select="." /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</xsl:for-each>
</xsl:for-each>
</itemizedlist>
</sect1>
<sect1 id="PostGIS_GeographyFunctions">
<title>PostGIS Geography Support Functions</title>
<para>The functions and operators given below are PostGIS functions/operators that take as input or return as output a <link linkend="PostGIS_Geography">geography</link> data type object.</para>
<note><para>Functions with a (T) are not native geodetic functions, and use a ST_Transform call to and from geometry to do the operation. As a result, they may not behave as expected when going over dateline, poles,
and for large geometries or geometry pairs that cover more than one UTM zone. Basic tranform - (favoring UTM, Lambert Azimuthal (North/South), and falling back on mercator in worst case scenario)</para></note>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<xsl:variable name="refname">
<xsl:value-of select="refnamediv/refname" />
</xsl:variable>
<!-- If at least one proto function accepts or returns a geography -->
<xsl:choose>
<xsl:when test="contains(refsynopsisdiv/funcsynopsis,'geography') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'geography')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refname" /></link> - <xsl:value-of select="$comment" /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</itemizedlist>
</sect1>
<sect1 id="PostGIS_Geometry_DumpFunctions">
<title>PostGIS Geometry Dump Functions</title>
<para>The functions given below are PostGIS functions that take as input or return as output a set of or single <link linkend="geometry_dump">geometry_dump</link> data type object.</para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<xsl:variable name="refname">
<xsl:value-of select="refnamediv/refname" />
</xsl:variable>
<!-- If at least one proto function accepts or returns a geography -->
<xsl:choose>
<xsl:when test="contains(refsynopsisdiv/funcsynopsis,'geometry_dump') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'geometry_dump')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refname" /></link> - <xsl:value-of select="$comment" /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</itemizedlist>
</sect1>
<sect1 id="PostGIS_BoxFunctions">
<title>PostGIS Box Functions</title>
<para>The functions given below are PostGIS functions that take as input or return as output the box* family of PostGIS spatial types.
The box family of types consists of <link linkend="box2d">box2d</link>, <link linkend="box3d">box3d</link>, <link linkend="box3d_extent">box3d_extent</link> </para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<xsl:variable name="refname">
<xsl:value-of select="refnamediv/refname" />
</xsl:variable>
<!-- If at least one proto function accepts or returns a geography -->
<xsl:choose>
<xsl:when test="contains(refsynopsisdiv/funcsynopsis,'box') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'box')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refname" /></link> - <xsl:value-of select="$comment" /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</itemizedlist>
</sect1>
<sect1 id="PostGIS_3D_Functions">
<title>PostGIS Functions that support 3D</title>
<para>The functions given below are PostGIS functions that do not throw away the Z-Index.</para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<!-- For each section if there is note that it supports 3d catalog it -->
<xsl:for-each select="refsection">
<xsl:for-each select="para">
<xsl:choose>
<xsl:when test="contains(.,'This function supports 3d')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refid" /></link> - <xsl:value-of select="$comment" /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</xsl:for-each>
</xsl:for-each>
</itemizedlist>
</sect1>
<sect1 id="PostGIS_Curved_GeometryFunctions">
<title>PostGIS Curved Geometry Support Functions</title>
<para>The functions given below are PostGIS functions that can use CIRCULARSTRING, CURVEDPOLYGON, and other curved geometry types</para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<xsl:variable name="refname">
<xsl:value-of select="refnamediv/refname" />
</xsl:variable>
<!-- For each section if there is note that it implements Circular String catalog it -->
<xsl:for-each select="refsection">
<xsl:for-each select="para">
<xsl:choose>
<xsl:when test="contains(.,'supports Circular Strings')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refname" /></link> - <xsl:value-of select="$comment" /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</xsl:for-each>
</xsl:for-each>
</itemizedlist>
</sect1>
<sect1 id="PostGIS_TypeFunctionMatrix">
<xsl:variable name='matrix_checkmark'><![CDATA[<inlinemediaobject><imageobject><imagedata fileref='images/matrix_checkmark.png' /></imageobject></inlinemediaobject>]]></xsl:variable>
<xsl:variable name='matrix_transform'><![CDATA[<inlinemediaobject><imageobject><imagedata fileref='images/matrix_transform.png' /></imageobject></inlinemediaobject>]]></xsl:variable>
<xsl:variable name='matrix_autocast'><![CDATA[<inlinemediaobject><imageobject><imagedata fileref='images/matrix_autocast.png' /></imageobject></inlinemediaobject>]]></xsl:variable>
<title>PostGIS Function Support Matrix</title>
<para>Below is an alphabetical listing of spatial specific functions in PostGIS and the kinds of spatial
types they work with or OGC/SQL compliance they try to conform to.</para>
<para><itemizedlist>
<listitem>A <xsl:value-of select="$matrix_checkmark" disable-output-escaping="yes"/> means the function works with the type or subtype natively.</listitem>
<listitem>A <xsl:value-of select="$matrix_transform" disable-output-escaping="yes"/> means it works but with a transform cast built-in using cast to geometry, transform to a "best srid" spatial ref and then cast back. Results may not be as expected for large areas or areas at poles
and may accumulate floating point junk.</listitem>
<listitem>A <xsl:value-of select="$matrix_autocast" disable-output-escaping="yes"/> means the function works with the type because of a auto-cast to another such as to box3d rather than direct type support.</listitem>
</itemizedlist>
</para>
<para>
<informaltable frame='all'>
<tgroup cols='6' align='left' colsep='1' rowsep='1'>
<colspec colname='function' />
<colspec colname='geometry' align='center'/>
<colspec colname='geography' align='center'/>
<colspec colname='3D' align='center'/>
<colspec colname='Curves' align='center'/>
<colspec colname='SQLMM' align='center' />
<thead>
<row>
<entry>Function</entry>
<entry>geometry</entry>
<entry>geography</entry>
<entry>3D (2.5D)</entry>
<entry>Curves</entry>
<entry>SQL MM</entry>
</row>
</thead>
<tbody>
<!-- Exclude PostGIS types ,management functions, long transaction support, or exceptional functions from consideration -->
<!-- leaving out operators in an effor to try to fit on one page -->
<xsl:for-each select="sect1[not(@id='PostGIS_Types' or @id='Management_Functions' or @id='Long_Transactions_Support' or @id='Exceptional_Functions')]/refentry">
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<xsl:variable name="refname">
<xsl:value-of select="refnamediv/refname" />
</xsl:variable>
<row>
<!-- Display name of function and link to it -->
<entry><link linkend="{$refid}"><xsl:value-of select="$refname" /></link></entry>
<!-- If at least one proto function accepts or returns a geometry -->
<xsl:choose>
<!-- direct support -->
<xsl:when test="contains(refsynopsisdiv/funcsynopsis,'geometry') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'geometry')">
<entry><xsl:value-of select="$matrix_checkmark" disable-output-escaping="yes"/></entry>
</xsl:when>
<!-- support via autocast -->
<xsl:when test="contains(refsynopsisdiv/funcsynopsis,'box') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'box')">
<entry><xsl:value-of select="$matrix_autocast" disable-output-escaping="yes"/></entry>
</xsl:when>
<!-- no support -->
<xsl:otherwise>
<entry></entry>
</xsl:otherwise>
</xsl:choose>
<!-- If at least one proto function accepts or returns a geography -->
<xsl:choose>
<!-- Support via geometry transform hack -->
<xsl:when test="(contains(refsynopsisdiv/funcsynopsis,'geography') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'geography')) and contains($comment,'(T)')">
<entry><xsl:value-of select="$matrix_transform" disable-output-escaping="yes"/></entry>
</xsl:when>
<!-- direct support -->
<xsl:when test="contains(refsynopsisdiv/funcsynopsis,'geography') or contains(refsynopsisdiv/funcsynopsis/funcprototype/funcdef,'geography')">
<entry><xsl:value-of select="$matrix_checkmark" disable-output-escaping="yes"/></entry>
</xsl:when>
<!-- no support -->
<xsl:otherwise>
<entry></entry>
</xsl:otherwise>
</xsl:choose>
<!-- If at least one paragraph contains support 3d -->
<xsl:choose>
<!-- supports -->
<xsl:when test="contains(.,'This function supports 3d')">
<entry><xsl:value-of select="$matrix_checkmark" disable-output-escaping="yes"/></entry>
</xsl:when>
<!-- no support -->
<xsl:otherwise>
<entry></entry>
</xsl:otherwise>
</xsl:choose>
<!-- Support for Curve -->
<xsl:choose>
<!-- supports -->
<xsl:when test="contains(.,'supports Circular Strings')">
<entry><xsl:value-of select="$matrix_checkmark" disable-output-escaping="yes"/></entry>
</xsl:when>
<!-- no support -->
<xsl:otherwise>
<entry></entry>
</xsl:otherwise>
</xsl:choose>
<!-- SQL MM compliance -->
<xsl:choose>
<!-- supports -->
<xsl:when test="contains(.,'implements the SQL/MM')">
<entry><xsl:value-of select="$matrix_checkmark" disable-output-escaping="yes"/></entry>
</xsl:when>
<!-- no support -->
<xsl:otherwise>
<entry></entry>
</xsl:otherwise>
</xsl:choose>
</row>
</xsl:for-each>
</tbody>
</tgroup>
</informaltable>
</para>
</sect1>
<sect1 id="NewFunctions">
<title>New PostGIS Functions</title>
<sect2 id="NewFunctions_1_5">
<title>PostGIS Functions new, behavior changed, or enhanced in 1.5</title>
<para>The functions given below are PostGIS functions that were introduced or enhanced in this major release.</para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<xsl:variable name="refname">
<xsl:value-of select="refnamediv/refname" />
</xsl:variable>
<!-- For each section if there is note about availability in this version -->
<xsl:for-each select="refsection">
<xsl:for-each select="para">
<xsl:choose>
<xsl:when test="contains(.,'Availability: 1.5')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refname" /></link> - <xsl:value-of select="." /><xsl:text> </xsl:text> <xsl:value-of select="$comment" /> </listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</xsl:for-each>
</xsl:for-each>
</itemizedlist>
</sect2>
<sect2 id="NewFunctions_1_4">
<title>PostGIS Functions new, behavior changed, or enhanced in 1.4</title>
<para>The functions given below are PostGIS functions that were introduced or enhanced in the 1.4 release.</para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<!-- For each section if there is note about availability in this version -->
<xsl:for-each select="refsection">
<xsl:for-each select="para|note">
<xsl:choose>
<xsl:when test="contains(.,'Availability: 1.4')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refid" /></link> - <xsl:value-of select="$comment" /> <xsl:text> </xsl:text><xsl:value-of select="." /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</xsl:for-each>
</xsl:for-each>
</itemizedlist>
</sect2>
<sect2 id="NewFunctions_1_3">
<title>PostGIS Functions new in 1.3</title>
<para>The functions given below are PostGIS functions that were introduced in the 1.3 release.</para>
<itemizedlist>
<!-- Pull out the purpose section for each ref entry and strip whitespace and put in a variable to be tagged unto each function comment -->
<xsl:for-each select='sect1/refentry'>
<xsl:sort select="@id"/>
<xsl:variable name='comment'>
<xsl:value-of select="normalize-space(translate(translate(refnamediv/refpurpose,'
', ' '), '	', ' '))"/>
</xsl:variable>
<xsl:variable name="refid">
<xsl:value-of select="@id" />
</xsl:variable>
<!-- For each section if there is note about availability in this version -->
<xsl:for-each select="refsection">
<xsl:for-each select="para">
<xsl:choose>
<xsl:when test="contains(.,'Availability: 1.3')">
<listitem><link linkend="{$refid}"><xsl:value-of select="$refid" /></link> - <xsl:value-of select="$comment" /> <xsl:text> </xsl:text><xsl:value-of select="." /></listitem>
</xsl:when>
</xsl:choose>
</xsl:for-each>
</xsl:for-each>
</xsl:for-each>
</itemizedlist>
</sect2>
</sect1>
</chapter>
</xsl:template>
<!--macro to pull out function parameter names so we can provide a pretty arg list prefix for each function -->
<xsl:template name="listparams">
<xsl:param name="func" />
<xsl:for-each select="$func">
<xsl:if test="count(paramdef/parameter) > 0">args: </xsl:if>
<xsl:for-each select="paramdef">
<xsl:choose>
<xsl:when test="count(parameter) > 0">
<xsl:value-of select="parameter" />
</xsl:when>
</xsl:choose>
<xsl:if test="position()<last()"><xsl:text>, </xsl:text></xsl:if>
</xsl:for-each>
<xsl:if test="count(paramdef/parameter) > 0"> - </xsl:if>
</xsl:for-each>
</xsl:template>
</xsl:stylesheet>
|
