Package 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 Description static Filter
contains(String name, IndexCollectionType type, long value)
Create contains number filter for query on collection index.static Filter
contains(String name, IndexCollectionType type, String value)
Create contains string filter for query on collection index.static Filter
equal(String name, long value)
Create long equality filter for query.static Filter
equal(String name, String value)
Create string equality filter for query.boolean
equals(Object obj)
Check for Filter equality.int
estimateSize()
Estimate filter's byte send when sending command to server.static Filter
geoContains(String name, IndexCollectionType type, String point)
Create geospatial "containing point" filter for query on collection index.static Filter
geoContains(String name, String point)
Create geospatial "containing point" filter for query.static Filter
geoWithinRadius(String name, double lng, double lat, double radius)
Create geospatial "within radius" filter for query.static Filter
geoWithinRadius(String name, IndexCollectionType type, double lng, double lat, double radius)
Create geospatial "within radius" filter for query on collection index.static Filter
geoWithinRegion(String name, IndexCollectionType type, String region)
Create geospatial "within region" filter for query on collection index.static Filter
geoWithinRegion(String name, String region)
Create geospatial "within region" filter for query.IndexCollectionType
getCollectionType()
Retrieve index collection type.int
hashCode()
Generate Filter hashCode.static Filter
range(String name, long begin, long end)
Create range filter for query.static Filter
range(String name, IndexCollectionType type, long begin, long end)
Create range filter for query on collection index.int
write(byte[] buf, int offset)
Write filter to send command buffer.
-
Method Details
-
equal
Create long equality filter for query.- Parameters:
name
- bin namevalue
- filter value- Returns:
- filter instance
-
equal
Create string equality filter for query.- Parameters:
name
- bin namevalue
- filter value- Returns:
- filter instance
-
contains
Create contains number filter for query on collection index.- Parameters:
name
- bin nametype
- index collection typevalue
- filter value- Returns:
- filter instance
-
contains
Create contains string filter for query on collection index.- Parameters:
name
- bin nametype
- index collection typevalue
- filter value- Returns:
- filter instance
-
range
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 namebegin
- filter begin value inclusiveend
- filter end value inclusive- Returns:
- filter instance
-
range
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 nametype
- index collection typebegin
- filter begin value inclusiveend
- filter end value inclusive- Returns:
- filter instance
-
geoWithinRegion
Create geospatial "within region" filter for query.- Parameters:
name
- bin nameregion
- GeoJSON region- Returns:
- filter instance
-
geoWithinRegion
Create geospatial "within region" filter for query on collection index.- Parameters:
name
- bin nametype
- index collection typeregion
- GeoJSON region- Returns:
- filter instance
-
geoWithinRadius
Create geospatial "within radius" filter for query.- Parameters:
name
- bin namelng
- longitudelat
- latituderadius
- radius (meters)- Returns:
- filter instance
-
geoWithinRadius
public static Filter geoWithinRadius(String name, IndexCollectionType type, double lng, double lat, double radius)Create geospatial "within radius" filter for query on collection index.- Parameters:
name
- bin nametype
- index collection typelng
- longitudelat
- latituderadius
- radius (meters)- Returns:
- filter instance
-
geoContains
Create geospatial "containing point" filter for query.- Parameters:
name
- bin namepoint
- GeoJSON point- Returns:
- filter instance
-
geoContains
Create geospatial "containing point" filter for query on collection index.- Parameters:
name
- bin nametype
- index collection typepoint
- GeoJSON point.- Returns:
- filter instance
-
estimateSize
Estimate filter's byte send when sending command to server. For internal use only.- Throws:
AerospikeException
-
write
Write filter to send command buffer. For internal use only.- Throws:
AerospikeException
-
getCollectionType
Retrieve index collection type. For internal use only. -
equals
Check for Filter equality. -
hashCode
public int hashCode()Generate Filter hashCode.
-