public interface GeoExpr
Modifier and Type | Method | Description |
---|---|---|
ServerExpression |
approxCenter(ServerExpression region) |
Return a point approximating the center of the
given region.
|
ServerExpression |
approxCenter(ServerExpression region,
ServerExpression options) |
Return a point approximating the center of the
given region.
|
ServerExpression |
approxCenter(ServerExpression region,
java.lang.String options) |
Return a point approximating the center of the
given region.
|
ServerExpression |
arcIntersection(ServerExpression p1,
ServerExpression p2,
ServerExpression q1,
ServerExpression q2) |
Returns the point at the intersection of two
arcs.
|
ServerExpression |
arcIntersection(ServerExpression p1,
ServerExpression p2,
ServerExpression q1,
ServerExpression q2,
ServerExpression options) |
Returns the point at the intersection of two
arcs.
|
ServerExpression |
arcIntersection(ServerExpression p1,
ServerExpression p2,
ServerExpression q1,
ServerExpression q2,
java.lang.String options) |
Returns the point at the intersection of two
arcs.
|
ServerExpression |
bearing(ServerExpression p1,
ServerExpression p2) |
Returns the true bearing in radians of the path
from the first point to the second.
|
ServerExpression |
bearing(ServerExpression p1,
ServerExpression p2,
ServerExpression options) |
Returns the true bearing in radians of the path
from the first point to the second.
|
ServerExpression |
bearing(ServerExpression p1,
ServerExpression p2,
java.lang.String options) |
Returns the true bearing in radians of the path
from the first point to the second.
|
ServerExpression |
boundingBoxes(ServerExpression region) |
Returns a sequence of boxes that bound the given
region.
|
ServerExpression |
boundingBoxes(ServerExpression region,
ServerExpression options) |
Returns a sequence of boxes that bound the given
region.
|
ServerExpression |
boundingBoxes(ServerExpression region,
java.lang.String options) |
Returns a sequence of boxes that bound the given
region.
|
ServerExpression |
boxIntersects(ServerExpression box,
ServerExpression region) |
Returns true if the box intersects with a
region.
|
ServerExpression |
boxIntersects(ServerExpression box,
ServerExpression region,
ServerExpression options) |
Returns true if the box intersects with a
region.
|
ServerExpression |
boxIntersects(ServerExpression box,
ServerExpression region,
java.lang.String options) |
Returns true if the box intersects with a
region.
|
ServerExpression |
circleIntersects(ServerExpression circle,
ServerExpression region) |
Returns true if the circle intersects with a
region.
|
ServerExpression |
circleIntersects(ServerExpression circle,
ServerExpression region,
ServerExpression options) |
Returns true if the circle intersects with a
region.
|
ServerExpression |
circleIntersects(ServerExpression circle,
ServerExpression region,
java.lang.String options) |
Returns true if the circle intersects with a
region.
|
ServerExpression |
circlePolygon(ServerExpression circle,
double arcTolerance) |
Construct a polygon approximating a
circle.
|
ServerExpression |
circlePolygon(ServerExpression circle,
double arcTolerance,
java.lang.String options) |
Construct a polygon approximating a
circle.
|
ServerExpression |
circlePolygon(ServerExpression circle,
ServerExpression arcTolerance) |
Construct a polygon approximating a
circle.
|
ServerExpression |
circlePolygon(ServerExpression circle,
ServerExpression arcTolerance,
ServerExpression options) |
Construct a polygon approximating a
circle.
|
ServerExpression |
countDistinctVertices(ServerExpression region) |
Return a count of the distinct number of
vertices in a region, taking tolerance into account.
|
ServerExpression |
countDistinctVertices(ServerExpression region,
ServerExpression options) |
Return a count of the distinct number of
vertices in a region, taking tolerance into account.
|
ServerExpression |
countDistinctVertices(ServerExpression region,
java.lang.String options) |
Return a count of the distinct number of
vertices in a region, taking tolerance into account.
|
ServerExpression |
countVertices(ServerExpression region) |
This function returns a count of the number of
vertices in a region.
|
ServerExpression |
destination(ServerExpression p,
double bearing, double distance) |
Returns the point at the given distance (in
units) along the given bearing (in radians) from the starting
point.
|
ServerExpression |
destination(ServerExpression p,
double bearing, double distance,
java.lang.String options) |
Returns the point at the given distance (in
units) along the given bearing (in radians) from the starting
point.
|
ServerExpression |
destination(ServerExpression p,
ServerExpression bearing,
ServerExpression distance) |
Returns the point at the given distance (in
units) along the given bearing (in radians) from the starting
point.
|
ServerExpression |
destination(ServerExpression p,
ServerExpression bearing,
ServerExpression distance,
ServerExpression options) |
Returns the point at the given distance (in
units) along the given bearing (in radians) from the starting
point.
|
ServerExpression |
distance(ServerExpression p1,
ServerExpression p2) |
Returns the distance (in units) between two
points.
|
ServerExpression |
distance(ServerExpression p1,
ServerExpression p2,
ServerExpression options) |
Returns the distance (in units) between two
points.
|
ServerExpression |
distance(ServerExpression p1,
ServerExpression p2,
java.lang.String options) |
Returns the distance (in units) between two
points.
|
ServerExpression |
distanceConvert(ServerExpression distance,
ServerExpression unit1,
ServerExpression unit2) |
This function converts a distance from one unit
of measure to another.
|
ServerExpression |
distanceConvert(ServerExpression distance,
java.lang.String unit1,
java.lang.String unit2) |
This function converts a distance from one unit
of measure to another.
|
ServerExpression |
ellipsePolygon(ServerExpression center,
double semiMajorAxis, double semiMinorAxis,
double azimuth, double arcTolerance) |
Construct a polygon approximating an
ellipse.
|
ServerExpression |
ellipsePolygon(ServerExpression center,
double semiMajorAxis, double semiMinorAxis,
double azimuth, double arcTolerance,
java.lang.String options) |
Construct a polygon approximating an
ellipse.
|
ServerExpression |
ellipsePolygon(ServerExpression center,
ServerExpression semiMajorAxis,
ServerExpression semiMinorAxis,
ServerExpression azimuth,
ServerExpression arcTolerance) |
Construct a polygon approximating an
ellipse.
|
ServerExpression |
ellipsePolygon(ServerExpression center,
ServerExpression semiMajorAxis,
ServerExpression semiMinorAxis,
ServerExpression azimuth,
ServerExpression arcTolerance,
ServerExpression options) |
Construct a polygon approximating an
ellipse.
|
ServerExpression |
geohashDecode(ServerExpression hash) |
Given a geohash string, return the bounding box
for that hash.
|
ServerExpression |
geohashDecode(java.lang.String hash) |
Given a geohash string, return the bounding box
for that hash.
|
ServerExpression |
geohashDecodePoint(ServerExpression hash) |
Given a geohash string, return the point for
that hash.
|
ServerExpression |
geohashDecodePoint(java.lang.String hash) |
Given a geohash string, return the point for
that hash.
|
ServerExpression |
geohashEncode(ServerExpression region) |
Compute a set of covering geohashes for the
given region, to the given level of precision.
|
ServerExpression |
geohashEncode(ServerExpression region,
long geohashPrecision) |
Compute a set of covering geohashes for the
given region, to the given level of precision.
|
ServerExpression |
geohashEncode(ServerExpression region,
long geohashPrecision,
java.lang.String options) |
Compute a set of covering geohashes for the
given region, to the given level of precision.
|
ServerExpression |
geohashEncode(ServerExpression region,
ServerExpression geohashPrecision) |
Compute a set of covering geohashes for the
given region, to the given level of precision.
|
ServerExpression |
geohashEncode(ServerExpression region,
ServerExpression geohashPrecision,
ServerExpression options) |
Compute a set of covering geohashes for the
given region, to the given level of precision.
|
ServerExpression |
geohashNeighbors(ServerExpression hash) |
Given a geohash string, return hashes for the
neighbors.
|
ServerExpression |
geohashPrecisionDimensions(ServerExpression precision) |
Given a geohash string, return the height and
width for the given precision.
|
ServerExpression |
geohashSubhashes(ServerExpression hash,
ServerExpression which) |
Given a geohash string, return the 32
subhashes.
|
ServerExpression |
geohashSubhashes(ServerExpression hash,
java.lang.String which) |
Given a geohash string, return the 32
subhashes.
|
ServerExpression |
interiorPoint(ServerExpression region) |
This function returns a point that is guaranteed
to be inside the bounds of the given region.
|
ServerExpression |
interiorPoint(ServerExpression region,
ServerExpression options) |
This function returns a point that is guaranteed
to be inside the bounds of the given region.
|
ServerExpression |
interiorPoint(ServerExpression region,
java.lang.String options) |
This function returns a point that is guaranteed
to be inside the bounds of the given region.
|
CtsRegionSeqExpr |
parseWkt(ServerExpression wkt) |
Returns a sequence of geospatial regions parsed
from Well-Known Text format.
|
CtsRegionSeqExpr |
parseWkt(java.lang.String wkt) |
Returns a sequence of geospatial regions parsed
from Well-Known Text format.
|
CtsRegionExpr |
regionApproximate(ServerExpression region,
double threshold) |
This function returns a simplified approximation
of the region, using the Douglas-Peucker algorithm.
|
CtsRegionExpr |
regionApproximate(ServerExpression region,
double threshold, java.lang.String options) |
This function returns a simplified approximation
of the region, using the Douglas-Peucker algorithm.
|
CtsRegionExpr |
regionApproximate(ServerExpression region,
ServerExpression threshold) |
This function returns a simplified approximation
of the region, using the Douglas-Peucker algorithm.
|
CtsRegionExpr |
regionApproximate(ServerExpression region,
ServerExpression threshold,
ServerExpression options) |
This function returns a simplified approximation
of the region, using the Douglas-Peucker algorithm.
|
CtsRegionExpr |
regionClean(ServerExpression region) |
This function fixes various problems with the
region or raises an error if it is not repairable.
|
CtsRegionExpr |
regionClean(ServerExpression region,
ServerExpression options) |
This function fixes various problems with the
region or raises an error if it is not repairable.
|
CtsRegionExpr |
regionClean(ServerExpression region,
java.lang.String options) |
This function fixes various problems with the
region or raises an error if it is not repairable.
|
ServerExpression |
regionContains(ServerExpression target,
ServerExpression region) |
Returns true if one region contains the other
region.
|
ServerExpression |
regionContains(ServerExpression target,
ServerExpression region,
ServerExpression options) |
Returns true if one region contains the other
region.
|
ServerExpression |
regionContains(ServerExpression target,
ServerExpression region,
java.lang.String options) |
Returns true if one region contains the other
region.
|
ServerExpression |
regionDe9im(ServerExpression region1,
ServerExpression region2) |
Calculates the Dimensionally Extended
nine-Intersection Matrix (DE-9IM) of two geospatial regions.
|
ServerExpression |
regionDe9im(ServerExpression region1,
ServerExpression region2,
ServerExpression options) |
Calculates the Dimensionally Extended
nine-Intersection Matrix (DE-9IM) of two geospatial regions.
|
ServerExpression |
regionDe9im(ServerExpression region1,
ServerExpression region2,
java.lang.String options) |
Calculates the Dimensionally Extended
nine-Intersection Matrix (DE-9IM) of two geospatial regions.
|
ServerExpression |
regionIntersects(ServerExpression target,
ServerExpression region) |
Returns true if the target region intersects
with a region.
|
ServerExpression |
regionIntersects(ServerExpression target,
ServerExpression region,
ServerExpression options) |
Returns true if the target region intersects
with a region.
|
ServerExpression |
regionIntersects(ServerExpression target,
ServerExpression region,
java.lang.String options) |
Returns true if the target region intersects
with a region.
|
ServerExpression |
regionRelate(ServerExpression region1,
ServerExpression operation,
ServerExpression region2) |
Compares geospatial regions based on a specified
relationship.
|
ServerExpression |
regionRelate(ServerExpression region1,
ServerExpression operation,
ServerExpression region2,
ServerExpression options) |
Compares geospatial regions based on a specified
relationship.
|
ServerExpression |
regionRelate(ServerExpression region1,
java.lang.String operation, ServerExpression region2) |
Compares geospatial regions based on a specified
relationship.
|
ServerExpression |
regionRelate(ServerExpression region1,
java.lang.String operation, ServerExpression region2,
java.lang.String options) |
Compares geospatial regions based on a specified
relationship.
|
CtsRegionExpr |
removeDuplicateVertices(ServerExpression region) |
Remove duplicate (adjacent) vertices.
|
CtsRegionExpr |
removeDuplicateVertices(ServerExpression region,
ServerExpression options) |
Remove duplicate (adjacent) vertices.
|
CtsRegionExpr |
removeDuplicateVertices(ServerExpression region,
java.lang.String options) |
Remove duplicate (adjacent) vertices.
|
ServerExpression |
shortestDistance(ServerExpression p1,
ServerExpression region) |
Returns the great circle distance (in units)
between a point and a region.
|
ServerExpression |
shortestDistance(ServerExpression p1,
ServerExpression region,
ServerExpression options) |
Returns the great circle distance (in units)
between a point and a region.
|
ServerExpression |
shortestDistance(ServerExpression p1,
ServerExpression region,
java.lang.String options) |
Returns the great circle distance (in units)
between a point and a region.
|
ServerExpression |
toWkt(ServerExpression wkt) |
Returns a sequence of strings in Well-Known Text
format.
|
ServerExpression |
validateWkt(ServerExpression wkt) |
Returns true if the string is valid Well-Known
Text for a supported region type.
|
ServerExpression approxCenter(ServerExpression region)
Provides a client interface to the geo:approx-center server function.
region
- A geospatial region. (of cts:region)ServerExpression approxCenter(ServerExpression region, java.lang.String options)
Provides a client interface to the geo:approx-center server function.
region
- A geospatial region. (of cts:region)options
- Options. The default is (). Options
include: "box-percent=n" An integer between 0 and 100 (default is
100) that indicates what percentage of a polygon's bounding box
slivers should be used in constructing the approximate centroid.
Lower numbers use fewer slivers, giving faster but less accurate
results; larger numbers use more slivers, giving slower but more
accurate results. "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" The precision use for this operation,
including the interpretation of input values. Allowed values:
float, double. Default: The precision of the governing coordinate
system. (of xs:string)ServerExpression approxCenter(ServerExpression region, ServerExpression options)
Provides a client interface to the geo:approx-center server function.
region
- A geospatial region. (of cts:region)options
- Options. The default is (). Options
include: "box-percent=n" An integer between 0 and 100 (default is
100) that indicates what percentage of a polygon's bounding box
slivers should be used in constructing the approximate centroid.
Lower numbers use fewer slivers, giving faster but less accurate
results; larger numbers use more slivers, giving slower but more
accurate results. "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" The precision use for this operation,
including the interpretation of input values. Allowed values:
float, double. Default: The precision of the governing coordinate
system. (of xs:string)ServerExpression arcIntersection(ServerExpression p1, ServerExpression p2, ServerExpression q1, ServerExpression q2)
Provides a client interface to the geo:arc-intersection server function.
p1
- The starting point of the first arc. (of
cts:point)p2
- The ending point of the first arc. (of
cts:point)q1
- The starting point of the second arc. (of
cts:point)q2
- The ending point of the second arc. (of
cts:point)ServerExpression arcIntersection(ServerExpression p1, ServerExpression p2, ServerExpression q1, ServerExpression q2, java.lang.String options)
Provides a client interface to the geo:arc-intersection server function.
p1
- The starting point of the first arc. (of
cts:point)p2
- The ending point of the first arc. (of
cts:point)q1
- The starting point of the second arc. (of
cts:point)q2
- The ending point of the second arc. (of
cts:point)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance and the radii of circles in the specified units. Allowed
values: miles (default), km, feet, meters. "tolerance=distance"
Tolerance is the largest allowable variation in geometry
calculations. If the distance between two points is less than
tolerance, then the two points are considered equal. For the raw
coordinate system, use the units of the coordinates. For geographic
coordinate systems, use the units specified by the units option.
(of xs:string)ServerExpression arcIntersection(ServerExpression p1, ServerExpression p2, ServerExpression q1, ServerExpression q2, ServerExpression options)
Provides a client interface to the geo:arc-intersection server function.
p1
- The starting point of the first arc. (of
cts:point)p2
- The ending point of the first arc. (of
cts:point)q1
- The starting point of the second arc. (of
cts:point)q2
- The ending point of the second arc. (of
cts:point)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance and the radii of circles in the specified units. Allowed
values: miles (default), km, feet, meters. "tolerance=distance"
Tolerance is the largest allowable variation in geometry
calculations. If the distance between two points is less than
tolerance, then the two points are considered equal. For the raw
coordinate system, use the units of the coordinates. For geographic
coordinate systems, use the units specified by the units option.
(of xs:string)ServerExpression bearing(ServerExpression p1, ServerExpression p2)
Provides a client interface to the geo:bearing server function.
ServerExpression bearing(ServerExpression p1, ServerExpression p2, java.lang.String options)
Provides a client interface to the geo:bearing server function.
p1
- The first point. (of cts:point)p2
- The second point. (of cts:point)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Unit of
measure of the tolerance value. Valid values are miles (default),
km, feet, meters. "tolerance=distance" Tolerance is the largest
allowable variation in geometry calculations. If the distance
between two points is less than tolerance, then the two points are
considered equal. For the raw coordinate system, use the units of
the coordinates. For geographic coordinate systems, use the units
specified by the units option. (of xs:string)ServerExpression bearing(ServerExpression p1, ServerExpression p2, ServerExpression options)
Provides a client interface to the geo:bearing server function.
p1
- The first point. (of cts:point)p2
- The second point. (of cts:point)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Unit of
measure of the tolerance value. Valid values are miles (default),
km, feet, meters. "tolerance=distance" Tolerance is the largest
allowable variation in geometry calculations. If the distance
between two points is less than tolerance, then the two points are
considered equal. For the raw coordinate system, use the units of
the coordinates. For geographic coordinate systems, use the units
specified by the units option. (of xs:string)ServerExpression boundingBoxes(ServerExpression region)
Provides a client interface to the geo:bounding-boxes server function.
region
- A geographic region (box, circle,
polygon, or point). (of cts:region)ServerExpression boundingBoxes(ServerExpression region, java.lang.String options)
Provides a client interface to the geo:bounding-boxes server function.
region
- A geographic region (box, circle,
polygon, or point). (of cts:region)options
- Options for the operation. The default
is (). Options include: Options include: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system. wgs84/doubleThe WGS84 coordinate system at
double precision. etrs89The ETRS89 coordinate system.
etrs89/doubleThe ETRS89 coordinate system at double precision.
rawThe raw (unmapped) coordinate system. raw/doubleThe raw
coordinate system at double precision. "precision=value" Use the
coordinate system at the given precision. Allowed values: float and
double. "units=value" Measure distance, radii of circles, and
tolerance in the specified units. Allowed values: miles (default),
km, feet, meters. "box-percent=n" An integer between 0 and 100
(default is 100) that indicates what percentage of a polygon's
bounding box slivers should be returned. Lower numbers give fewer,
less accurate boxes; larger numbers give more, more accurate boxes.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. The bounding boxes will be padded to
cover any points within tolerance of the region. For the raw
coordinate system, use the units of the coordinates. For geographic
coordinate systems, use the units specified by the units option.
The default value is 0 (no padding). "boundaries-included" Points
on boxes', circles', and polygons' boundaries are counted as
matching. This is the default. "boundaries-excluded" Points on
boxes', circles', and polygons' boundaries are not counted as
matching. "boundaries-latitude-excluded" Points on boxes' latitude
boundaries are not counted as matching.
"boundaries-longitude-excluded" Points on boxes' longitude
boundaries are not counted as matching. "boundaries-south-excluded"
Points on the boxes' southern boundaries are not counted as
matching. "boundaries-west-excluded" Points on the boxes' western
boundaries are not counted as matching. "boundaries-north-excluded"
Points on the boxes' northern boundaries are not counted as
matching. "boundaries-east-excluded" Points on the boxes' eastern
boundaries are not counted as matching.
"boundaries-circle-excluded" Points on circles' boundary are not
counted as matching. "boundaries-endpoints-excluded" Points on
linestrings' boundary (the endpoints) are not counted as matching.
(of xs:string)ServerExpression boundingBoxes(ServerExpression region, ServerExpression options)
Provides a client interface to the geo:bounding-boxes server function.
region
- A geographic region (box, circle,
polygon, or point). (of cts:region)options
- Options for the operation. The default
is (). Options include: Options include: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system. wgs84/doubleThe WGS84 coordinate system at
double precision. etrs89The ETRS89 coordinate system.
etrs89/doubleThe ETRS89 coordinate system at double precision.
rawThe raw (unmapped) coordinate system. raw/doubleThe raw
coordinate system at double precision. "precision=value" Use the
coordinate system at the given precision. Allowed values: float and
double. "units=value" Measure distance, radii of circles, and
tolerance in the specified units. Allowed values: miles (default),
km, feet, meters. "box-percent=n" An integer between 0 and 100
(default is 100) that indicates what percentage of a polygon's
bounding box slivers should be returned. Lower numbers give fewer,
less accurate boxes; larger numbers give more, more accurate boxes.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. The bounding boxes will be padded to
cover any points within tolerance of the region. For the raw
coordinate system, use the units of the coordinates. For geographic
coordinate systems, use the units specified by the units option.
The default value is 0 (no padding). "boundaries-included" Points
on boxes', circles', and polygons' boundaries are counted as
matching. This is the default. "boundaries-excluded" Points on
boxes', circles', and polygons' boundaries are not counted as
matching. "boundaries-latitude-excluded" Points on boxes' latitude
boundaries are not counted as matching.
"boundaries-longitude-excluded" Points on boxes' longitude
boundaries are not counted as matching. "boundaries-south-excluded"
Points on the boxes' southern boundaries are not counted as
matching. "boundaries-west-excluded" Points on the boxes' western
boundaries are not counted as matching. "boundaries-north-excluded"
Points on the boxes' northern boundaries are not counted as
matching. "boundaries-east-excluded" Points on the boxes' eastern
boundaries are not counted as matching.
"boundaries-circle-excluded" Points on circles' boundary are not
counted as matching. "boundaries-endpoints-excluded" Points on
linestrings' boundary (the endpoints) are not counted as matching.
(of xs:string)ServerExpression boxIntersects(ServerExpression box, ServerExpression region)
Provides a client interface to the geo:box-intersects server function.
box
- A geographic box. (of cts:box)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if any region intersects the box. (of
cts:region)ServerExpression boxIntersects(ServerExpression box, ServerExpression region, java.lang.String options)
Provides a client interface to the geo:box-intersects server function.
box
- A geographic box. (of cts:box)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if any region intersects the box. (of
cts:region)options
- Options for the operation. The default
is (). Options include: Options include: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system. wgs84/doubleThe WGS84 coordinate system at
double precision. etrs89The ETRS89 coordinate system.
etrs89/doubleThe ETRS89 coordinate system at double precision.
rawThe raw (unmapped) coordinate system. raw/doubleThe raw
coordinate system at double precision. "precision=value" Use the
coordinate system at the given precision. Allowed values: float and
double. "units=value" Measure distance, radii of circles, and
tolerance in the specified units. Allowed values: miles (default),
km, feet, meters. "tolerance=distance" Tolerance is the largest
allowable variation in geometry calculations. If the distance
between two points is less than tolerance, then the two points are
considered equal. For the raw coordinate system, use the units of
the coordinates. For geographic coordinate systems, use the units
specified by the units option. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. (of xs:string)ServerExpression boxIntersects(ServerExpression box, ServerExpression region, ServerExpression options)
Provides a client interface to the geo:box-intersects server function.
box
- A geographic box. (of cts:box)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if any region intersects the box. (of
cts:region)options
- Options for the operation. The default
is (). Options include: Options include: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system. wgs84/doubleThe WGS84 coordinate system at
double precision. etrs89The ETRS89 coordinate system.
etrs89/doubleThe ETRS89 coordinate system at double precision.
rawThe raw (unmapped) coordinate system. raw/doubleThe raw
coordinate system at double precision. "precision=value" Use the
coordinate system at the given precision. Allowed values: float and
double. "units=value" Measure distance, radii of circles, and
tolerance in the specified units. Allowed values: miles (default),
km, feet, meters. "tolerance=distance" Tolerance is the largest
allowable variation in geometry calculations. If the distance
between two points is less than tolerance, then the two points are
considered equal. For the raw coordinate system, use the units of
the coordinates. For geographic coordinate systems, use the units
specified by the units option. "boundaries-included" Points on
boxes', circles', and polygons' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and polygons' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. (of xs:string)ServerExpression circleIntersects(ServerExpression circle, ServerExpression region)
Provides a client interface to the geo:circle-intersects server function.
circle
- A geographic circle. (of cts:circle)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if any region intersects the target circle.
(of cts:region)ServerExpression circleIntersects(ServerExpression circle, ServerExpression region, java.lang.String options)
Provides a client interface to the geo:circle-intersects server function.
circle
- A geographic circle. (of cts:circle)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if any region intersects the target circle.
(of cts:region)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance, radii of circles, and tolerance in the specified units.
Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. "boundaries-included" Points on boxes', circles', and
polygons' boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. (of xs:string)ServerExpression circleIntersects(ServerExpression circle, ServerExpression region, ServerExpression options)
Provides a client interface to the geo:circle-intersects server function.
circle
- A geographic circle. (of cts:circle)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if any region intersects the target circle.
(of cts:region)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance, radii of circles, and tolerance in the specified units.
Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. "boundaries-included" Points on boxes', circles', and
polygons' boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on boxes', circles', and polygons'
boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. (of xs:string)ServerExpression circlePolygon(ServerExpression circle, double arcTolerance)
Provides a client interface to the geo:circle-polygon server function.
circle
- A cts circle that defines the circle to
be approximated. (of cts:circle)arcTolerance
- How far the approximation can be
from the actual circle, specified in the same units as the units
option. Arc-tolerance should be greater than the value of the
tolerance option. (of xs:double)ServerExpression circlePolygon(ServerExpression circle, ServerExpression arcTolerance)
Provides a client interface to the geo:circle-polygon server function.
circle
- A cts circle that defines the circle to
be approximated. (of cts:circle)arcTolerance
- How far the approximation can be
from the actual circle, specified in the same units as the units
option. Arc-tolerance should be greater than the value of the
tolerance option. (of xs:double)ServerExpression circlePolygon(ServerExpression circle, double arcTolerance, java.lang.String options)
Provides a client interface to the geo:circle-polygon server function.
circle
- A cts circle that defines the circle to
be approximated. (of cts:circle)arcTolerance
- How far the approximation can be
from the actual circle, specified in the same units as the units
option. Arc-tolerance should be greater than the value of the
tolerance option. (of xs:double)options
- Options with which you can customize
this operation. The following options are available:
"coordinate-system=value" Use the given coordinate system. Valid
values are wgs84, wgs84/double, etrs89, etrs89/double, raw and
raw/double. Defaults to the governing coordinating system.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. Defaults to the precision of the
governing coordinate system. "units=value" Measure distance, radii
of circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. Tolerance should be
smaller than the value of the arc-tolerance parameter. (of xs:string)ServerExpression circlePolygon(ServerExpression circle, ServerExpression arcTolerance, ServerExpression options)
Provides a client interface to the geo:circle-polygon server function.
circle
- A cts circle that defines the circle to
be approximated. (of cts:circle)arcTolerance
- How far the approximation can be
from the actual circle, specified in the same units as the units
option. Arc-tolerance should be greater than the value of the
tolerance option. (of xs:double)options
- Options with which you can customize
this operation. The following options are available:
"coordinate-system=value" Use the given coordinate system. Valid
values are wgs84, wgs84/double, etrs89, etrs89/double, raw and
raw/double. Defaults to the governing coordinating system.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. Defaults to the precision of the
governing coordinate system. "units=value" Measure distance, radii
of circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. Tolerance should be
smaller than the value of the arc-tolerance parameter. (of xs:string)ServerExpression countDistinctVertices(ServerExpression region)
Provides a client interface to the geo:count-distinct-vertices server function.
region
- A cts region. (of cts:region)ServerExpression countDistinctVertices(ServerExpression region, java.lang.String options)
Provides a client interface to the geo:count-distinct-vertices server function.
region
- A cts region. (of cts:region)options
- Options include:
"coordinate-system=value" Use the given coordinate system. Valid
values are wgs84, wgs84/double, etrs89, etrs89/double, raw and
raw/double. Defaults to the governing coordinating system.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. Defaults to the precision of the
governing coordinate system. "units=value" Measure distance, radii
of circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. (of xs:string)ServerExpression countDistinctVertices(ServerExpression region, ServerExpression options)
Provides a client interface to the geo:count-distinct-vertices server function.
region
- A cts region. (of cts:region)options
- Options include:
"coordinate-system=value" Use the given coordinate system. Valid
values are wgs84, wgs84/double, etrs89, etrs89/double, raw and
raw/double. Defaults to the governing coordinating system.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. Defaults to the precision of the
governing coordinate system. "units=value" Measure distance, radii
of circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. (of xs:string)ServerExpression countVertices(ServerExpression region)
Provides a client interface to the geo:count-vertices server function.
region
- A cts region. (of cts:region)ServerExpression destination(ServerExpression p, double bearing, double distance)
Provides a client interface to the geo:destination server function.
ServerExpression destination(ServerExpression p, ServerExpression bearing, ServerExpression distance)
Provides a client interface to the geo:destination server function.
ServerExpression destination(ServerExpression p, double bearing, double distance, java.lang.String options)
Provides a client interface to the geo:destination server function.
p
- The starting point. (of cts:point)bearing
- The bearing, in radians. (of xs:double)distance
- The distance, in units. See the units
option, below. (of xs:double)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance and the radii of circles in the specified units. Allowed
values: miles (default), km, feet, meters. (of xs:string)ServerExpression destination(ServerExpression p, ServerExpression bearing, ServerExpression distance, ServerExpression options)
Provides a client interface to the geo:destination server function.
p
- The starting point. (of cts:point)bearing
- The bearing, in radians. (of xs:double)distance
- The distance, in units. See the units
option, below. (of xs:double)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance and the radii of circles in the specified units. Allowed
values: miles (default), km, feet, meters. (of xs:string)ServerExpression distance(ServerExpression p1, ServerExpression p2)
Provides a client interface to the geo:distance server function.
ServerExpression distance(ServerExpression p1, ServerExpression p2, java.lang.String options)
Provides a client interface to the geo:distance server function.
p1
- The first point. (of cts:point)p2
- The second point. (of cts:point)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance and the radii of circles in the specified units. Allowed
values: miles (default), km, feet, meters. (of xs:string)ServerExpression distance(ServerExpression p1, ServerExpression p2, ServerExpression options)
Provides a client interface to the geo:distance server function.
p1
- The first point. (of cts:point)p2
- The second point. (of cts:point)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance and the radii of circles in the specified units. Allowed
values: miles (default), km, feet, meters. (of xs:string)ServerExpression distanceConvert(ServerExpression distance, java.lang.String unit1, java.lang.String unit2)
Provides a client interface to the geo:distance-convert server function.
ServerExpression distanceConvert(ServerExpression distance, ServerExpression unit1, ServerExpression unit2)
Provides a client interface to the geo:distance-convert server function.
ServerExpression ellipsePolygon(ServerExpression center, double semiMajorAxis, double semiMinorAxis, double azimuth, double arcTolerance)
Provides a client interface to the geo:ellipse-polygon server function.
center
- Center of the ellipse. (of cts:point)semiMajorAxis
- The semi major axis of the
ellipse. The units are governed by the units option. (of xs:double)semiMinorAxis
- The semi minor axis of the
ellipse. The units are governed by the units option. (of xs:double)azimuth
- The azimuth. (of xs:double)arcTolerance
- How far the approximation can be
from the actual ellipse, specified in the same units as the units
option. Arc-tolerance should be greater than the value of the
tolerance option, which defaults to 0.05km (0.3106856 miles). (of
xs:double)ServerExpression ellipsePolygon(ServerExpression center, ServerExpression semiMajorAxis, ServerExpression semiMinorAxis, ServerExpression azimuth, ServerExpression arcTolerance)
Provides a client interface to the geo:ellipse-polygon server function.
center
- Center of the ellipse. (of cts:point)semiMajorAxis
- The semi major axis of the
ellipse. The units are governed by the units option. (of xs:double)semiMinorAxis
- The semi minor axis of the
ellipse. The units are governed by the units option. (of xs:double)azimuth
- The azimuth. (of xs:double)arcTolerance
- How far the approximation can be
from the actual ellipse, specified in the same units as the units
option. Arc-tolerance should be greater than the value of the
tolerance option, which defaults to 0.05km (0.3106856 miles). (of
xs:double)ServerExpression ellipsePolygon(ServerExpression center, double semiMajorAxis, double semiMinorAxis, double azimuth, double arcTolerance, java.lang.String options)
Provides a client interface to the geo:ellipse-polygon server function.
center
- Center of the ellipse. (of cts:point)semiMajorAxis
- The semi major axis of the
ellipse. The units are governed by the units option. (of xs:double)semiMinorAxis
- The semi minor axis of the
ellipse. The units are governed by the units option. (of xs:double)azimuth
- The azimuth. (of xs:double)arcTolerance
- How far the approximation can be
from the actual ellipse, specified in the same units as the units
option. Arc-tolerance should be greater than the value of the
tolerance option, which defaults to 0.05km (0.3106856 miles). (of
xs:double)options
- Options with which to configure the
behavior. Options include: "coordinate-system=value" Use the given
coordinate system. Valid values are wgs84, wgs84/double, etrs89,
etrs89/double, raw and raw/double. Defaults to the governing
coordinating system. "precision=value" Use the coordinate system at
the given precision. Allowed values: float and double. Defaults to
the precision of the governing coordinate system. "units=value"
Measure distance, the axes of the ellipse, and tolerance in the
specified units. Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)ServerExpression ellipsePolygon(ServerExpression center, ServerExpression semiMajorAxis, ServerExpression semiMinorAxis, ServerExpression azimuth, ServerExpression arcTolerance, ServerExpression options)
Provides a client interface to the geo:ellipse-polygon server function.
center
- Center of the ellipse. (of cts:point)semiMajorAxis
- The semi major axis of the
ellipse. The units are governed by the units option. (of xs:double)semiMinorAxis
- The semi minor axis of the
ellipse. The units are governed by the units option. (of xs:double)azimuth
- The azimuth. (of xs:double)arcTolerance
- How far the approximation can be
from the actual ellipse, specified in the same units as the units
option. Arc-tolerance should be greater than the value of the
tolerance option, which defaults to 0.05km (0.3106856 miles). (of
xs:double)options
- Options with which to configure the
behavior. Options include: "coordinate-system=value" Use the given
coordinate system. Valid values are wgs84, wgs84/double, etrs89,
etrs89/double, raw and raw/double. Defaults to the governing
coordinating system. "precision=value" Use the coordinate system at
the given precision. Allowed values: float and double. Defaults to
the precision of the governing coordinate system. "units=value"
Measure distance, the axes of the ellipse, and tolerance in the
specified units. Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)ServerExpression geohashDecode(java.lang.String hash)
Provides a client interface to the geo:geohash-decode server function.
ServerExpression geohashDecode(ServerExpression hash)
Provides a client interface to the geo:geohash-decode server function.
ServerExpression geohashDecodePoint(java.lang.String hash)
Provides a client interface to the geo:geohash-decode-point server function.
ServerExpression geohashDecodePoint(ServerExpression hash)
Provides a client interface to the geo:geohash-decode-point server function.
ServerExpression geohashEncode(ServerExpression region)
Provides a client interface to the geo:geohash-encode server function.
region
- The region to encode. (of cts:region)ServerExpression geohashEncode(ServerExpression region, long geohashPrecision)
Provides a client interface to the geo:geohash-encode server function.
region
- The region to encode. (of cts:region)geohashPrecision
- The desired precision (length
of the geohash). The precision should be between 1 and 12. If the
precision is less than 1, or unspecified, the default
geohash-precision of 6 is used. A geohash-precision greater than 12
is treated as the same as 12. In the worst case (at the equator) a
precision of 12 gives resolution of less than a centimeter. (of
xs:integer)ServerExpression geohashEncode(ServerExpression region, ServerExpression geohashPrecision)
Provides a client interface to the geo:geohash-encode server function.
region
- The region to encode. (of cts:region)geohashPrecision
- The desired precision (length
of the geohash). The precision should be between 1 and 12. If the
precision is less than 1, or unspecified, the default
geohash-precision of 6 is used. A geohash-precision greater than 12
is treated as the same as 12. In the worst case (at the equator) a
precision of 12 gives resolution of less than a centimeter. (of
xs:integer)ServerExpression geohashEncode(ServerExpression region, long geohashPrecision, java.lang.String options)
Provides a client interface to the geo:geohash-encode server function.
region
- The region to encode. (of cts:region)geohashPrecision
- The desired precision (length
of the geohash). The precision should be between 1 and 12. If the
precision is less than 1, or unspecified, the default
geohash-precision of 6 is used. A geohash-precision greater than 12
is treated as the same as 12. In the worst case (at the equator) a
precision of 12 gives resolution of less than a centimeter. (of
xs:integer)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. Geohashing is not
allowed for non-geodetic coordinate systems. Attempting to use this
function with the raw or raw/double coordinate system will result
in an XDMP-GEOHASH-COORD error. "precision=string" Use the
coordinate system at the given precision. Allowed values: float
(default) and double. "units=value" Measure distance, radii of
circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. geohashes=value Specify
which geohashes to return. Allowed values: all Return a complete
set of covering hashes for the region (boundary + interior). This
is the default behavior. boundary Return only geohashes that
intersect with the boundary of the region. interior Return only
geohashes completely contained in the interior of the region.
exterior Return all geohashes disjoint from the region. That is,
all geohashes completely contained in the exterior of the region.
(of xs:string)ServerExpression geohashEncode(ServerExpression region, ServerExpression geohashPrecision, ServerExpression options)
Provides a client interface to the geo:geohash-encode server function.
region
- The region to encode. (of cts:region)geohashPrecision
- The desired precision (length
of the geohash). The precision should be between 1 and 12. If the
precision is less than 1, or unspecified, the default
geohash-precision of 6 is used. A geohash-precision greater than 12
is treated as the same as 12. In the worst case (at the equator) a
precision of 12 gives resolution of less than a centimeter. (of
xs:integer)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. Geohashing is not
allowed for non-geodetic coordinate systems. Attempting to use this
function with the raw or raw/double coordinate system will result
in an XDMP-GEOHASH-COORD error. "precision=string" Use the
coordinate system at the given precision. Allowed values: float
(default) and double. "units=value" Measure distance, radii of
circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. geohashes=value Specify
which geohashes to return. Allowed values: all Return a complete
set of covering hashes for the region (boundary + interior). This
is the default behavior. boundary Return only geohashes that
intersect with the boundary of the region. interior Return only
geohashes completely contained in the interior of the region.
exterior Return all geohashes disjoint from the region. That is,
all geohashes completely contained in the exterior of the region.
(of xs:string)ServerExpression geohashNeighbors(ServerExpression hash)
Provides a client interface to the geo:geohash-neighbors server function.
ServerExpression geohashPrecisionDimensions(ServerExpression precision)
Provides a client interface to the geo:geohash-precision-dimensions server function.
precision
- The precision. This should be a number
between 0 and 12, as with geo:geohash-encode. (of xs:integer)ServerExpression geohashSubhashes(ServerExpression hash, java.lang.String which)
Provides a client interface to the geo:geohash-subhashes server function.
ServerExpression geohashSubhashes(ServerExpression hash, ServerExpression which)
Provides a client interface to the geo:geohash-subhashes server function.
ServerExpression interiorPoint(ServerExpression region)
Provides a client interface to the geo:interior-point server function.
region
- A cts region. (of cts:region)ServerExpression interiorPoint(ServerExpression region, java.lang.String options)
Provides a client interface to the geo:interior-point server function.
region
- A cts region. (of cts:region)options
- Options include:
"coordinate-system=value" Use the given coordinate system. Valid
values are wgs84, wgs84/double, etrs89, etrs89/double, raw and
raw/double. Defaults to the governing coordinating system.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. Defaults to the precision of the
governing coordinate system. "units=value" Measure distance, radii
of circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. (of xs:string)ServerExpression interiorPoint(ServerExpression region, ServerExpression options)
Provides a client interface to the geo:interior-point server function.
region
- A cts region. (of cts:region)options
- Options include:
"coordinate-system=value" Use the given coordinate system. Valid
values are wgs84, wgs84/double, etrs89, etrs89/double, raw and
raw/double. Defaults to the governing coordinating system.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. Defaults to the precision of the
governing coordinate system. "units=value" Measure distance, radii
of circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. (of xs:string)CtsRegionSeqExpr parseWkt(java.lang.String wkt)
Provides a client interface to the geo:parse-wkt server function.
wkt
- A sequence of strings in Well-Known Text
format. (of xs:string)CtsRegionSeqExpr parseWkt(ServerExpression wkt)
Provides a client interface to the geo:parse-wkt server function.
wkt
- A sequence of strings in Well-Known Text
format. (of xs:string)CtsRegionExpr regionApproximate(ServerExpression region, double threshold)
Provides a client interface to the geo:region-approximate server function.
region
- A cts region. (of cts:region)threshold
- How close the approximation should be,
in the units specified by the units option. (of xs:double)CtsRegionExpr regionApproximate(ServerExpression region, ServerExpression threshold)
Provides a client interface to the geo:region-approximate server function.
region
- A cts region. (of cts:region)threshold
- How close the approximation should be,
in the units specified by the units option. (of xs:double)CtsRegionExpr regionApproximate(ServerExpression region, double threshold, java.lang.String options)
Provides a client interface to the geo:region-approximate server function.
region
- A cts region. (of cts:region)threshold
- How close the approximation should be,
in the units specified by the units option. (of xs:double)options
- Options include:
"coordinate-system=value" Use the given coordinate system. Valid
values are wgs84, wgs84/double, etrs89, etrs89/double, raw and
raw/double. Defaults to the governing coordinating system.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. Defaults to the precision of the
governing coordinate system. "units=value" Measure distance, radii
of circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. Tolerance must be smaller
than the value of the threshold parameter. (of xs:string)CtsRegionExpr regionApproximate(ServerExpression region, ServerExpression threshold, ServerExpression options)
Provides a client interface to the geo:region-approximate server function.
region
- A cts region. (of cts:region)threshold
- How close the approximation should be,
in the units specified by the units option. (of xs:double)options
- Options include:
"coordinate-system=value" Use the given coordinate system. Valid
values are wgs84, wgs84/double, etrs89, etrs89/double, raw and
raw/double. Defaults to the governing coordinating system.
"precision=value" Use the coordinate system at the given precision.
Allowed values: float and double. Defaults to the precision of the
governing coordinate system. "units=value" Measure distance, radii
of circles, and tolerance in the specified units. Allowed values:
miles (default), km, feet, meters. "tolerance=distance" Tolerance
is the largest allowable variation in geometry calculations. If the
distance between two points is less than tolerance, then the two
points are considered equal. For the raw coordinate system, use the
units of the coordinates. For geographic coordinate systems, use
the units specified by the units option. Tolerance must be smaller
than the value of the threshold parameter. (of xs:string)CtsRegionExpr regionClean(ServerExpression region)
Provides a client interface to the geo:region-clean server function.
region
- A cts region. (of cts:region)CtsRegionExpr regionClean(ServerExpression region, java.lang.String options)
Provides a client interface to the geo:region-clean server function.
region
- A cts region. (of cts:region)options
- The tolerance, units, coordinate system.
Options include: "coordinate-system=value" Use the given coordinate
system. Valid values are wgs84, wgs84/double, etrs89,
etrs89/double, raw and raw/double. Defaults to the governing
coordinating system. "precision=value" Use the coordinate system at
the given precision. Allowed values: float and double. Defaults to
the precision of the governing coordinate system. "units=value"
Measure distance, radii of circles, and tolerance in the specified
units. Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)CtsRegionExpr regionClean(ServerExpression region, ServerExpression options)
Provides a client interface to the geo:region-clean server function.
region
- A cts region. (of cts:region)options
- The tolerance, units, coordinate system.
Options include: "coordinate-system=value" Use the given coordinate
system. Valid values are wgs84, wgs84/double, etrs89,
etrs89/double, raw and raw/double. Defaults to the governing
coordinating system. "precision=value" Use the coordinate system at
the given precision. Allowed values: float and double. Defaults to
the precision of the governing coordinate system. "units=value"
Measure distance, radii of circles, and tolerance in the specified
units. Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)ServerExpression regionContains(ServerExpression target, ServerExpression region)
Provides a client interface to the geo:region-contains server function.
target
- A geographic region. (of cts:region)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if target contains any of the regions. (of
cts:region)ServerExpression regionContains(ServerExpression target, ServerExpression region, java.lang.String options)
Provides a client interface to the geo:region-contains server function.
target
- A geographic region. (of cts:region)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if target contains any of the regions. (of
cts:region)options
- Options for the operation. The default
is (). Options include: Options include: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system. wgs84/doubleThe WGS84 coordinate system at
double precision. etrs89The ETRS89 coordinate system.
etrs89/doubleThe ETRS89 coordinate system at double precision.
rawThe raw (unmapped) coordinate system. raw/doubleThe raw
coordinate system at double precision. "precision=value" Use the
coordinate system at the given precision. Allowed values: float and
double. "units=value" Measure distance, radii of circles, and
tolerance in the specified units. Allowed values: miles (default),
km, feet, meters. "tolerance=distance" Tolerance is the largest
allowable variation in geometry calculations. If the distance
between two points is less than tolerance, then the two points are
considered equal. For the raw coordinate system, use the units of
the coordinates. For geographic coordinate systems, use the units
specified by the units option. "boundaries-included" Points on
boxes', circles', and regions' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and regions' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. (of xs:string)ServerExpression regionContains(ServerExpression target, ServerExpression region, ServerExpression options)
Provides a client interface to the geo:region-contains server function.
target
- A geographic region. (of cts:region)region
- One or more geographic regions (boxes,
circles, polygons, or points). Where multiple regions are
specified, return true if target contains any of the regions. (of
cts:region)options
- Options for the operation. The default
is (). Options include: Options include: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system. wgs84/doubleThe WGS84 coordinate system at
double precision. etrs89The ETRS89 coordinate system.
etrs89/doubleThe ETRS89 coordinate system at double precision.
rawThe raw (unmapped) coordinate system. raw/doubleThe raw
coordinate system at double precision. "precision=value" Use the
coordinate system at the given precision. Allowed values: float and
double. "units=value" Measure distance, radii of circles, and
tolerance in the specified units. Allowed values: miles (default),
km, feet, meters. "tolerance=distance" Tolerance is the largest
allowable variation in geometry calculations. If the distance
between two points is less than tolerance, then the two points are
considered equal. For the raw coordinate system, use the units of
the coordinates. For geographic coordinate systems, use the units
specified by the units option. "boundaries-included" Points on
boxes', circles', and regions' boundaries are counted as matching.
This is the default. "boundaries-excluded" Points on boxes',
circles', and regions' boundaries are not counted as matching.
"boundaries-latitude-excluded" Points on boxes' latitude boundaries
are not counted as matching. "boundaries-longitude-excluded" Points
on boxes' longitude boundaries are not counted as matching.
"boundaries-south-excluded" Points on the boxes' southern
boundaries are not counted as matching. "boundaries-west-excluded"
Points on the boxes' western boundaries are not counted as
matching. "boundaries-north-excluded" Points on the boxes' northern
boundaries are not counted as matching. "boundaries-east-excluded"
Points on the boxes' eastern boundaries are not counted as
matching. "boundaries-circle-excluded" Points on circles' boundary
are not counted as matching. "boundaries-endpoints-excluded" Points
on linestrings' boundary (the endpoints) are not counted as
matching. (of xs:string)ServerExpression regionDe9im(ServerExpression region1, ServerExpression region2)
Provides a client interface to the geo:region-de9im server function.
region1
- The first geospatial region to compare.
(of cts:region)region2
- The second geospatial region to compare.
(of cts:region)ServerExpression regionDe9im(ServerExpression region1, ServerExpression region2, java.lang.String options)
Provides a client interface to the geo:region-de9im server function.
region1
- The first geospatial region to compare.
(of cts:region)region2
- The second geospatial region to compare.
(of cts:region)options
- Options to this operation. The default
is (). Available options: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance, radii of circles, and tolerance in the specified units.
Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)ServerExpression regionDe9im(ServerExpression region1, ServerExpression region2, ServerExpression options)
Provides a client interface to the geo:region-de9im server function.
region1
- The first geospatial region to compare.
(of cts:region)region2
- The second geospatial region to compare.
(of cts:region)options
- Options to this operation. The default
is (). Available options: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance, radii of circles, and tolerance in the specified units.
Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)ServerExpression regionIntersects(ServerExpression target, ServerExpression region)
Provides a client interface to the geo:region-intersects server function.
target
- A geographic region (box, circle,
polygon, or point). (of cts:region)region
- One or more geographic regions. Where
multiple regions are specified, return true if any region
intersects the target region. (of cts:region)ServerExpression regionIntersects(ServerExpression target, ServerExpression region, java.lang.String options)
Provides a client interface to the geo:region-intersects server function.
target
- A geographic region (box, circle,
polygon, or point). (of cts:region)region
- One or more geographic regions. Where
multiple regions are specified, return true if any region
intersects the target region. (of cts:region)options
- Options for the operation. The default
is (). Options include: Options include: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system. wgs84/doubleThe WGS84 coordinate system at
double precision. etrs89The ETRS89 coordinate system.
etrs89/doubleThe ETRS89 coordinate system at double precision.
rawThe raw (unmapped) coordinate system. raw/doubleThe raw
coordinate system at double precision. "precision=value" Use the
coordinate system at the given precision. Allowed values: float and
double. "units=value" Measure distance, radii of circles, and
tolerance in the specified units. Allowed values: miles (default),
km, feet, meters. "tolerance=distance" Tolerance is the largest
allowable variation in geometry calculations. If the distance
between two points is less than tolerance, then the two points are
considered equal. For the raw coordinate system, use the units of
the coordinates. For geographic coordinate systems, use the units
specified by the units option. "boundaries-included" Points on
regions' boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on regions' boundaries are not counted
as matching. "boundaries-latitude-excluded" Points on boxes'
latitude boundaries are not counted as matching.
"boundaries-longitude-excluded" Points on boxes' longitude
boundaries are not counted as matching. "boundaries-south-excluded"
Points on the boxes' southern boundaries are not counted as
matching. "boundaries-west-excluded" Points on the boxes' western
boundaries are not counted as matching. "boundaries-north-excluded"
Points on the boxes' northern boundaries are not counted as
matching. "boundaries-east-excluded" Points on the boxes' eastern
boundaries are not counted as matching.
"boundaries-circle-excluded" Points on circles' boundary are not
counted as matching. "boundaries-endpoints-excluded" Points on
linestrings' boundary (the endpoints) are not counted as matching.
(of xs:string)ServerExpression regionIntersects(ServerExpression target, ServerExpression region, ServerExpression options)
Provides a client interface to the geo:region-intersects server function.
target
- A geographic region (box, circle,
polygon, or point). (of cts:region)region
- One or more geographic regions. Where
multiple regions are specified, return true if any region
intersects the target region. (of cts:region)options
- Options for the operation. The default
is (). Options include: Options include: "coordinate-system=string"
Use the given coordinate system. Valid values are: wgs84The WGS84
coordinate system. wgs84/doubleThe WGS84 coordinate system at
double precision. etrs89The ETRS89 coordinate system.
etrs89/doubleThe ETRS89 coordinate system at double precision.
rawThe raw (unmapped) coordinate system. raw/doubleThe raw
coordinate system at double precision. "precision=value" Use the
coordinate system at the given precision. Allowed values: float and
double. "units=value" Measure distance, radii of circles, and
tolerance in the specified units. Allowed values: miles (default),
km, feet, meters. "tolerance=distance" Tolerance is the largest
allowable variation in geometry calculations. If the distance
between two points is less than tolerance, then the two points are
considered equal. For the raw coordinate system, use the units of
the coordinates. For geographic coordinate systems, use the units
specified by the units option. "boundaries-included" Points on
regions' boundaries are counted as matching. This is the default.
"boundaries-excluded" Points on regions' boundaries are not counted
as matching. "boundaries-latitude-excluded" Points on boxes'
latitude boundaries are not counted as matching.
"boundaries-longitude-excluded" Points on boxes' longitude
boundaries are not counted as matching. "boundaries-south-excluded"
Points on the boxes' southern boundaries are not counted as
matching. "boundaries-west-excluded" Points on the boxes' western
boundaries are not counted as matching. "boundaries-north-excluded"
Points on the boxes' northern boundaries are not counted as
matching. "boundaries-east-excluded" Points on the boxes' eastern
boundaries are not counted as matching.
"boundaries-circle-excluded" Points on circles' boundary are not
counted as matching. "boundaries-endpoints-excluded" Points on
linestrings' boundary (the endpoints) are not counted as matching.
(of xs:string)ServerExpression regionRelate(ServerExpression region1, java.lang.String operation, ServerExpression region2)
Provides a client interface to the geo:region-relate server function.
region1
- The first geospatial region to compare.
This region is the left operand of $operation. (of cts:region)operation
- The operation to apply between the
region specified in the $region-1 and $region-2 parameters. Allowed
values: contains, covered-by, covers, crosses, disjoint, equals,
intersects, overlaps, touches, within. See the Usage Notes for
details. (of xs:string)region2
- The second geospatial region to compare.
This region is the right operand of $operation. (of cts:region)ServerExpression regionRelate(ServerExpression region1, ServerExpression operation, ServerExpression region2)
Provides a client interface to the geo:region-relate server function.
region1
- The first geospatial region to compare.
This region is the left operand of $operation. (of cts:region)operation
- The operation to apply between the
region specified in the $region-1 and $region-2 parameters. Allowed
values: contains, covered-by, covers, crosses, disjoint, equals,
intersects, overlaps, touches, within. See the Usage Notes for
details. (of xs:string)region2
- The second geospatial region to compare.
This region is the right operand of $operation. (of cts:region)ServerExpression regionRelate(ServerExpression region1, java.lang.String operation, ServerExpression region2, java.lang.String options)
Provides a client interface to the geo:region-relate server function.
region1
- The first geospatial region to compare.
This region is the left operand of $operation. (of cts:region)operation
- The operation to apply between the
region specified in the $region-1 and $region-2 parameters. Allowed
values: contains, covered-by, covers, crosses, disjoint, equals,
intersects, overlaps, touches, within. See the Usage Notes for
details. (of xs:string)region2
- The second geospatial region to compare.
This region is the right operand of $operation. (of cts:region)options
- Options to this operation. The default
is (). Available options: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance, radii of circles, and tolerance in the specified units.
Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)ServerExpression regionRelate(ServerExpression region1, ServerExpression operation, ServerExpression region2, ServerExpression options)
Provides a client interface to the geo:region-relate server function.
region1
- The first geospatial region to compare.
This region is the left operand of $operation. (of cts:region)operation
- The operation to apply between the
region specified in the $region-1 and $region-2 parameters. Allowed
values: contains, covered-by, covers, crosses, disjoint, equals,
intersects, overlaps, touches, within. See the Usage Notes for
details. (of xs:string)region2
- The second geospatial region to compare.
This region is the right operand of $operation. (of cts:region)options
- Options to this operation. The default
is (). Available options: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. "units=value" Measure
distance, radii of circles, and tolerance in the specified units.
Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)CtsRegionExpr removeDuplicateVertices(ServerExpression region)
Provides a client interface to the geo:remove-duplicate-vertices server function.
region
- A cts region. (of cts:region)CtsRegionExpr removeDuplicateVertices(ServerExpression region, java.lang.String options)
Provides a client interface to the geo:remove-duplicate-vertices server function.
region
- A cts region. (of cts:region)options
- The tolerance, units, coordinate system.
Options include: "coordinate-system=value" Use the given coordinate
system. Valid values are wgs84, wgs84/double, etrs89,
etrs89/double, raw and raw/double. Defaults to the governing
coordinating system. "precision=value" Use the coordinate system at
the given precision. Allowed values: float and double. Defaults to
the precision of the governing coordinate system. "units=value"
Measure distance, radii of circles, and tolerance in the specified
units. Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)CtsRegionExpr removeDuplicateVertices(ServerExpression region, ServerExpression options)
Provides a client interface to the geo:remove-duplicate-vertices server function.
region
- A cts region. (of cts:region)options
- The tolerance, units, coordinate system.
Options include: "coordinate-system=value" Use the given coordinate
system. Valid values are wgs84, wgs84/double, etrs89,
etrs89/double, raw and raw/double. Defaults to the governing
coordinating system. "precision=value" Use the coordinate system at
the given precision. Allowed values: float and double. Defaults to
the precision of the governing coordinate system. "units=value"
Measure distance, radii of circles, and tolerance in the specified
units. Allowed values: miles (default), km, feet, meters.
"tolerance=distance" Tolerance is the largest allowable variation
in geometry calculations. If the distance between two points is
less than tolerance, then the two points are considered equal. For
the raw coordinate system, use the units of the coordinates. For
geographic coordinate systems, use the units specified by the units
option. (of xs:string)ServerExpression shortestDistance(ServerExpression p1, ServerExpression region)
Provides a client interface to the geo:shortest-distance server function.
p1
- The first point. (of cts:point)region
- A region such as a circle, box, polygon,
linestring, or complex-polygon. For compatibility with previous
versions, a sequence of points is interpreted as a sequence of arcs
(defined pairwise) and the distance returned is the shortest
distance to one of those points. If the first parameter is a point
within the region specified in this parameter, then this function
returns 0. If the point specified in the first parameter in not in
the region specified in this parameter, then this function returns
the shortest distance to the boundary of the region. (of cts:region)ServerExpression shortestDistance(ServerExpression p1, ServerExpression region, java.lang.String options)
Provides a client interface to the geo:shortest-distance server function.
p1
- The first point. (of cts:point)region
- A region such as a circle, box, polygon,
linestring, or complex-polygon. For compatibility with previous
versions, a sequence of points is interpreted as a sequence of arcs
(defined pairwise) and the distance returned is the shortest
distance to one of those points. If the first parameter is a point
within the region specified in this parameter, then this function
returns 0. If the point specified in the first parameter in not in
the region specified in this parameter, then this function returns
the shortest distance to the boundary of the region. (of cts:region)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "units=value" Measure distance and the radii of circles
in the specified units. Allowed values: miles (default), km, feet,
meters. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. (of xs:string)ServerExpression shortestDistance(ServerExpression p1, ServerExpression region, ServerExpression options)
Provides a client interface to the geo:shortest-distance server function.
p1
- The first point. (of cts:point)region
- A region such as a circle, box, polygon,
linestring, or complex-polygon. For compatibility with previous
versions, a sequence of points is interpreted as a sequence of arcs
(defined pairwise) and the distance returned is the shortest
distance to one of those points. If the first parameter is a point
within the region specified in this parameter, then this function
returns 0. If the point specified in the first parameter in not in
the region specified in this parameter, then this function returns
the shortest distance to the boundary of the region. (of cts:region)options
- Options for the operation. The default
is (). Options include: "coordinate-system=string" Use the given
coordinate system. Valid values are: wgs84The WGS84 coordinate
system. wgs84/doubleThe WGS84 coordinate system at double
precision. etrs89The ETRS89 coordinate system. etrs89/doubleThe
ETRS89 coordinate system at double precision. rawThe raw (unmapped)
coordinate system. raw/doubleThe raw coordinate system at double
precision. "units=value" Measure distance and the radii of circles
in the specified units. Allowed values: miles (default), km, feet,
meters. "precision=value" Use the coordinate system at the given
precision. Allowed values: float and double. (of xs:string)ServerExpression toWkt(ServerExpression wkt)
Provides a client interface to the geo:to-wkt server function.
wkt
- A sequence of geospatial regions. (of
cts:region)ServerExpression validateWkt(ServerExpression wkt)
Provides a client interface to the geo:validate-wkt server function.
wkt
- A string to validate. (of xs:string)Copyright © 2013-2021 MarkLogic Corporation.