com.github.mohitgoyal91.cosmosdbqueryutils.restriction

Class GeoSpatialRestriction

java.lang.Object

com.github.mohitgoyal91.cosmosdbqueryutils.restriction.Restriction

com.github.mohitgoyal91.cosmosdbqueryutils.restriction.GeoSpatialRestriction

All Implemented Interfaces:

AddRestrictionInterface, GeoSpatialRestrictionExtractor, RestrictionInterface

public class GeoSpatialRestriction
extends Restriction
implements GeoSpatialRestrictionExtractor

The type Geo spatial restriction.

Field Summary

Fields inherited from class com.github.mohitgoyal91.cosmosdbqueryutils.restriction.Restriction

restrictionExpressionList

Constructor Summary

Constructors

Constructor and Description
GeoSpatialRestriction()

Method Summary

Modifier and Type	Method and Description
void	addRestriction(String propertyName, Object value, String comparator) Add restriction.
GeoSpatialRestriction	and() to separate the previous and next restrictions by an 'AND'
GeoSpatialRestriction	eq(String propertyName, GeoSpatialObject geoSpatialObject, Double value) To introduce a ST_DISTANCE restriction in the query with a =
GeoSpatialRestriction	gt(String propertyName, GeoSpatialObject geoSpatialObject, Double value) To introduce a ST_DISTANCE restriction in the query with a >
GeoSpatialRestriction	gte(String propertyName, GeoSpatialObject geoSpatialObject, Double value) To introduce a ST_DISTANCE restriction in the query with a >=
GeoSpatialRestriction	lt(String propertyName, GeoSpatialObject geoSpatialObject, Double value) To introduce a ST_DISTANCE restriction in the query with a <
GeoSpatialRestriction	lte(String propertyName, GeoSpatialObject geoSpatialObject, Double value) To introduce a ST_DISTANCE restriction in the query with a <=
GeoSpatialRestriction	notEq(String propertyName, GeoSpatialObject geoSpatialObject, Double value) To introduce a ST_DISTANCE restriction in the query with a !=
GeoSpatialRestriction	or() to separate the previous and next restrictions by an 'OR'
GeoSpatialRestriction	within(String propertyName, GeoSpatialObject geoSpatialObject) To introduce a WITHIN restriction in the query

Methods inherited from class com.github.mohitgoyal91.cosmosdbqueryutils.restriction.Restriction

appendGroupedRestrictions, appendRestrictions, build, filterRestrictions, getBuildCompleted, getLogicalCombiner, getRestrictionExpressionList, setBuildCompleted, setLogicalCombiner, setRestrictionExpressionList

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeoSpatialRestriction

public GeoSpatialRestriction()

Method Detail

eq

public GeoSpatialRestriction eq(String propertyName,
                                GeoSpatialObject geoSpatialObject,
                                Double value)

To introduce a ST_DISTANCE restriction in the query with a =

Specified by:

eq in interface GeoSpatialRestrictionExtractor

Parameters:

propertyName - property on which the restriction needs to be applied

geoSpatialObject - GeoSpatialObject

value - distance value which should be compared

Returns:

current instance of GeoSpatialRestriction

notEq

public GeoSpatialRestriction notEq(String propertyName,
                                   GeoSpatialObject geoSpatialObject,
                                   Double value)

To introduce a ST_DISTANCE restriction in the query with a !=

Specified by:

notEq in interface GeoSpatialRestrictionExtractor

Parameters:

propertyName - property on which the restriction needs to be applied

geoSpatialObject - GeoSpatialObject

value - distance value which should be compared

Returns:

current instance of GeoSpatialRestriction

lt

public GeoSpatialRestriction lt(String propertyName,
                                GeoSpatialObject geoSpatialObject,
                                Double value)

To introduce a ST_DISTANCE restriction in the query with a <

Specified by:

lt in interface GeoSpatialRestrictionExtractor

Parameters:

propertyName - property on which the restriction needs to be applied

geoSpatialObject - GeoSpatialObject

value - distance value which should be compared

Returns:

current instance of GeoSpatialRestriction

lte

public GeoSpatialRestriction lte(String propertyName,
                                 GeoSpatialObject geoSpatialObject,
                                 Double value)

To introduce a ST_DISTANCE restriction in the query with a <=

Specified by:

lte in interface GeoSpatialRestrictionExtractor

Parameters:

propertyName - property on which the restriction needs to be applied

geoSpatialObject - GeoSpatialObject

value - distance value which should be compared

Returns:

current instance of GeoSpatialRestriction

gt

public GeoSpatialRestriction gt(String propertyName,
                                GeoSpatialObject geoSpatialObject,
                                Double value)

To introduce a ST_DISTANCE restriction in the query with a >

Specified by:

gt in interface GeoSpatialRestrictionExtractor

Parameters:

propertyName - property on which the restriction needs to be applied

geoSpatialObject - GeoSpatialObject

value - distance value which should be compared

Returns:

current instance of GeoSpatialRestriction

gte

public GeoSpatialRestriction gte(String propertyName,
                                 GeoSpatialObject geoSpatialObject,
                                 Double value)

To introduce a ST_DISTANCE restriction in the query with a >=

Specified by:

gte in interface GeoSpatialRestrictionExtractor

Parameters:

propertyName - property on which the restriction needs to be applied

geoSpatialObject - GeoSpatialObject

value - distance value which should be compared

Returns:

current instance of GeoSpatialRestriction

within

public GeoSpatialRestriction within(String propertyName,
                                    GeoSpatialObject geoSpatialObject)

To introduce a WITHIN restriction in the query

Specified by:

within in interface GeoSpatialRestrictionExtractor

Parameters:

propertyName - property on which the restriction needs to be applied

geoSpatialObject - GeoSpatialObject

Returns:

current instance of GeoSpatialRestriction

addRestriction

public void addRestriction(String propertyName,
                           Object value,
                           String comparator)

Description copied from interface: AddRestrictionInterface

Add restriction.

Specified by:

addRestriction in interface AddRestrictionInterface

Parameters:

propertyName - the property name

value - the value

comparator - the comparator

and

public GeoSpatialRestriction and()

to separate the previous and next restrictions by an 'AND'

Specified by:

and in interface RestrictionInterface

Returns:

current instance of GeoSpatialRestriction

or

public GeoSpatialRestriction or()

to separate the previous and next restrictions by an 'OR'

Specified by:

or in interface RestrictionInterface

Returns:

current instance of GeoSpatialRestriction