Difference between revisions of "Geo Module"

From BaseX Documentation
Jump to navigation Jump to search
Line 54: Line 54:
 
|-
 
|-
 
| '''Summary'''
 
| '''Summary'''
| Returns the gml:Envelope of the given geometry {{Code|$geometry}}. The envelope is the minimum bounding box of this geometry
+
| Returns the WKT (Well-known Text) representation of the given geometry {{Code|$geometry}}. The envelope is the minimum bounding box of this geometry
 +
|-
 +
| '''Errors'''
 +
|{{Error|GEO0001|#Errors}} the given element is not recognized as a valid geometry.<br />{{Error|GEO0002|#Errors}} the given element cannot be read by reader for some reason.<br />
 +
|}
 +
 
 +
 
 +
 
 +
==geo:asBinary==
 +
{| width='100%'
 +
|-
 +
| width='90' | '''Signatures'''
 +
|{{Func|geo:asBinary|$geometry as element(*)|xs:base64Binary}}
 +
|-
 +
| '''Summary'''
 +
| Returns the WKB (Well-known Binary) representation of the given geometry {{Code|$geometry}}.
 +
|-
 +
| '''Errors'''
 +
|{{Error|GEO0001|#Errors}} the given element is not recognized as a valid geometry.<br />{{Error|GEO0002|#Errors}} the given element cannot be read by reader for some reason.<br />
 +
|}
 +
 
 +
 
 +
==geo:isEmpty==
 +
{| width='100%'
 +
|-
 +
| width='90' | '''Signatures'''
 +
|{{Func|geo:isEmpty|$geometry as element(*)|xs:boolean}}
 +
|-
 +
| '''Summary'''
 +
| Returns whether the given geometry is empty {{Code|$geometry}}.
 +
|-
 +
| '''Errors'''
 +
|{{Error|GEO0001|#Errors}} the given element is not recognized as a valid geometry.<br />{{Error|GEO0002|#Errors}} the given element cannot be read by reader for some reason.<br />
 +
|}
 +
 
 +
 
 +
 
 +
==geo:isSimple==
 +
{| width='100%'
 +
|-
 +
| width='90' | '''Signatures'''
 +
|{{Func|geo:isSimple|$geometry as element(*)|xs:boolean}}
 +
|-
 +
| '''Summary'''
 +
| Returns whether the given geometry is simple {{Code|$geometry}} and does not have has no anomalous geometric points (ie. the geometry does not self-intersect and does not pass through the same point more than once (may be a ring)).
 +
|-
 +
| '''Errors'''
 +
|{{Error|GEO0001|#Errors}} the given element is not recognized as a valid geometry.<br />{{Error|GEO0002|#Errors}} the given element cannot be read by reader for some reason.<br />
 +
|}
 +
 
 +
 
 +
 
 +
 
 +
==geo:boundary==
 +
{| width='100%'
 +
|-
 +
| width='90' | '''Signatures'''
 +
|{{Func|geo:boundary|$geometry as element(*)|xs:element(*)*}}
 +
|-
 +
| '''Summary'''
 +
| Returns the boundary of the geometry {{Code|$geometry}}, in GML 2. The return value is a sequence of either gml:Point or gml:LinearRing elements as a GeometryCollection object. For a Point or MultiPoint, the boundary is the empty geometry, nothing is returned.
 
|-
 
|-
 
| '''Errors'''
 
| '''Errors'''
 
|{{Error|GEO0001|#Errors}} the given element is not recognized as a valid geometry.<br />{{Error|GEO0002|#Errors}} the given element cannot be read by reader for some reason.<br />{{Error|GEO0008|#Errors}} the output object cannot be written as an element by writer for some reason.<br />
 
|{{Error|GEO0001|#Errors}} the given element is not recognized as a valid geometry.<br />{{Error|GEO0002|#Errors}} the given element cannot be read by reader for some reason.<br />{{Error|GEO0008|#Errors}} the output object cannot be written as an element by writer for some reason.<br />
 
|}
 
|}

Revision as of 13:38, 4 January 2013

Geo Module adds the support of ExPath Geo Module for GML 2 to BaseX. Based on JTS, GML 2 queris are parsed and evaluated to show in the BaseX frontend.

General Functions

geo:dimension

Signatures geo:dimension($geometry as element(*)) as xs:integer()
Summary Returns the dimension of the given geometry $geometry.
Errors GEO0001: the given element is not recognized as a valid geometry.
GEO0002: the given element cannot be read by reader for some reason.


geo:geometryType

Signatures geo:geometryType($geometry as element(*)) as xs:QName()?
Summary Returns the name of the geometry type of given geometry $geometry or an empty sequence, if the geometry is not recognized with an error massage .
Errors GEO0001: the given element is not recognized as a valid geometry.
GEO0002: the given element cannot be read by reader for some reason.


geo:envelope

Signatures geo:envelope($geometry as element(*)) as xs:element(gml:Envelope)?
Summary Returns the gml:Envelope of the given geometry $geometry. The envelope is the minimum bounding box of this geometry
Errors GEO0001: the given element is not recognized as a valid geometry.
GEO0002: the given element cannot be read by reader for some reason.
GEO0008: the output object cannot be written as an element by writer for some reason.


geo:asText

Signatures geo:asText($geometry as element(*)) as xs:string
Summary Returns the WKT (Well-known Text) representation of the given geometry $geometry. The envelope is the minimum bounding box of this geometry
Errors GEO0001: the given element is not recognized as a valid geometry.
GEO0002: the given element cannot be read by reader for some reason.


geo:asBinary

Signatures geo:asBinary($geometry as element(*)) as xs:base64Binary
Summary Returns the WKB (Well-known Binary) representation of the given geometry $geometry.
Errors GEO0001: the given element is not recognized as a valid geometry.
GEO0002: the given element cannot be read by reader for some reason.


geo:isEmpty

Signatures geo:isEmpty($geometry as element(*)) as xs:boolean
Summary Returns whether the given geometry is empty $geometry.
Errors GEO0001: the given element is not recognized as a valid geometry.
GEO0002: the given element cannot be read by reader for some reason.


geo:isSimple

Signatures geo:isSimple($geometry as element(*)) as xs:boolean
Summary Returns whether the given geometry is simple $geometry and does not have has no anomalous geometric points (ie. the geometry does not self-intersect and does not pass through the same point more than once (may be a ring)).
Errors GEO0001: the given element is not recognized as a valid geometry.
GEO0002: the given element cannot be read by reader for some reason.



geo:boundary

Signatures geo:boundary($geometry as element(*)) as xs:element(*)*
Summary Returns the boundary of the geometry $geometry, in GML 2. The return value is a sequence of either gml:Point or gml:LinearRing elements as a GeometryCollection object. For a Point or MultiPoint, the boundary is the empty geometry, nothing is returned.
Errors GEO0001: the given element is not recognized as a valid geometry.
GEO0002: the given element cannot be read by reader for some reason.
GEO0008: the output object cannot be written as an element by writer for some reason.