[postgis-commits] svn - r3516 - trunk/doc
postgis-commits at postgis.refractions.net
postgis-commits at postgis.refractions.net
Mon Jan 12 05:54:18 PST 2009
Author: robe
Date: 2009-01-12 05:54:17 -0800 (Mon, 12 Jan 2009)
New Revision: 3516
Modified:
trunk/doc/reference.xml
trunk/doc/reference_new.xml
Log:
Move over ST_Line functions and point out how pointless they are. Also correct incorrect statement that they throw errors when given non-line - they just return null.
Modified: trunk/doc/reference.xml
===================================================================
--- trunk/doc/reference.xml 2009-01-12 12:23:11 UTC (rev 3515)
+++ trunk/doc/reference.xml 2009-01-12 13:54:17 UTC (rev 3516)
@@ -23,35 +23,10 @@
<title>Geometry Constructors</title>
<variablelist>
- <varlistentry>
- <term>ST_LineFromText(text)</term>
- <term>ST_LineFromText(text,srid integer)</term>
- <listitem>
- <para>Makes a Geometry from WKT with the given SRID. If SRID is
- not give, it defaults to -1.</para>
-
- <para>OGC SPEC 3.2.6.2 - option SRID is from the conformance
- suite</para>
-
- <para>Throws an error if the WKT is not a Line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>ST_LinestringFromText(text)</term>
- <term>ST_LinestringFromText(text,srid integer)</term>
-
- <listitem>
- <para>Makes a Geometry from WKT with the given SRID. If SRID is
- not give, it defaults to -1.</para>
-
- <para>from the conformance suite</para>
-
- <para>Throws an error if the WKT is not a Line</para>
- </listitem>
- </varlistentry>
+
<varlistentry>
<term>ST_PolyFromText(text,[<srid>])</term>
@@ -178,19 +153,6 @@
</varlistentry>
<varlistentry>
- <term>ST_LinestringFromWKB(bytea,[<srid>])</term>
-
- <listitem>
- <para>Makes a Geometry from WKB with the given SRID. If SRID is
- not give, it defaults to -1.</para>
-
- <para>from the conformance suite</para>
-
- <para>throws an error if WKB is not a LINESTRING</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term>ST_PolyFromWKB(bytea,[<srid>])</term>
<listitem>
@@ -428,26 +390,6 @@
<variablelist>
<varlistentry>
- <term>ST_LineFromText</term>
-
- <listitem>
- <para>Return a specified ST_LineString value.</para>
-
- <para>SQL-MM 3: 7.2.8</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>ST_LineFromWKB</term>
-
- <listitem>
- <para>Return a specified ST_LineString value.</para>
-
- <para>SQL-MM 3: 7.2.9</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
<term>ST_MLineFromText</term>
<listitem>
Modified: trunk/doc/reference_new.xml
===================================================================
--- trunk/doc/reference_new.xml 2009-01-12 12:23:11 UTC (rev 3515)
+++ trunk/doc/reference_new.xml 2009-01-12 13:54:17 UTC (rev 3516)
@@ -1473,7 +1473,7 @@
<para><xref linkend="ST_WKBToSQL" />, <xref linkend="ST_AsBinary" />, <xref linkend="ST_GeomFromEWKB" /></para>
</refsection>
</refentry>
-
+
<refentry id="ST_LineFromMultiPoint">
<refnamediv>
<refname>ST_LineFromMultiPoint</refname>
@@ -1522,7 +1522,248 @@
<para><xref linkend="ST_AsEWKT" />, <xref linkend="ST_Collect" />,<xref linkend="ST_MakeLine" /></para>
</refsection>
</refentry>
+
+ <refentry id="ST_LineFromText">
+ <refnamediv>
+ <refname>ST_LineFromText</refname>
+ <refpurpose>>Makes a Geometry from WKT with the given SRID. If SRID is
+ not give, it defaults to -1.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>geometry <function>ST_LineFromText</function></funcdef>
+ <paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
+ </funcprototype>
+
+ <funcprototype>
+ <funcdef>geometry <function>ST_LineFromText</function></funcdef>
+ <paramdef><type>text </type> <parameter>WKT</parameter></paramdef>
+ <paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Makes a Geometry from WKT with the given SRID. If SRID is
+ not give, it defaults to -1. If WKT passed in is not a LINESTRING, then null is returned. This is an alias
+ for ST_LinestringFromText.</para>
+
+ <note>
+ <para>OGC SPEC 3.2.6.2 - option SRID is from the conformance
+ suite.</para>
+ </note>
+
+ <note>
+ <para>If you know all your geometries are LINESTRINGS, its more efficient to just use ST_GeomFromText.
+ This just calls ST_GeomFromText and adds additional validation that it returns a linestring.</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. OGC SPEC 3.2.6.2</ulink></para>
+
+ <!-- Optionally mention SQL/MM compliancy if appropriate -->
+ <para><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/check.png" />
+ </imageobject>
+ </inlinemediaobject> This method implements the SQL/MM specification:
+ SQL-MM 3: 7.2.8</para>
+
+ </refsection>
+
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT ST_LineFromText('LINESTRING(1 2, 3 4)') AS aline, ST_LineFromText('POINT(1 2)') AS null_return;
+aline | null_return
+------------------------------------------------
+010200000002000000000000000000F ... | t
+ </programlisting>
+ </refsection>
+
+ <!-- Optionally add a "See Also" section -->
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="ST_GeomFromText" />, <xref linkend="ST_LinestringFromText" /></para>
+ </refsection>
+ </refentry>
+
+ <refentry id="ST_LineFromWKB">
+ <refnamediv>
+ <refname>ST_LineFromWKB</refname>
+
+ <refpurpose>>Makes a Geometry from WKB with the given SRID. If SRID is
+ not give, it defaults to -1.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>geometry <function>ST_LineFromWKB</function></funcdef>
+ <paramdef><type>bytea </type> <parameter>WKB</parameter></paramdef>
+ </funcprototype>
+
+ <funcprototype>
+ <funcdef>geometry <function>ST_LineFromWKB</function></funcdef>
+ <paramdef><type>bytea </type> <parameter>WKT</parameter></paramdef>
+ <paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Makes a Geometry from WKB with the given SRID. If SRID is
+ not give, it defaults to -1. This an alias for ST_LinestringFromWKB.</para>
+
+ <note><para>If WKB passed in is not a LINESTRING, then null is returned.</para></note>
+
+ <note>
+ <para>OGC SPEC 3.2.6.2 - option SRID is from the conformance
+ suite.</para>
+ </note>
+
+ <note>
+ <para>If you know all your geometries are LINESTRINGS, its more efficient to just use ST_GeomFromWKB.
+ This just calls ST_GeomFromWKB and adds additional validation that it returns a linestring.</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. OGC SPEC 3.2.6.2</ulink></para>
+
+ <!-- Optionally mention SQL/MM compliancy if appropriate -->
+ <para><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/check.png" />
+ </imageobject>
+ </inlinemediaobject> This method implements the SQL/MM specification:
+ SQL-MM 3: 7.2.9</para>
+
+ </refsection>
+
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT ST_LineFromWKB(ST_AsBinary(ST_GeomFromText('LINESTRING(1 2, 3 4)'))) AS aline,
+ ST_LineFromWKB(ST_AsBinary(ST_GeomFromText('POINT(1 2)'))) IS NULL AS null_return;
+aline | null_return
+------------------------------------------------
+010200000002000000000000000000F ... | t
+ </programlisting>
+ </refsection>
+
+ <!-- Optionally add a "See Also" section -->
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="ST_GeomFromWKB" />, <xref linkend="ST_LinestringFromWKB" /></para>
+ </refsection>
+ </refentry>
+
+ <refentry id="ST_LinestringFromWKB">
+ <refnamediv>
+ <refname>ST_LinestringFromWKB</refname>
+
+ <refpurpose>>Makes a Geometry from WKB with the given SRID. If SRID is
+ not give, it defaults to -1.</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>geometry <function>ST_LinestringFromWKB</function></funcdef>
+ <paramdef><type>bytea </type> <parameter>WKB</parameter></paramdef>
+ </funcprototype>
+
+ <funcprototype>
+ <funcdef>geometry <function>ST_LinestringFromWKB</function></funcdef>
+ <paramdef><type>bytea </type> <parameter>WKT</parameter></paramdef>
+ <paramdef><type>integer </type> <parameter>srid</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+
+ <refsection>
+ <title>Description</title>
+
+ <para>Makes a Geometry from WKB with the given SRID. If SRID is
+ not give, it defaults to -1. This an alias for ST_LineFromWKB.</para>
+
+ <note><para>If WKB passed in is not a LINESTRING, then null is returned.</para></note>
+
+ <note>
+ <para>OGC SPEC 3.2.6.2 - option SRID is from the conformance
+ suite.</para>
+ </note>
+
+ <note>
+ <para>If you know all your geometries are LINESTRINGS, its more efficient to just use ST_GeomFromWKB.
+ This just calls ST_GeomFromWKB and adds additional validation that it returns a linestring.</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. OGC SPEC 3.2.6.2</ulink></para>
+
+ <!-- Optionally mention SQL/MM compliancy if appropriate -->
+ <para><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/check.png" />
+ </imageobject>
+ </inlinemediaobject> This method implements the SQL/MM specification:
+ SQL-MM 3: 7.2.9</para>
+
+ </refsection>
+
+
+ <refsection>
+ <title>Examples</title>
+
+ <programlisting>SELECT ST_LineStringFromWKB(ST_AsBinary(ST_GeomFromText('LINESTRING(1 2, 3 4)'))) AS aline,
+ ST_LinestringFromWKB(ST_AsBinary(ST_GeomFromText('POINT(1 2)'))) IS NULL AS null_return;
+aline | null_return
+------------------------------------------------
+010200000002000000000000000000F ... | t
+ </programlisting>
+ </refsection>
+
+ <!-- Optionally add a "See Also" section -->
+ <refsection>
+ <title>See Also</title>
+
+ <para><xref linkend="ST_GeomFromWKB" />, <xref linkend="ST_LineFromWKB" /></para>
+ </refsection>
+ </refentry>
+
<refentry id="ST_MakeBox2D">
<refnamediv>
<refname>ST_MakeBox2D</refname>
More information about the postgis-commits
mailing list