java.lang.Object | ||
↳ | com.kinvey.java.query.AbstractQuery | |
↳ | com.kinvey.java.Query |
Query API for creating query requests to AppData store.
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Query(QueryFilter.QueryFilterBuilder builder)
Constructor for Query API.
| |||||||||||
Query()
Constructor for Query API.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Query |
all(String key, Object[] value)
Add a filter condition for a specific field holds an array and containsa ll the values
| ||||||||||
Query |
and(AbstractQuery query)
Joins a second Query filter to the current query object and connects them with a logical AND
| ||||||||||
Query |
endsWith(String key, Object value)
Add a filter condition for a specific field for strings that ends with the given value.
| ||||||||||
Query |
equals(String key, Object value)
Add a filter condition for a specific field being equal to a value
| ||||||||||
int | getLimit() | ||||||||||
int | getSkip() | ||||||||||
String | getSortString() | ||||||||||
Query |
greaterThan(String key, Object value)
Add a filter condition for a specific field being greater than a value
| ||||||||||
Query |
greaterThanEqualTo(String key, Object value)
Add a filter condition for a specific field being greater than or equal to a value
| ||||||||||
Query |
in(String key, Object[] value)
Add a filter condition for a specific field being in an array of values
| ||||||||||
boolean | isQueryEmpty() | ||||||||||
Query |
lessThan(String key, Object value)
Add a filter condition for a specific field being less than than a value
| ||||||||||
Query |
lessThanEqualTo(String key, Object value)
Add a filter condition for a specific field being less than or equal to a value
| ||||||||||
Query |
nearSphere(String field, double lat, double lon, double maxDistance)
Used on Geospatial fields to return all points near a given point.
| ||||||||||
Query |
nearSphere(String field, double lat, double lon)
Used on Geospatial fields to return all points near a given point.
| ||||||||||
Query |
not()
Negates the current query's comparison operators
| ||||||||||
Query |
notEqual(String key, Object value)
Add a filter condition for a specific field being not equal to a value
| ||||||||||
Query |
notIn(String key, Object[] value)
Add a filter condition for a specific field being not in an array of values
| ||||||||||
Query |
or(AbstractQuery query)
Joins a second Query filter to the current query object and connects them with a logical OR
| ||||||||||
Query |
regEx(String key, Object value)
Add a filter condition for a specific field compared to a regular expression
| ||||||||||
Query |
setLimit(int limit)
Sets the maximum number of records to return
| ||||||||||
Query |
setSkip(int skip)
Sets the number of records to skip before returning the results (useful for pagination).
| ||||||||||
Query |
size(String key, int value)
Add a filter for any array that is of the given size
| ||||||||||
Query |
startsWith(String key, Object value)
Add a filter condition for a specific field for strings that start with the given value.
| ||||||||||
AbstractQuery | withinBox(String field, double pointOneLat, double pointOneLon, double pointTwoLat, double pointTwoLon) | ||||||||||
AbstractQuery | withinPolygon(String field, double pointOneLat, double pointOneLon, double pointTwoLat, double pointTwoLon, double pointThreeLat, double pointThreeLon, double pointFourLat, double pointFourLon) |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Constructor for Query API. Used to instantiate a query request.
builder | that implements QueryFilter.builder |
---|
Constructor for Query API. Used to instantiate a query request. defaults to using a Mongo DB Query Filter.
Add a filter condition for a specific field holds an array and containsa ll the values
key | Field to filter on |
---|---|
value | An array of values Values |
Joins a second Query filter to the current query object and connects them with a logical AND
query | The query which contains the QueryFilter to be joined |
---|
Add a filter condition for a specific field for strings that ends with the given value.
key | Field to filter on |
---|---|
value | Value condition for filter |
Add a filter condition for a specific field being equal to a value
key | Field to filter on |
---|---|
value | Value condition for filter |
Add a filter condition for a specific field being greater than a value
key | Field to filter on |
---|---|
value | Value condition for filter |
Add a filter condition for a specific field being greater than or equal to a value
key | Field to filter on |
---|---|
value | Value condition for filter |
Add a filter condition for a specific field being in an array of values
key | Field to filter on |
---|---|
value | An array of values |
Add a filter condition for a specific field being less than than a value
key | Field to filter on |
---|---|
value | Value condition for filter |
Add a filter condition for a specific field being less than or equal to a value
key | Field to filter on |
---|---|
value | Value condition for filter |
Used on Geospatial fields to return all points near a given point.
field | The geolocation field to filter on |
---|---|
lat | latitude |
lon | longitude |
maxDistance | The maximum distance a geolocation point can be from the given point |
Used on Geospatial fields to return all points near a given point.
field | The geolocation field to filter on |
---|---|
lat | latitude |
lon | longitude |
Add a filter condition for a specific field being not equal to a value
key | Field to filter on |
---|---|
value | Value condition for filter |
Add a filter condition for a specific field being not in an array of values
key | Field to filter on |
---|---|
value | An array of values |
Joins a second Query filter to the current query object and connects them with a logical OR
query | The query which contains the QueryFilter to be joined |
---|
Add a filter condition for a specific field compared to a regular expression
key | Field to filter on |
---|---|
value | Value condition for filter |
Sets the maximum number of records to return
limit | The maximum number of records to return |
---|
Sets the number of records to skip before returning the results (useful for pagination).
Add a filter for any array that is of the given size
key | Field to filter on |
---|---|
value | The expected size of the array |
Add a filter condition for a specific field for strings that start with the given value.
key | Field to filter on |
---|---|
value | Value condition for filter |