GeoSpatialQuery (Blazegraph Database Platform 2.1.5 API)

java.lang.Object
- com.bigdata.service.geospatial.impl.GeoSpatialQuery

All Implemented Interfaces:

IGeoSpatialQuery
```
public class GeoSpatialQuery
extends Object
implements IGeoSpatialQuery
```
Implementation of the IGeoSpatialQuery interface.

Version:

$Id$

Author:

Michael Schmidt

Nested Class Summary
- Nested classes/interfaces inherited from interface com.bigdata.service.geospatial.IGeoSpatialQuery
  IGeoSpatialQuery.LowerAndUpperBound, IGeoSpatialQuery.LowerAndUpperValue

Constructor Summary

Constructors
Constructor and Description
GeoSpatialQuery(GeoSpatialConfig geoSpatialConfig, GeoSpatial.GeoFunction searchFunction, org.openrdf.model.URI searchDatatype, IConstant<?> subject, TermNode predicate, TermNode context, GeoSpatialUtility.PointLatLon spatialCircleCenter, Double spatialCircleRadius, GeoSpatialUtility.PointLatLon spatialRectangleSouthWest, GeoSpatialUtility.PointLatLon spatialRectangleNorthEast, ICoordinate.UNITS spatialUnit, Long timeStart, Long timeEnd, Long coordSystem, Map<String,IGeoSpatialQuery.LowerAndUpperValue> customFieldsConstraints, IVariable<?> locationVar, IVariable<?> timeVar, IVariable<?> locationAndTimeVar, IVariable<?> latVar, IVariable<?> lonVar, IVariable<?> coordSystemVar, IVariable<?> customFieldsVar, IVariable<?> literalVar, IVariable<?> distanceVar, IBindingSet incomingBindings) Constructor

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().
`static Map<String,IGeoSpatialQuery.LowerAndUpperValue>`	`toValidatedCustomFieldsConstraints(String[] customFields, Object[] customFieldsLowerBounds, Object[] customFieldsUpperBounds)` Constructs a validated custom fields constraints from the parsed user input.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GeoSpatialQuery
```
public GeoSpatialQuery(GeoSpatialConfig geoSpatialConfig,
               GeoSpatial.GeoFunction searchFunction,
               org.openrdf.model.URI searchDatatype,
               IConstant<?> subject,
               TermNode predicate,
               TermNode context,
               GeoSpatialUtility.PointLatLon spatialCircleCenter,
               Double spatialCircleRadius,
               GeoSpatialUtility.PointLatLon spatialRectangleSouthWest,
               GeoSpatialUtility.PointLatLon spatialRectangleNorthEast,
               ICoordinate.UNITS spatialUnit,
               Long timeStart,
               Long timeEnd,
               Long coordSystem,
               Map<String,IGeoSpatialQuery.LowerAndUpperValue> customFieldsConstraints,
               IVariable<?> locationVar,
               IVariable<?> timeVar,
               IVariable<?> locationAndTimeVar,
               IVariable<?> latVar,
               IVariable<?> lonVar,
               IVariable<?> coordSystemVar,
               IVariable<?> customFieldsVar,
               IVariable<?> literalVar,
               IVariable<?> distanceVar,
               IBindingSet incomingBindings)
```
    Constructor
- Method Detail
  - toValidatedCustomFieldsConstraints
```
public static Map<String,IGeoSpatialQuery.LowerAndUpperValue> toValidatedCustomFieldsConstraints(String[] customFields,
                                                                                 Object[] customFieldsLowerBounds,
                                                                                 Object[] customFieldsUpperBounds)
```
    Constructs a validated custom fields constraints from the parsed user input. Throws an exception if the input arity does not match or is invalid (i.e., a lower bound is specified to be larger than an upper bound).
    
    Parameters:
    customFields - the custom field definitions
    customFieldsLowerBounds - the lower bounds for the custom fields definition (needs to have same arity)
    customFieldsUpperBounds - the upper bounds for the custom fields definition (needs to have same arity)
    
    Returns:
  - getSearchFunction
```
public GeoSpatial.GeoFunction getSearchFunction()
```
    Specified by:
    
    getSearchFunction in interface IGeoSpatialQuery
    
    Returns:
    the search function underlying the query
  - getSearchDatatype
```
public org.openrdf.model.URI getSearchDatatype()
```
    Specified by:
    
    getSearchDatatype in interface IGeoSpatialQuery
    
    Returns:
    the datatype of literals we're searching for
  - getSubject
```
public IConstant<?> getSubject()
```
    Specified by:
    
    getSubject in interface IGeoSpatialQuery
    
    Returns:
    the constant representing the search subject
  - getPredicate
```
public TermNode getPredicate()
```
    Specified by:
    
    getPredicate in interface IGeoSpatialQuery
    
    Returns:
    the term node representing the search predicate
  - getContext
```
public TermNode getContext()
```
    Specified by:
    
    getContext in interface IGeoSpatialQuery
    
    Returns:
    the term node representing the search context (named graph)
  - getSpatialCircleCenter
```
public GeoSpatialUtility.PointLatLon getSpatialCircleCenter()
```
    Specified by:
    
    getSpatialCircleCenter in interface IGeoSpatialQuery
    
    Returns:
    the spatial circle center, in case this is a GeoSpatial.GeoFunction.IN_CIRCLE query
  - getSpatialCircleRadius
```
public Double getSpatialCircleRadius()
```
    Specified by:
    
    getSpatialCircleRadius in interface IGeoSpatialQuery
    
    Returns:
    the spatial circle radius, in case this is a GeoSpatial.GeoFunction.IN_CIRCLE query
  - getSpatialRectangleSouthWest
```
public GeoSpatialUtility.PointLatLon getSpatialRectangleSouthWest()
```
    Specified by:
    
    getSpatialRectangleSouthWest in interface IGeoSpatialQuery
    
    Returns:
    the boundary box'es south-west border point.
  - getSpatialRectangleNorthEast
```
public GeoSpatialUtility.PointLatLon getSpatialRectangleNorthEast()
```
    Specified by:
    
    getSpatialRectangleNorthEast in interface IGeoSpatialQuery
    
    Returns:
    the boundary box'es north-east border point.
  - getSpatialUnit
```
public ICoordinate.UNITS getSpatialUnit()
```
    Specified by:
    
    getSpatialUnit in interface IGeoSpatialQuery
    
    Returns:
    the spatial unit underlying the query
  - getTimeStart
```
public Long getTimeStart()
```
    Specified by:
    
    getTimeStart in interface IGeoSpatialQuery
    
    Returns:
    the start timestamp
  - getTimeEnd
```
public Long getTimeEnd()
```
    Specified by:
    
    getTimeEnd in interface IGeoSpatialQuery
    
    Returns:
    the end timestamp
  - getCoordSystem
```
public Long getCoordSystem()
```
    Specified by:
    
    getCoordSystem in interface IGeoSpatialQuery
    
    Returns:
    the coordinate system ID
  - getCustomFieldsConstraints
```
public Map<String,IGeoSpatialQuery.LowerAndUpperValue> getCustomFieldsConstraints()
```
    Specified by:
    
    getCustomFieldsConstraints in interface IGeoSpatialQuery
    
    Returns:
    the custom fields
  - getLocationVar
```
public IVariable<?> getLocationVar()
```
    Specified by:
    
    getLocationVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the location will be bound (if defined)
  - getTimeVar
```
public IVariable<?> getTimeVar()
```
    Specified by:
    
    getTimeVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the time will be bound (if defined)
  - getLatVar
```
public IVariable<?> getLatVar()
```
    Specified by:
    
    getLatVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the latitude will be bound (if defined)
  - getLonVar
```
public IVariable<?> getLonVar()
```
    Specified by:
    
    getLonVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the longitude will be bound (if defined)
  - getCoordSystemVar
```
public IVariable<?> getCoordSystemVar()
```
    Specified by:
    
    getCoordSystemVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the coordinate system component will be bound (if defined)
  - getCustomFieldsVar
```
public IVariable<?> getCustomFieldsVar()
```
    Specified by:
    
    getCustomFieldsVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the custom fields will be bound (if defined)
  - getLocationAndTimeVar
```
public IVariable<?> getLocationAndTimeVar()
```
    Specified by:
    
    getLocationAndTimeVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the location+time will be bound (if defined)
  - getLiteralVar
```
public IVariable<?> getLiteralVar()
```
    Specified by:
    
    getLiteralVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the literal value will be bound
  - getDistanceVar
```
public IVariable<?> getDistanceVar()
```
    Specified by:
    
    getDistanceVar in interface IGeoSpatialQuery
    
    Returns:
    the variable to which the distance value will be bound
  - getIncomingBindings
```
public IBindingSet getIncomingBindings()
```
    Specified by:
    
    getIncomingBindings in interface IGeoSpatialQuery
    
    Returns:
    the incoming bindings to join with
  - getLowerAndUpperBound
```
public IGeoSpatialQuery.LowerAndUpperBound getLowerAndUpperBound()
```
    Specified by:
    
    getLowerAndUpperBound in interface IGeoSpatialQuery
    
    Returns:
    a structure containing the lower and upper bound component object defined by this query
  - normalize
```
public List<IGeoSpatialQuery> normalize()
```
    Description copied from interface: IGeoSpatialQuery
    
    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[.
    
    Specified by:
    
    normalize in interface IGeoSpatialQuery
  - isNormalized
```
public boolean isNormalized()
```
    Specified by:
    
    isNormalized in interface IGeoSpatialQuery
    
    Returns:
    true if the query is normalized. See
  - isSatisfiable
```
public boolean isSatisfiable()
```
    Specified by:
    
    isSatisfiable in interface IGeoSpatialQuery
    
    Returns:
    true if the query is satisfiable
  - getDatatypeConfig
```
public GeoSpatialDatatypeConfiguration getDatatypeConfig()
```
    Specified by:
    
    getDatatypeConfig in interface IGeoSpatialQuery
    
    Returns:
    the datatype configuration associated with the query

Class GeoSpatialQuery

Nested Class Summary

Nested classes/interfaces inherited from interface com.bigdata.service.geospatial.IGeoSpatialQuery

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GeoSpatialQuery

Method Detail

toValidatedCustomFieldsConstraints

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