com.aerospike.client
Class LargeSet

java.lang.Object
  extended by com.aerospike.client.LargeSet

public final class LargeSet
extends java.lang.Object

Create and manage a list within a single bin.


Constructor Summary
LargeSet(AerospikeClient client, Policy policy, Key key, java.lang.String binName)
          Initialize large set operator.
 
Method Summary
 void create(java.lang.String configName)
          Create a list in a single record bin.
 void delete(Value value)
          Delete value from list.
 java.util.Map<?,?> getConfig()
          Return map of list configuration parameters.
 void insert(java.lang.String configName, Value value)
          Insert value into list.
 void insert(Value value)
          Insert value into list.
 java.util.List<?> search(Value value)
          Select value from list.
 java.util.List<?> search(Value value, java.lang.String filterName, Value... filterArgs)
          Select value from list and apply specified Lua filter.
 int size()
          Return size of list.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LargeSet

public LargeSet(AerospikeClient client,
                Policy policy,
                Key key,
                java.lang.String binName)
Initialize large set operator.

Parameters:
client - client
policy - generic configuration parameters, pass in null for defaults
key - unique record identifier
binName - bin name
Method Detail

create

public final void create(java.lang.String configName)
                  throws AerospikeException
Create a list in a single record bin.

Parameters:
configName - Lua function name that initializes list configuration parameters, pass null for default list
Throws:
AerospikeException

insert

public final void insert(java.lang.String configName,
                         Value value)
                  throws AerospikeException
Insert value into list. If the list does not exist, create it using specified configuration.

Parameters:
configName - Lua function name that initializes list configuration parameters, pass null for default list
value - value to insert
Throws:
AerospikeException

insert

public final void insert(Value value)
                  throws AerospikeException
Insert value into list. If the list does not exist, throw an exception.

Parameters:
value - value to insert
Throws:
AerospikeException

delete

public final void delete(Value value)
                  throws AerospikeException
Delete value from list.

Parameters:
value - value to delete
Throws:
AerospikeException

search

public final java.util.List<?> search(Value value)
                               throws AerospikeException
Select value from list.

Parameters:
value - value to select
Returns:
list of entries selected
Throws:
AerospikeException

search

public final java.util.List<?> search(Value value,
                                      java.lang.String filterName,
                                      Value... filterArgs)
                               throws AerospikeException
Select value from list and apply specified Lua filter.

Parameters:
value - value to select
filterName - Lua function name which applies filter to returned list
filterArgs - arguments to Lua function name
Returns:
list of entries selected
Throws:
AerospikeException

size

public final int size()
               throws AerospikeException
Return size of list.

Throws:
AerospikeException

getConfig

public final java.util.Map<?,?> getConfig()
                                   throws AerospikeException
Return map of list configuration parameters.

Throws:
AerospikeException