[postgis-commits] svn - r2867 - trunk/doc
postgis-commits at postgis.refractions.net
postgis-commits at postgis.refractions.net
Thu Jul 17 05:14:55 PDT 2008
Author: robe
Date: 2008-07-17 05:14:54 -0700 (Thu, 17 Jul 2008)
New Revision: 2867
Modified:
trunk/doc/reference.xml
trunk/doc/reference_new.xml
Log:
Move ST_BuildArea expand on definition, provide example, Move ST_BdPolyFromText and ST_BdMPolyFromText
Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml 2008-07-17 11:20:11 UTC (rev 2866)
+++ trunk/doc/reference.xml 2008-07-17 12:14:54 UTC (rev 2867)
@@ -1000,48 +1000,8 @@
<para>throws an error if WKB is not a GEOMETRYCOLLECTION</para>
</listitem>
</varlistentry>
+ </variablelist>
- <varlistentry id="BdPolyFromText">
- <term>ST_BdPolyFromText(text WKT, integer SRID)</term>
-
- <listitem>
- <para>Construct a Polygon given an arbitrary collection of closed
- linestrings as a MultiLineString text representation.</para>
-
- <para>Throws an error if WKT is not a MULTILINESTRING. Throws an
- error if output is a MULTIPOLYGON; use <link
- linkend="BdMPolyFromText">BdMPolyFromText</link> in that case, or
- see <link linkend="BuildArea">BuildArea()</link> for a
- postgis-specific approach.</para>
-
- <para>OGC SFSQL 1.1 - 3.2.6.2</para>
-
- <para>Availability: 1.1.0 - requires GEOS >= 2.1.0.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry id="BdMPolyFromText">
- <term>ST_BdMPolyFromText(text WKT, integer SRID)</term>
-
- <listitem>
- <para>Construct a MultiPolygon given an arbitrary collection of
- closed linestrings as a MultiLineString text
- representation.</para>
-
- <para>Throws an error if WKT is not a MULTILINESTRING. Forces
- MULTIPOLYGON output even when result is really only composed by a
- single POLYGON; use <link
- linkend="BdPolyFromText">BdPolyFromText</link> if you're sure a
- single POLYGON will result from operation, or see <link
- linkend="BuildArea">BuildArea()</link> for a postgis-specific
- approach.</para>
-
- <para>OGC SFSQL 1.1 - 3.2.6.2</para>
-
- <para>Availability: 1.1.0 - requires GEOS >= 2.1.0.</para>
- </listitem>
- </varlistentry>
- </variablelist>
</sect2>
</sect1>
@@ -1729,24 +1689,6 @@
</listitem>
</varlistentry>
- <varlistentry id="BuildArea">
- <term>ST_BuildArea(geometry)</term>
-
- <listitem>
- <para>Creates an areal geometry formed by the constituent linework
- of given geometry. The return type can be a Polygon or
- MultiPolygon, depending on input. If the input lineworks do not
- form polygons NULL is returned.</para>
-
- <para>See also <link
- linkend="BdPolyFromText">BdPolyFromText</link> and <link
- linkend="BdMPolyFromText">BdMPolyFromText</link> - wrappers to
- this function with standard OGC interface.</para>
-
- <para>Availability: 1.1.0 - requires GEOS >= 2.1.0.</para>
- </listitem>
- </varlistentry>
-
<varlistentry>
<term>ST_Polygonize(geometry set)</term>
Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml 2008-07-17 11:20:11 UTC (rev 2866)
+++ trunk/doc/reference_new.xml 2008-07-17 12:14:54 UTC (rev 2867)
@@ -349,7 +349,180 @@
</sect1>
<sect1>
- <title>Geometry Constructors</title>
+ <title>Geometry Constructors</title>
+ <refentry id="ST_BdPolyFromText">
+ <refnamediv>
+ <refname>ST_BdPolyFromText</refname>
+
+ <refpurpose>Construct a Polygon given an arbitrary collection of closed
+ linestrings as a MultiLineString Well-Known text representation.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>geometery <function>ST_BdPolyFromText</function></funcdef>
+ <paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Construct a Polygon given an arbitrary collection of closed
+ linestrings as a MultiLineString Well-Known text representation.</para>
+
+ <!-- optionally mention that this function uses indexes if appropriate -->
+ <note>
+ <para>Throws an error if WKT is not a MULTILINESTRING. Throws an
+ error if output is a MULTIPOLYGON; use ST_BdMPolyFromText in that case, or
+ see ST_BuildArea() for a
+ postgis-specific approach.</para>
+ </note>
+
+ <!-- Optionally mention OpenGIS compliancy if appropriate -->
+ <para><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/check.png" />
+ </imageobject>
+ </inlinemediaobject> This method implements the <ulink
+ url="http://www.opengeospatial.org/standards/sfs">OpenGIS Simple Features
+ Implementation Specification for SQL.</ulink> OGC SFSQL 1.1 - 3.2.6.2</para>
+
+ <para>Availability: 1.1.0 - requires GEOS >= 2.1.0.</para>
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>Forthcoming</programlisting>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+ <para><xref linkend="ST_BuildArea" />, <xref linkend="ST_BdMPolyFromText" /></para>
+ </refsection>
+ </refentry>
+ <refentry id="ST_BdMPolyFromText">
+ <refnamediv>
+ <refname>ST_BdMPolyFromText</refname>
+ <refpurpose>Construct a MultiPolygon given an arbitrary collection of
+ closed linestrings as a MultiLineString text
+ representation Well-Known text representation.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>geometery <function>ST_BdMPolyFromText</function></funcdef>
+ <paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Construct a Polygon given an arbitrary collection of closed
+ linestrings, polygons, MultiLineStrings as Well-Known text representation.</para>
+
+ <!-- optionally mention that this function uses indexes if appropriate -->
+ <note>
+ <para>Throws an error if WKT is not a MULTILINESTRING. Forces
+ MULTIPOLYGON output even when result is really only composed by a
+ single POLYGON; use <link
+ linkend="BdPolyFromText">BdPolyFromText</link> if you're sure a
+ single POLYGON will result from operation, or see <link
+ linkend="BuildArea">BuildArea()</link> for a postgis-specific
+ approach.</para>
+ </note>
+
+ <!-- Optionally mention OpenGIS compliancy if appropriate -->
+ <para><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/check.png" />
+ </imageobject>
+ </inlinemediaobject> This method implements the <ulink
+ url="http://www.opengeospatial.org/standards/sfs">OpenGIS Simple Features
+ Implementation Specification for SQL.</ulink> OGC SFSQL 1.1 - 3.2.6.2</para>
+
+ <para>Availability: 1.1.0 - requires GEOS >= 2.1.0.</para>
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>Forthcoming</programlisting>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+ <para><xref linkend="ST_BuildArea" />, <xref linkend="ST_BdPolyFromText" /></para>
+ </refsection>
+ </refentry>
+ <refentry id="ST_BuildArea">
+ <refnamediv>
+ <refname>ST_BuildArea</refname>
+
+ <refpurpose>Creates an areal geometry formed by the constituent linework
+ of given geometry</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>boolean <function>ST_BuildArea</function></funcdef>
+ <paramdef><type>geometry </type> <parameter>A</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Creates an areal geometry formed by the constituent linework
+ of given geometry. The return type can be a Polygon or
+ MultiPolygon, depending on input. If the input lineworks do not
+ form polygons NULL is returned. The inputs can be LINESTRINGS, MULTILINESTRINGS, POLYGONS, MULTIPOLYGONS, and GeometryCollections.
+ </para>
+ <para>This function will assume all inner geometries represent holes</para>
+ <para>Availability: 1.1.0 - requires GEOS >= 2.1.0.</para>
+ </refsection>
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>
+--This will create a donut
+SELECT ST_BuildArea(ST_Collect(smallc,bigc))
+FROM (SELECT ST_Buffer(ST_GeomFromText('POINT(1 2)'), 10) As smallc,
+ ST_Buffer(ST_GeomFromText('POINT(1 2)'), 20) As bigc) As foo
+
+--This will create a gaping hole
+--inside the circle with prongs sticking out
+SELECT ST_BuildArea(ST_Collect(line,circle))
+FROM (SELECT ST_Buffer(ST_MakeLine(ST_MakePoint(21, 22),ST_MakePoint(-19, -18)),1) As line,
+ ST_Buffer(ST_GeomFromText('POINT(1 2)'), 20) As circle) As foo;
+
+--this creates the same gaping hole
+--but using linestrings instead of polygons
+SELECT ST_AsBinary(ST_BuildArea(ST_Collect(ST_ExteriorRing(line),ST_ExteriorRing(circle))))
+FROM (SELECT ST_Buffer(ST_MakeLine(ST_MakePoint(21, 22),ST_MakePoint(-19, -18)),1) As line,
+ ST_Buffer(ST_GeomFromText('POINT(1 2)'), 20) As circle) As foo
+ </programlisting>
+ </refsection>
+
+ <refsection>
+ <title>See Also</title>
+
+ <para>
+ <xref linkend="ST_BdPolyFromText" />,
+ <xref linkend="ST_BdMPolyFromText" />wrappers to
+ this function with standard OGC interface</para>
+ </refsection>
+ </refentry>
+
<refentry id="ST_MakeLine">
<refnamediv>
<refname>ST_MakeLine</refname>
More information about the postgis-commits
mailing list