Package org.springframework.data.aerospike.query.qualifier

Class Qualifier

java.lang.Object

org.springframework.data.aerospike.query.qualifier.Qualifier

All Implemented Interfaces:

Serializable, Map<QualifierKey,Object>, CriteriaDefinition

public class Qualifier
extends Object
implements CriteriaDefinition, Map<QualifierKey,Object>, Serializable

Generic Bin qualifier. It acts as a filter to exclude records that do not meet the given criteria.

For the list of the supported operations see FilterOperation

Author:

Peter Milne

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.aerospike.repository.query.CriteriaDefinition

CriteriaDefinition.AerospikeMetadata, CriteriaDefinition.AerospikeNullQueryCriterion, CriteriaDefinition.AerospikeQueryCriterion

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
static Qualifier	and(Qualifier... qualifiers)	Create a parent qualifier that contains the given qualifiers combined using logical AND
static QualifierBuilder	builder()
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<QualifierKey,Object>>	entrySet()
Object	get(Object key)
String	getBinName()
String	getCriteriaField()	Get the identifying field.
Qualifier	getCriteriaObject()	Get Filter representation.
com.aerospike.client.cdt.CTX[]	getCtxArray()	Set CTX[].
List<String>	getDotPath()
com.aerospike.client.exp.Exp	getFilterExp()
Object	getId()
com.aerospike.client.Value	getKey()
CriteriaDefinition.AerospikeMetadata	getMetadataField()
FilterOperation	getOperation()
String	getPath()
Qualifier[]	getQualifiers()
com.aerospike.client.query.Filter	getSecondaryIndexFilter()
com.aerospike.client.Value	getSecondValue()
com.aerospike.client.Value	getValue()
boolean	hasId()
boolean	hasMetadataField()
boolean	hasPath()
boolean	hasQualifiers()
Boolean	hasSecIndexFilter()
boolean	hasSingleId()
boolean	hasValue()
static Qualifier	idEquals(byte[] id)	Create a qualifier for the condition when the primary key equals the given byte array
static Qualifier	idEquals(Byte id)	Create a qualifier for the condition when the primary key equals the given byte
static Qualifier	idEquals(Character id)	Create a qualifier for the condition when the primary key equals the given character
static Qualifier	idEquals(Integer id)	Create a qualifier for the condition when the primary key equals the given integer
static Qualifier	idEquals(Long id)	Create a qualifier for the condition when the primary key equals the given long
static Qualifier	idEquals(Short id)	Create a qualifier for the condition when the primary key equals the given short
static Qualifier	idEquals(String id)	Create a qualifier for the condition when the primary key equals the given string
static Qualifier	idIn(byte[]... ids)	Create a qualifier for the condition when the primary key equals one of the given byte arrays (logical OR)
static Qualifier	idIn(Byte... ids)	Create a qualifier for the condition when the primary key equals one of the given bytes (logical OR)
static Qualifier	idIn(Character... ids)	Create a qualifier for the condition when the primary key equals one of the given characters (logical OR)
static Qualifier	idIn(Integer... ids)	Create a qualifier for the condition when the primary key equals one of the given integers (logical OR)
static Qualifier	idIn(Long... ids)	Create a qualifier for the condition when the primary key equals one of the given longs (logical OR)
static Qualifier	idIn(Short... ids)	Create a qualifier for the condition when the primary key equals one of the given shorts (logical OR)
static Qualifier	idIn(String... ids)	Create a qualifier for the condition when the primary key equals one of the given strings (logical OR)
boolean	isEmpty()
Set<QualifierKey>	keySet()
static MetadataQualifierBuilder	metadataBuilder()
static Qualifier	or(Qualifier... qualifiers)	Create a parent qualifier that contains the given qualifiers combined using logical OR
Object	put(QualifierKey key, Object value)
void	putAll(Map<? extends QualifierKey,?> m)
Object	remove(Object key)
void	setDataSettings(AerospikeDataSettings dataSettings)
void	setHasSecIndexFilter(Boolean queryAsFilter)
int	size()
String	toString()
Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Details

getCriteriaObject

public Qualifier getCriteriaObject()

Description copied from interface: CriteriaDefinition

Get Filter representation.

Specified by:

getCriteriaObject in interface CriteriaDefinition

getCriteriaField

public String getCriteriaField()

Description copied from interface: CriteriaDefinition

Get the identifying field.

Specified by:

getCriteriaField in interface CriteriaDefinition

builder

@Beta
public static QualifierBuilder builder()

metadataBuilder

@Beta
public static MetadataQualifierBuilder metadataBuilder()

getOperation

public FilterOperation getOperation()

getBinName

public String getBinName()

hasPath

public boolean hasPath()

getPath

public String getPath()

hasMetadataField

public boolean hasMetadataField()

getMetadataField

public CriteriaDefinition.AerospikeMetadata getMetadataField()

setHasSecIndexFilter

public void setHasSecIndexFilter(Boolean queryAsFilter)

hasSecIndexFilter

public Boolean hasSecIndexFilter()

setDataSettings

public void setDataSettings(AerospikeDataSettings dataSettings)

hasQualifiers

public boolean hasQualifiers()

hasId

public boolean hasId()

hasSingleId

public boolean hasSingleId()

getId

public Object getId()

getCtxArray

public com.aerospike.client.cdt.CTX[] getCtxArray()

Set CTX[].

getQualifiers

public Qualifier[] getQualifiers()

getKey

public com.aerospike.client.Value getKey()

hasValue

public boolean hasValue()

getValue

public com.aerospike.client.Value getValue()

getSecondValue

public com.aerospike.client.Value getSecondValue()

getDotPath

public List<String> getDotPath()

getSecondaryIndexFilter

public com.aerospike.client.query.Filter getSecondaryIndexFilter()

getFilterExp

public com.aerospike.client.exp.Exp getFilterExp()

size

public int size()

Specified by:

size in interface Map<QualifierKey,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<QualifierKey,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<QualifierKey,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<QualifierKey,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<QualifierKey,Object>

put

public Object put(QualifierKey key,
 Object value)

Specified by:

put in interface Map<QualifierKey,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<QualifierKey,Object>

putAll

public void putAll(Map<? extends QualifierKey,?> m)

Specified by:

putAll in interface Map<QualifierKey,Object>

clear

public void clear()

Specified by:

clear in interface Map<QualifierKey,Object>

keySet

public Set<QualifierKey> keySet()

Specified by:

keySet in interface Map<QualifierKey,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<QualifierKey,Object>

entrySet

public Set<Map.Entry<QualifierKey,Object>> entrySet()

Specified by:

entrySet in interface Map<QualifierKey,Object>

toString

public String toString()

Overrides:

toString in class Object

idEquals

public static Qualifier idEquals(String id)

Create a qualifier for the condition when the primary key equals the given string

Parameters:

id - String value

Returns:

Single id qualifier

idEquals

public static Qualifier idEquals(Short id)

Create a qualifier for the condition when the primary key equals the given short

Parameters:

id - Short value

Returns:

Single id qualifier

idEquals

public static Qualifier idEquals(Integer id)

Create a qualifier for the condition when the primary key equals the given integer

Parameters:

id - Integer value

Returns:

Single id qualifier

idEquals

public static Qualifier idEquals(Long id)

Create a qualifier for the condition when the primary key equals the given long

Parameters:

id - Long value

Returns:

Single id qualifier

idEquals

public static Qualifier idEquals(Character id)

Create a qualifier for the condition when the primary key equals the given character

Parameters:

id - Character value

Returns:

Single id qualifier

idEquals

public static Qualifier idEquals(Byte id)

Create a qualifier for the condition when the primary key equals the given byte

Parameters:

id - Byte value

Returns:

Single id qualifier

idEquals

public static Qualifier idEquals(byte[] id)

Create a qualifier for the condition when the primary key equals the given byte array

Parameters:

id - Byte array value

Returns:

Single id qualifier

idIn

public static Qualifier idIn(String... ids)

Create a qualifier for the condition when the primary key equals one of the given strings (logical OR)

Parameters:

ids - String values

Returns:

Multiple ids qualifier with OR condition

idIn

public static Qualifier idIn(Short... ids)

Create a qualifier for the condition when the primary key equals one of the given shorts (logical OR)

Parameters:

ids - Short values

Returns:

Multiple ids qualifier with OR condition

idIn

public static Qualifier idIn(Integer... ids)

Create a qualifier for the condition when the primary key equals one of the given integers (logical OR)

Parameters:

ids - Integer values

Returns:

Multiple ids qualifier with OR condition

idIn

public static Qualifier idIn(Long... ids)

Create a qualifier for the condition when the primary key equals one of the given longs (logical OR)

Parameters:

ids - Long values

Returns:

Multiple ids qualifier with OR condition

idIn

public static Qualifier idIn(Character... ids)

Create a qualifier for the condition when the primary key equals one of the given characters (logical OR)

Parameters:

ids - Character values

Returns:

Multiple ids qualifier with OR condition

idIn

public static Qualifier idIn(Byte... ids)

Create a qualifier for the condition when the primary key equals one of the given bytes (logical OR)

Parameters:

ids - Byte values

Returns:

Multiple ids qualifier with OR condition

idIn

public static Qualifier idIn(byte[]... ids)

Create a qualifier for the condition when the primary key equals one of the given byte arrays (logical OR)

Parameters:

ids - Byte array values

Returns:

Multiple ids qualifier with OR condition

or

public static Qualifier or(Qualifier... qualifiers)

Create a parent qualifier that contains the given qualifiers combined using logical OR

Parameters:

qualifiers - Two or more qualifiers

Returns:

Parent qualifier

and

public static Qualifier and(Qualifier... qualifiers)

Create a parent qualifier that contains the given qualifiers combined using logical AND

Parameters:

qualifiers - Two or more qualifiers

Returns:

Parent qualifier