IGeoSpatialQuery (Blazegraph Database Platform 2.1.5 API)

All Known Implementing Classes:

GeoSpatialQuery
```
public interface IGeoSpatialQuery
```
Interface representing (the configuration of) a geospatial query. See also GeoSpatial for the vocabulary that can be used to define such a query as SERVICE (or inline).

Version:

$Id$

Author:

Michael Schmidt

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IGeoSpatialQuery.LowerAndUpperBound` Helper class encapsulating both the lower and upper bound as implied by the query, for the given datatype configuration.
`static class`	`IGeoSpatialQuery.LowerAndUpperValue`

Method Summary

Methods
Modifier and Type	Method and Description
`TermNode`	`getContext()`
`Long`	`getCoordSystem()`
`IVariable<?>`	`getCoordSystemVar()`
`Map<String,IGeoSpatialQuery.LowerAndUpperValue>`	`getCustomFieldsConstraints()`
`IVariable<?>`	`getCustomFieldsVar()`
`GeoSpatialDatatypeConfiguration`	`getDatatypeConfig()`
`IVariable<?>`	`getDistanceVar()`
`IBindingSet`	`getIncomingBindings()`
`IVariable<?>`	`getLatVar()`
`IVariable<?>`	`getLiteralVar()`
`IVariable<?>`	`getLocationAndTimeVar()`
`IVariable<?>`	`getLocationVar()`
`IVariable<?>`	`getLonVar()`
`IGeoSpatialQuery.LowerAndUpperBound`	`getLowerAndUpperBound()`
`TermNode`	`getPredicate()`
`org.openrdf.model.URI`	`getSearchDatatype()`
`GeoSpatial.GeoFunction`	`getSearchFunction()`
`GeoSpatialUtility.PointLatLon`	`getSpatialCircleCenter()`
`Double`	`getSpatialCircleRadius()`
`GeoSpatialUtility.PointLatLon`	`getSpatialRectangleNorthEast()`
`GeoSpatialUtility.PointLatLon`	`getSpatialRectangleSouthWest()`
`ICoordinate.UNITS`	`getSpatialUnit()`
`IConstant<?>`	`getSubject()`
`Long`	`getTimeEnd()`
`Long`	`getTimeStart()`
`IVariable<?>`	`getTimeVar()`
`boolean`	`isNormalized()`
`boolean`	`isSatisfiable()`
`List<IGeoSpatialQuery>`	`normalize()` Normalizes a GeoSpatial query by converting it into an list of GeoSpatial queries that are normalized, see isNormalized().

- Method Detail
  - getSearchFunction
```
GeoSpatial.GeoFunction getSearchFunction()
```
    Returns:
    the search function underlying the query
  - getSearchDatatype
```
org.openrdf.model.URI getSearchDatatype()
```
    Returns:
    the datatype of literals we're searching for
  - getSubject
```
IConstant<?> getSubject()
```
    Returns:
    the constant representing the search subject
  - getPredicate
```
TermNode getPredicate()
```
    Returns:
    the term node representing the search predicate
  - getContext
```
TermNode getContext()
```
    Returns:
    the term node representing the search context (named graph)
  - getSpatialCircleCenter
```
GeoSpatialUtility.PointLatLon getSpatialCircleCenter()
```
    Returns:
    the spatial circle center, in case this is a GeoSpatial.GeoFunction.IN_CIRCLE query
  - getSpatialCircleRadius
```
Double getSpatialCircleRadius()
```
    Returns:
    the spatial circle radius, in case this is a GeoSpatial.GeoFunction.IN_CIRCLE query
  - getSpatialRectangleSouthWest
```
GeoSpatialUtility.PointLatLon getSpatialRectangleSouthWest()
```
    Returns:
    the boundary box'es south-west border point.
  - getSpatialRectangleNorthEast
```
GeoSpatialUtility.PointLatLon getSpatialRectangleNorthEast()
```
    Returns:
    the boundary box'es north-east border point.
  - getSpatialUnit
```
ICoordinate.UNITS getSpatialUnit()
```
    Returns:
    the spatial unit underlying the query
  - getTimeStart
```
Long getTimeStart()
```
    Returns:
    the start timestamp
  - getTimeEnd
```
Long getTimeEnd()
```
    Returns:
    the end timestamp
  - getCoordSystem
```
Long getCoordSystem()
```
    Returns:
    the coordinate system ID
  - getCustomFieldsConstraints
```
Map<String,IGeoSpatialQuery.LowerAndUpperValue> getCustomFieldsConstraints()
```
    Returns:
    the custom fields
  - getLocationVar
```
IVariable<?> getLocationVar()
```
    Returns:
    the variable to which the location will be bound (if defined)
  - getTimeVar
```
IVariable<?> getTimeVar()
```
    Returns:
    the variable to which the time will be bound (if defined)
  - getLatVar
```
IVariable<?> getLatVar()
```
    Returns:
    the variable to which the latitude will be bound (if defined)
  - getLonVar
```
IVariable<?> getLonVar()
```
    Returns:
    the variable to which the longitude will be bound (if defined)
  - getCoordSystemVar
```
IVariable<?> getCoordSystemVar()
```
    Returns:
    the variable to which the coordinate system component will be bound (if defined)
  - getCustomFieldsVar
```
IVariable<?> getCustomFieldsVar()
```
    Returns:
    the variable to which the custom fields will be bound (if defined)
  - getLocationAndTimeVar
```
IVariable<?> getLocationAndTimeVar()
```
    Returns:
    the variable to which the location+time will be bound (if defined)
  - getLiteralVar
```
IVariable<?> getLiteralVar()
```
    Returns:
    the variable to which the literal value will be bound
  - getDistanceVar
```
IVariable<?> getDistanceVar()
```
    Returns:
    the variable to which the distance value will be bound
  - getIncomingBindings
```
IBindingSet getIncomingBindings()
```
    Returns:
    the incoming bindings to join with
  - getLowerAndUpperBound
```
IGeoSpatialQuery.LowerAndUpperBound getLowerAndUpperBound()
```
    Returns:
    a structure containing the lower and upper bound component object defined by this query
  - normalize
```
List<IGeoSpatialQuery> normalize()
```
    Normalizes a GeoSpatial query by converting it into an list of GeoSpatial queries that are normalized, see isNormalized(). The list of queries may be empty if the given query contains unsatisfiable range restrictions (e.g., a timestamp or longitude range from [9;8]. However, note that a latitude range from [10;0] will be interpreted as "everything not in the interval ]0;10[.
  - isNormalized
```
boolean isNormalized()
```
    Returns:
    true if the query is normalized. See
  - isSatisfiable
```
boolean isSatisfiable()
```
    Returns:
    true if the query is satisfiable
  - getDatatypeConfig
```
GeoSpatialDatatypeConfiguration getDatatypeConfig()
```
    Returns:
    the datatype configuration associated with the query

Interface IGeoSpatialQuery

Nested Class Summary

Method Summary

Method Detail

getSearchFunction

getSearchDatatype

getSubject

getPredicate

getContext

getSpatialCircleCenter

getSpatialCircleRadius

getSpatialRectangleSouthWest

getSpatialRectangleNorthEast

getSpatialUnit

getTimeStart

getTimeEnd

getCoordSystem

getCustomFieldsConstraints

getLocationVar

getTimeVar

getLatVar

getLonVar

getCoordSystemVar

getCustomFieldsVar

getLocationAndTimeVar

getLiteralVar

getDistanceVar

getIncomingBindings

getLowerAndUpperBound

normalize

isNormalized

isSatisfiable

getDatatypeConfig