com.aerospike.client.large

Class LargeSet

java.lang.Object

com.aerospike.client.large.LargeSet

public final class LargeSet
extends Object

Create and manage a Large Set within a single bin.

Constructor Summary

Constructors

Constructor and Description
LargeSet(AerospikeClient client, WritePolicy policy, Key key, String binName, String userModule) Initialize large set operator.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(List<?> values) Add values to the set.
void	add(Value... values) Add values to the set.
void	add(Value value) Add a value to the set.
void	destroy() Delete bin containing the set.
boolean	exists(Value value) Check existence of value in the set.
List<?>	filter(String filterName, Value... filterArgs) Select values from set and apply specified Lua filter.
Object	get(Value value) Select value from set.
int	getCapacity() Return maximum number of entries in the set.
Map<?,?>	getConfig() Return map of set configuration parameters.
void	remove(Value value) Delete value from set.
List<?>	scan() Return list of all objects in the set.
void	setCapacity(int capacity) Set maximum number of entries in the set.
int	size() Return size of set.

Methods inherited from class java.lang.Object

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

Constructor Detail

LargeSet

public LargeSet(AerospikeClient client,
        WritePolicy policy,
        Key key,
        String binName,
        String userModule)

Initialize large set operator.

Parameters:

client - client

policy - generic configuration parameters, pass in null for defaults

key - unique record identifier

binName - bin name

userModule - Lua function name that initializes list configuration parameters, pass null for default set

Method Detail

add

public final void add(Value value)
               throws AerospikeException

Add a value to the set. If the set does not exist, create it using specified userModule configuration.

Parameters:

value - value to add

Throws:

AerospikeException

add

public final void add(Value... values)
               throws AerospikeException

Add values to the set. If the set does not exist, create it using specified userModule configuration.

Parameters:

values - values to add

Throws:

AerospikeException

add

public final void add(List<?> values)
               throws AerospikeException

Add values to the set. If the set does not exist, create it using specified userModule configuration.

Parameters:

values - values to add

Throws:

AerospikeException

remove

public final void remove(Value value)
                  throws AerospikeException

Delete value from set.

Parameters:

value - value to delete

Throws:

AerospikeException

get

public final Object get(Value value)
                 throws AerospikeException

Select value from set.

Parameters:

value - value to select

Returns:

found value

Throws:

AerospikeException

exists

public final boolean exists(Value value)
                     throws AerospikeException

Check existence of value in the set.

Parameters:

value - value to check

Returns:

true if found, otherwise false

Throws:

AerospikeException

scan

public final List<?> scan()
                   throws AerospikeException

Return list of all objects in the set.

Throws:

AerospikeException

filter

public final List<?> filter(String filterName,
             Value... filterArgs)
                     throws AerospikeException

Select values from set and apply specified Lua filter.

Parameters:

filterName - Lua function name which applies filter to returned list

filterArgs - arguments to Lua function name

Returns:

list of entries selected

Throws:

AerospikeException

destroy

public final void destroy()
                   throws AerospikeException

Delete bin containing the set.

Throws:

AerospikeException

size

public final int size()
               throws AerospikeException

Return size of set.

Throws:

AerospikeException

getConfig

public final Map<?,?> getConfig()
                         throws AerospikeException

Return map of set configuration parameters.

Throws:

AerospikeException

setCapacity

public final void setCapacity(int capacity)
                       throws AerospikeException

Set maximum number of entries in the set.

Parameters:

capacity - max entries in set

Throws:

AerospikeException

getCapacity

public final int getCapacity()
                      throws AerospikeException

Return maximum number of entries in the set.

Throws:

AerospikeException