com.aerospike.client.query

Class Filter

java.lang.Object

com.aerospike.client.query.Filter

public final class Filter
extends Object

Query filter definition.

Method Summary

Methods

Modifier and Type	Method and 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.
static Filter	equal(String name, Value value) Deprecated.
int	estimateSize() Estimate filter's byte send when sending command to server.
IndexCollectionType	getCollectionType() Retrieve index collection type.
static Filter	range(String name, IndexCollectionType type, long begin, long end) Create range filter for query on collection index.
static Filter	range(String name, long begin, long end) Create range filter for query.
static Filter	range(String name, Value begin, Value end) Deprecated.
int	write(byte[] buf, int offset) Write filter to send command buffer.

Methods inherited from class java.lang.Object

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

Method Detail

equal

public static Filter equal(String name,
           long value)

Create long equality filter for query.

Parameters:

name - bin name

value - filter value

Returns:

filter instance

equal

public static Filter equal(String name,
           String value)

Create string equality filter for query.

Parameters:

name - bin name

value - filter value

Returns:

filter instance

equal

public static Filter equal(String name,
           Value value)

Deprecated.

Create equality filter for query. This method exists for backward compatibility only. Do not use.

Parameters:

name - bin name

value - filter value

Returns:

filter instance

contains

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

Create contains number filter for query on collection index.

Parameters:

name - bin name

type - index collection type

value - filter value

Returns:

filter instance

contains

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

Create contains string filter for query on collection index.

Parameters:

name - bin name

type - index collection type

value - filter value

Returns:

filter instance

range

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

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

end - filter end value

Returns:

filter instance

range

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

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

end - filter end value

Returns:

filter instance

range

public static Filter range(String name,
           Value begin,
           Value end)

Deprecated.

Create range filter for query. Range arguments must be longs or integers which can be cast to longs. String ranges are not supported. This method exists for backward compatibility only. Do not use.

Parameters:

name - bin name

begin - filter begin value

end - filter end value

Returns:

filter instance

estimateSize

public int estimateSize()
                 throws AerospikeException

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

Throws:

AerospikeException

write

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

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

Throws:

AerospikeException

getCollectionType

public IndexCollectionType getCollectionType()

Retrieve index collection type. For internal use only.