com.aerospike.client.query

Class Filter

java.lang.Object

com.aerospike.client.query.Filter

public final class Filter
extends Object

Query filter definition. Currently, only one filter is allowed in a Statement, and must be on bin which has a secondary index defined.

Method Summary

Modifier and Type	Method and Description
static Filter	contains(Expression exp, IndexCollectionType type, byte[] value) Create contains byte[] filter for query on collection index with expression.
static Filter	contains(Expression exp, IndexCollectionType type, long value) Create contains number filter for query on collection index with Expression.
static Filter	contains(Expression exp, IndexCollectionType type, String value) Create contains string filter for query on collection index with Expression.
static Filter	contains(String name, IndexCollectionType type, byte[] value, CTX... ctx) Create contains byte[] filter for query on collection index.
static Filter	contains(String name, IndexCollectionType type, long value, CTX... ctx) Create contains number filter for query on collection index.
static Filter	contains(String name, IndexCollectionType type, String value, CTX... ctx) Create contains string filter for query on collection index.
static Filter	containsByIndex(String indexName, IndexCollectionType type, byte[] value) Create contains byte[] filter for query on collection index with index name.
static Filter	containsByIndex(String indexName, IndexCollectionType type, long value) Create contains number filter for query on collection index with index name.
static Filter	containsByIndex(String indexName, IndexCollectionType type, String value) Create contains string filter for query on collection index with index name.
static Filter	equal(Expression exp, byte[] value) Create blob equality filter for query with Expression.
static Filter	equal(Expression exp, long value) Create long equality filter for query with Expression.
static Filter	equal(Expression exp, String value) Create string equality filter for query with Expression.
static Filter	equal(String name, byte[] value, CTX... ctx) Create blob equality filter for query.
static Filter	equal(String name, long value, CTX... ctx) Create long equality filter for query.
static Filter	equal(String name, String value, CTX... ctx) Create string equality filter for query.
static Filter	equalByIndex(String indexName, byte[] value) Create blob equality filter for query with index name.
static Filter	equalByIndex(String indexName, long value) Create long equality filter for query with index name.
static Filter	equalByIndex(String indexName, String value) Create string equality filter for query with index name.
boolean	equals(Object obj) Check for Filter equality.
int	estimateSize() Estimate filter's byte send when sending command to server.
static Filter	geoContains(Expression exp, IndexCollectionType type, String point) Create geospatial "containing point" filter for query on collection index with expression.
static Filter	geoContains(Expression exp, String point) Create geospatial "containing point" filter for query with expression.
static Filter	geoContains(String name, IndexCollectionType type, String point, CTX... ctx) Create geospatial "containing point" filter for query on collection index.
static Filter	geoContains(String name, String point, CTX... ctx) Create geospatial "containing point" filter for query.
static Filter	geoContainsByIndex(String indexName, IndexCollectionType type, String point) Create geospatial "containing point" filter for query on collection index with index name.
static Filter	geoContainsByIndex(String indexName, String point) Create geospatial "containing point" filter for query with index name.
static Filter	geoWithinRadius(Expression exp, double lng, double lat, double radius) Create geospatial "within radius" filter for query with expression.
static Filter	geoWithinRadius(Expression exp, IndexCollectionType type, double lng, double lat, double radius) Create geospatial "within radius" filter for query on collection index with expression.
static Filter	geoWithinRadius(String name, double lng, double lat, double radius, CTX... ctx) Create geospatial "within radius" filter for query.
static Filter	geoWithinRadius(String name, IndexCollectionType type, double lng, double lat, double radius, CTX... ctx) Create geospatial "within radius" filter for query on collection index.
static Filter	geoWithinRadiusByIndex(String indexName, double lng, double lat, double radius) Create geospatial "within radius" filter for query with index name.
static Filter	geoWithinRadiusByIndex(String indexName, IndexCollectionType type, double lng, double lat, double radius) Create geospatial "within radius" filter for query on collection index with index name.
static Filter	geoWithinRegion(Expression exp, IndexCollectionType type, String region) Create geospatial "within region" filter for query on collection index with expression.
static Filter	geoWithinRegion(Expression exp, String region) Create geospatial "within region" filter for query with expression.
static Filter	geoWithinRegion(String name, IndexCollectionType type, String region, CTX... ctx) Create geospatial "within region" filter for query on collection index.
static Filter	geoWithinRegion(String name, String region, CTX... ctx) Create geospatial "within region" filter for query.
static Filter	geoWithinRegionByIndex(String indexName, IndexCollectionType type, String region) Create geospatial "within region" filter for query on collection index with index name.
static Filter	geoWithinRegionByIndex(String indexName, String region) Create geospatial "within region" filter for query with index name.
Value	getBegin() Filter begin value.
IndexCollectionType	getCollectionType() Retrieve index collection type.
IndexCollectionType	getColType() Index collection type.
Value	getEnd() Filter begin value.
String	getIndexName() Index name.
String	getName() Filter name.
byte[]	getPackedCtx() Retrieve packed Context.
byte[]	getPackedExp() Retrieve packed Expression.
int	getValType() Filter Value type.
int	hashCode() Generate Filter hashCode.
static Filter	range(Expression exp, IndexCollectionType type, long begin, long end) Create range filter for query on collection index with expression.
static Filter	range(Expression exp, long begin, long end) Create a range filter for an Expression-based Secondary Index (SI) query, with the actual Expression that was used to create the SI.
static Filter	range(String name, IndexCollectionType type, long begin, long end, CTX... ctx) Create range filter for query on collection index.
static Filter	range(String name, long begin, long end, CTX... ctx) Create range filter for query.
static Filter	rangeByIndex(String indexName, IndexCollectionType type, long begin, long end) Create range filter for query on collection index with index name.
static Filter	rangeByIndex(String indexName, long begin, long end) Create a range filter for an Expression-based Secondary Index (SI) query, using the SI name Range arguments must be longs or integers which can be cast to longs.
int	write(byte[] buf, int offset) Write filter to send command buffer.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

equal

public static Filter equal(String name,
                           long value,
                           CTX... ctx)

Create long equality filter for query.

Parameters:

name - bin name

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

equal

public static Filter equal(Expression exp,
                           long value)

Create long equality filter for query with Expression.

Parameters:

exp - the Expression

value - filter value

Returns:

filter instance

equalByIndex

public static Filter equalByIndex(String indexName,
                                  long value)

Create long equality filter for query with index name.

Parameters:

indexName - the name that was assigned to the Secondary Index (SI)

value - filter value

Returns:

filter instance

equal

public static Filter equal(String name,
                           String value,
                           CTX... ctx)

Create string equality filter for query.

Parameters:

name - bin name

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

equal

public static Filter equal(Expression exp,
                           String value)

Create string equality filter for query with Expression.

Parameters:

exp - the Expression

value - filter value

Returns:

filter instance

equalByIndex

public static Filter equalByIndex(String indexName,
                                  String value)

Create string equality filter for query with index name.

Parameters:

indexName - the name that was assigned to the Secondary Index (SI)

value - filter value

Returns:

filter instance

equal

public static Filter equal(String name,
                           byte[] value,
                           CTX... ctx)

Create blob equality filter for query. Requires server version 7.0+.

Parameters:

name - bin name

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

equal

public static Filter equal(Expression exp,
                           byte[] value)

Create blob equality filter for query with Expression.

Parameters:

exp - the Expression

value - filter value

Returns:

filter instance

equalByIndex

public static Filter equalByIndex(String indexName,
                                  byte[] value)

Create blob equality filter for query with index name.

Parameters:

indexName - the name that was assigned to the Secondary Index (SI)

value - filter value

Returns:

filter instance

contains

public static Filter contains(String name,
                              IndexCollectionType type,
                              long value,
                              CTX... ctx)

Create contains number filter for query on collection index.

Parameters:

name - bin name

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

contains

public static Filter contains(Expression exp,
                              IndexCollectionType type,
                              long value)

Create contains number filter for query on collection index with Expression.

Parameters:

exp - expression to use for the filter

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

containsByIndex

public static Filter containsByIndex(String indexName,
                                     IndexCollectionType type,
                                     long value)

Create contains number filter for query on collection index with index name.

Parameters:

indexName - index name

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

contains

public static Filter contains(String name,
                              IndexCollectionType type,
                              String value,
                              CTX... ctx)

Create contains string filter for query on collection index.

Parameters:

name - bin name

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

contains

public static Filter contains(Expression exp,
                              IndexCollectionType type,
                              String value)

Create contains string filter for query on collection index with Expression.

Parameters:

exp - expression to use for the filter

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

containsByIndex

public static Filter containsByIndex(String indexName,
                                     IndexCollectionType type,
                                     String value)

Create contains string filter for query on collection index with index name.

Parameters:

indexName - index name

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

contains

public static Filter contains(String name,
                              IndexCollectionType type,
                              byte[] value,
                              CTX... ctx)

Create contains byte[] filter for query on collection index.

Parameters:

name - bin name

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

contains

public static Filter contains(Expression exp,
                              IndexCollectionType type,
                              byte[] value)

Create contains byte[] filter for query on collection index with expression.

Parameters:

exp - expression to use for the filter

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

containsByIndex

public static Filter containsByIndex(String indexName,
                                     IndexCollectionType type,
                                     byte[] value)

Create contains byte[] filter for query on collection index with index name.

Parameters:

indexName - index name

type - index collection type

value - filter value

ctx - optional context for elements within a CDT

Returns:

filter instance

range

public static Filter range(String name,
                           long begin,
                           long end,
                           CTX... ctx)

Create range filter for query. Range arguments must be longs or integers which can be cast to longs. String ranges are not supported.

Parameters:

name - bin name

begin - filter begin value inclusive

end - filter end value inclusive

ctx - optional context for elements within a CDT

Returns:

filter instance

range

public static Filter range(Expression exp,
                           long begin,
                           long end)

Create a range filter for an Expression-based Secondary Index (SI) query, with the actual Expression that was used to create the SI. Range arguments must be longs or integers which can be cast to longs. String ranges are not supported.

Parameters:

exp - the Expression

begin - filter begin value inclusive

end - filter end value inclusive

Returns:

filter instance

rangeByIndex

public static Filter rangeByIndex(String indexName,
                                  long begin,
                                  long end)

Create a range filter for an Expression-based Secondary Index (SI) query, using the SI name Range arguments must be longs or integers which can be cast to longs. String ranges are not supported.

Parameters:

indexName - the name that was assigned to the SI

begin - filter begin value inclusive

end - filter end value inclusive

Returns:

filter instance

range

public static Filter range(String name,
                           IndexCollectionType type,
                           long begin,
                           long end,
                           CTX... ctx)

Create range filter for query on collection index. Range arguments must be longs or integers which can be cast to longs. String ranges are not supported.

Parameters:

name - bin name

type - index collection type

begin - filter begin value inclusive

end - filter end value inclusive

ctx - optional context for elements within a CDT

Returns:

filter instance

range

public static Filter range(Expression exp,
                           IndexCollectionType type,
                           long begin,
                           long end)

Create range filter for query on collection index with expression. Range arguments must be longs or integers which can be cast to longs. String ranges are not supported.

Parameters:

expression - the Expression to use for the filter

type - index collection type

begin - filter begin value inclusive

end - filter end value inclusive

ctx - optional context for elements within a CDT

Returns:

filter instance

rangeByIndex

public static Filter rangeByIndex(String indexName,
                                  IndexCollectionType type,
                                  long begin,
                                  long end)

Create range filter for query on collection index with index name. Range arguments must be longs or integers which can be cast to longs. String ranges are not supported.

Parameters:

indexName - index name

type - index collection type

begin - filter begin value inclusive

end - filter end value inclusive

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRegion

public static Filter geoWithinRegion(String name,
                                     String region,
                                     CTX... ctx)

Create geospatial "within region" filter for query.

Parameters:

name - bin name

region - GeoJSON region

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRegion

public static Filter geoWithinRegion(Expression exp,
                                     String region)

Create geospatial "within region" filter for query with expression.

Parameters:

exp - the Expression to use for the filter

region - GeoJSON region

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRegionByIndex

public static Filter geoWithinRegionByIndex(String indexName,
                                            String region)

Create geospatial "within region" filter for query with index name.

Parameters:

indexName - index name

region - GeoJSON region

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRegion

public static Filter geoWithinRegion(String name,
                                     IndexCollectionType type,
                                     String region,
                                     CTX... ctx)

Create geospatial "within region" filter for query on collection index.

Parameters:

name - bin name

type - index collection type

region - GeoJSON region

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRegion

public static Filter geoWithinRegion(Expression exp,
                                     IndexCollectionType type,
                                     String region)

Create geospatial "within region" filter for query on collection index with expression.

Parameters:

exp - the Expression to use for the filter

type - index collection type

region - GeoJSON region

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRegionByIndex

public static Filter geoWithinRegionByIndex(String indexName,
                                            IndexCollectionType type,
                                            String region)

Create geospatial "within region" filter for query on collection index with index name.

Parameters:

indexName - index name

type - index collection type

region - GeoJSON region

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRadius

public static Filter geoWithinRadius(String name,
                                     double lng,
                                     double lat,
                                     double radius,
                                     CTX... ctx)

Create geospatial "within radius" filter for query.

Parameters:

name - bin name

lng - longitude

lat - latitude

radius - radius (meters)

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRadius

public static Filter geoWithinRadius(Expression exp,
                                     double lng,
                                     double lat,
                                     double radius)

Create geospatial "within radius" filter for query with expression.

Parameters:

exp - the Expression to use for the filter

lng - longitude

lat - latitude

radius - radius (meters)

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRadiusByIndex

public static Filter geoWithinRadiusByIndex(String indexName,
                                            double lng,
                                            double lat,
                                            double radius)

Create geospatial "within radius" filter for query with index name.

Parameters:

indexName - index name

lng - longitude

lat - latitude

radius - radius (meters)

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRadius

public static Filter geoWithinRadius(String name,
                                     IndexCollectionType type,
                                     double lng,
                                     double lat,
                                     double radius,
                                     CTX... ctx)

Create geospatial "within radius" filter for query on collection index.

Parameters:

name - bin name

type - index collection type

lng - longitude

lat - latitude

radius - radius (meters)

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRadius

public static Filter geoWithinRadius(Expression exp,
                                     IndexCollectionType type,
                                     double lng,
                                     double lat,
                                     double radius)

Create geospatial "within radius" filter for query on collection index with expression.

Parameters:

exp - the Expression to use for the filter

type - index collection type

lng - longitude

lat - latitude

radius - radius (meters)

ctx - optional context for elements within a CDT

Returns:

filter instance

geoWithinRadiusByIndex

public static Filter geoWithinRadiusByIndex(String indexName,
                                            IndexCollectionType type,
                                            double lng,
                                            double lat,
                                            double radius)

Create geospatial "within radius" filter for query on collection index with index name.

Parameters:

indexName - index name

type - index collection type

lng - longitude

lat - latitude

radius - radius (meters)

ctx - optional context for elements within a CDT

Returns:

filter instance

geoContains

public static Filter geoContains(String name,
                                 String point,
                                 CTX... ctx)

Create geospatial "containing point" filter for query.

Parameters:

name - bin name

point - GeoJSON point

ctx - optional context for elements within a CDT

Returns:

filter instance

geoContains

public static Filter geoContains(Expression exp,
                                 String point)

Create geospatial "containing point" filter for query with expression.

Parameters:

exp - the Expression to use for the filter

point - GeoJSON point

ctx - optional context for elements within a CDT

Returns:

filter instance

geoContainsByIndex

public static Filter geoContainsByIndex(String indexName,
                                        String point)

Create geospatial "containing point" filter for query with index name.

Parameters:

indexName - index name

point - GeoJSON point

ctx - optional context for elements within a CDT

Returns:

filter instance

geoContains

public static Filter geoContains(String name,
                                 IndexCollectionType type,
                                 String point,
                                 CTX... ctx)

Create geospatial "containing point" filter for query on collection index.

Parameters:

name - bin name

type - index collection type

point - GeoJSON point

ctx - optional context for elements within a CDT

Returns:

filter instance

geoContains

public static Filter geoContains(Expression exp,
                                 IndexCollectionType type,
                                 String point)

Create geospatial "containing point" filter for query on collection index with expression.

Parameters:

exp - the Expression to use for the filter

type - index collection type

point - GeoJSON point

ctx - optional context for elements within a CDT

Returns:

filter instance

geoContainsByIndex

public static Filter geoContainsByIndex(String indexName,
                                        IndexCollectionType type,
                                        String point)

Create geospatial "containing point" filter for query on collection index with index name.

Parameters:

indexName - index name

type - index collection type

point - GeoJSON point

ctx - optional context for elements within a CDT

Returns:

filter instance

estimateSize

public int estimateSize()

Estimate filter's byte send when sending command to server. For internal use only.

write

public int write(byte[] buf,
                 int offset)

Write filter to send command buffer. For internal use only.

getCollectionType

public IndexCollectionType getCollectionType()

Retrieve index collection type. For internal use only.

getName

public String getName()

Filter name. For internal use only.

getIndexName

public String getIndexName()

Index name. For internal use only.

getColType

public IndexCollectionType getColType()

Index collection type. For internal use only.

getBegin

public Value getBegin()

Filter begin value. For internal use only.

getEnd

public Value getEnd()

Filter begin value. For internal use only.

getValType

public int getValType()

Filter Value type. For internal use only.

getPackedCtx

public byte[] getPackedCtx()

Retrieve packed Context. For internal use only.

getPackedExp

public byte[] getPackedExp()

Retrieve packed Expression. For internal use only.

equals

public boolean equals(Object obj)

Check for Filter equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Generate Filter hashCode.

Overrides:

hashCode in class Object