AerospikeTemplate (Spring Data Aerospike 2.0.0.RELEASE API)

java.lang.Object
- org.springframework.data.aerospike.core.AerospikeTemplate

All Implemented Interfaces:

AerospikeOperations
```
public class AerospikeTemplate
extends Object
implements AerospikeOperations
```
Primary implementation of AerospikeOperations.

Author:

Oliver Gierke, Peter Milne

Constructor Summary

Constructors
Constructor and Description
`AerospikeTemplate(com.aerospike.client.AerospikeClient client, String namespace)` Deprecated.
`AerospikeTemplate(com.aerospike.client.AerospikeClient client, String namespace, MappingAerospikeConverter converter, AerospikeMappingContext mappingContext, AerospikeExceptionTranslator exceptionTranslator)` Creates a new `AerospikeTemplate` for the given `AerospikeClient`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> T`	`add(T objectToAddTo, Map<String,Long> values)`
`<T> T`	`add(T objectToAddTo, String binName, long value)`
`<T> Iterable<T>`	`aggregate(com.aerospike.client.query.Filter filter, Class<T> outputType, String module, String function, List<com.aerospike.client.Value> arguments)`
`<T> T`	`append(T objectToAppendTo, Map<String,String> values)`
`<T> T`	`append(T objectToAppendTo, String binName, String value)`
`long`	`count(Class<?> type)`
`long`	`count(Class<?> type, String setName)`
`long`	`count(Query query, Class<?> type)`
`<T> void`	`createIndex(Class<T> domainType, String indexName, String binName, com.aerospike.client.query.IndexType indexType)` Creates index by specified name in Aerospike.
`void`	`delete(Class<?> type)`
`boolean`	`delete(Object objectToDelete)`
`boolean`	`delete(Object id, Class<?> type)`
`<T> void`	`deleteIndex(Class<T> domainType, String indexName)` Deletes index by specified name from Aerospike.
`<T> T`	`execute(Supplier<T> supplier)` Execute operation against underlying store.
`boolean`	`exists(Object id, Class<?> type)`
`boolean`	`exists(Query query, Class<?> entityClass)`
`<T> Stream<T>`	`find(Query query, Class<T> type)`
`<T> Stream<T>`	`findAll(Class<T> type)`
`<T> Iterable<T>`	`findAll(Sort sort, Class<T> type)`
`<T> T`	`findById(Object id, Class<T> type)`
`<T> List<T>`	`findByIds(Iterable<?> ids, Class<T> type)`
`<T> Stream<T>`	`findInRange(long offset, long limit, Sort sort, Class<T> type)`
`com.aerospike.client.AerospikeClient`	`getAerospikeClient()`
`MappingContext<?,?>`	`getMappingContext()`
`String`	`getNamespace()`
`String`	`getSetName(Class<?> entityClass)` The Set name used for the specified class by this template.
`boolean`	`indexExists(String indexName)` Checks whether index by specified name exists in Aerospike.
`void`	`insert(Object document)` Insert operation using the WritePolicy.recordExisits policy of CREATE_ONLY
`<T> void`	`insertAll(Collection<? extends T> documents)`
`void`	`persist(Object document, com.aerospike.client.policy.WritePolicy policy)` Persist document using specified WritePolicy
`<T> T`	`prepend(T objectToPrependTo, Map<String,String> values)`
`<T> T`	`prepend(T objectToPrependTo, String fieldName, String value)`
`void`	`save(Object document)` Save operation.
`void`	`update(Object document)` Update operation using the WritePolicy.recordExisits policy of UPDATE_ONLY

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AerospikeTemplate

public AerospikeTemplate(com.aerospike.client.AerospikeClient client,
                         String namespace,
                         MappingAerospikeConverter converter,
                         AerospikeMappingContext mappingContext,
                         AerospikeExceptionTranslator exceptionTranslator)

Creates a new AerospikeTemplate for the given AerospikeClient.

Parameters:: converter -; mappingContext -; exceptionTranslator -; client - must not be null.; namespace - must not be null or empty.

AerospikeTemplate

@Deprecated
public AerospikeTemplate(com.aerospike.client.AerospikeClient client,
                                     String namespace)

Deprecated.

Instead use the other constructor.

Method Detail
- createIndex
```
public <T> void createIndex(Class<T> domainType,
                            String indexName,
                            String binName,
                            com.aerospike.client.query.IndexType indexType)
```
  Description copied from interface: AerospikeOperations
  
  Creates index by specified name in Aerospike.
  
  Specified by:
  
  createIndex in interface AerospikeOperations
- deleteIndex
```
public <T> void deleteIndex(Class<T> domainType,
                            String indexName)
```
  Description copied from interface: AerospikeOperations
  
  Deletes index by specified name from Aerospike.
  
  Specified by:
  
  deleteIndex in interface AerospikeOperations
- indexExists
```
public boolean indexExists(String indexName)
```
  Description copied from interface: AerospikeOperations
  
  Checks whether index by specified name exists in Aerospike.
  
  Specified by:
  
  indexExists in interface AerospikeOperations
  
  Returns:
  
  true if exists
- save
```
public void save(Object document)
```
  Description copied from interface: AerospikeOperations
  
  Save operation. If document has version property - CAS algorithm is used for updating record. Version property is used for deciding whether to create new record or update existing. If version is set to zero - new record will be created, creation will fail is such record already exists. If version is greater than zero - existing record will be updated with RecordExistsAction.REPLACE_ONLY policy taking into consideration the version property of the document. If document does not have version property - record is updated with RecordExistsAction.UPDATE policy. This means that when such record does not exist it will be created, otherwise updated.
  
  Specified by:
  
  save in interface AerospikeOperations
- persist
```
public void persist(Object document,
                    com.aerospike.client.policy.WritePolicy policy)
```
  Description copied from interface: AerospikeOperations
  
  Persist document using specified WritePolicy
  
  Specified by:
  
  persist in interface AerospikeOperations
- insertAll
```
public <T> void insertAll(Collection<? extends T> documents)
```
- insert
```
public void insert(Object document)
```
  Description copied from interface: AerospikeOperations
  
  Insert operation using the WritePolicy.recordExisits policy of CREATE_ONLY
  
  Specified by:
  
  insert in interface AerospikeOperations
- update
```
public void update(Object document)
```
  Description copied from interface: AerospikeOperations
  
  Update operation using the WritePolicy.recordExisits policy of UPDATE_ONLY
  
  Specified by:
  
  update in interface AerospikeOperations
- delete
```
public void delete(Class<?> type)
```
  Specified by:
  
  delete in interface AerospikeOperations
- delete
```
public boolean delete(Object id,
                      Class<?> type)
```
  Specified by:
  
  delete in interface AerospikeOperations
- delete
```
public boolean delete(Object objectToDelete)
```
  Specified by:
  
  delete in interface AerospikeOperations
- exists
```
public boolean exists(Object id,
                      Class<?> type)
```
  Specified by:
  
  exists in interface AerospikeOperations
- findAll
```
public <T> Stream<T> findAll(Class<T> type)
```
  Specified by:
  
  findAll in interface AerospikeOperations
- findById
```
public <T> T findById(Object id,
                      Class<T> type)
```
  Specified by:
  
  findById in interface AerospikeOperations
- findByIds
```
public <T> List<T> findByIds(Iterable<?> ids,
                             Class<T> type)
```
  Specified by:
  
  findByIds in interface AerospikeOperations
- aggregate
```
public <T> Iterable<T> aggregate(com.aerospike.client.query.Filter filter,
                                 Class<T> outputType,
                                 String module,
                                 String function,
                                 List<com.aerospike.client.Value> arguments)
```
  Specified by:
  
  aggregate in interface AerospikeOperations
- getSetName
```
public String getSetName(Class<?> entityClass)
```
  Description copied from interface: AerospikeOperations
  
  The Set name used for the specified class by this template.
  
  Specified by:
  
  getSetName in interface AerospikeOperations
  
  Parameters:
  
  entityClass - must not be null.
  
  Returns:
- findAll
```
public <T> Iterable<T> findAll(Sort sort,
                               Class<T> type)
```
  Specified by:
  
  findAll in interface AerospikeOperations
  
  Returns:
- exists
```
public boolean exists(Query query,
                      Class<?> entityClass)
```
- execute
```
public <T> T execute(Supplier<T> supplier)
```
  Description copied from interface: AerospikeOperations
  
  Execute operation against underlying store.
  
  Specified by:
  
  execute in interface AerospikeOperations
  
  Parameters:
  
  supplier - must not be null.
  
  Returns:
- count
```
public long count(Query query,
                  Class<?> type)
```
  Specified by:
  
  count in interface AerospikeOperations
  
  Returns:
- find
```
public <T> Stream<T> find(Query query,
                          Class<T> type)
```
  Specified by:
  
  find in interface AerospikeOperations
- getMappingContext
```
public MappingContext<?,?> getMappingContext()
```
  Specified by:
  
  getMappingContext in interface AerospikeOperations
  
  Returns:
  
  mapping context in use.
- getNamespace
```
public String getNamespace()
```
- findInRange
```
public <T> Stream<T> findInRange(long offset,
                                 long limit,
                                 Sort sort,
                                 Class<T> type)
```
  Specified by:
  
  findInRange in interface AerospikeOperations
  
  Returns:
- count
```
public long count(Class<?> type)
```
  Specified by:
  
  count in interface AerospikeOperations
  
  Returns:
- getAerospikeClient
```
public com.aerospike.client.AerospikeClient getAerospikeClient()
```
  Specified by:
  
  getAerospikeClient in interface AerospikeOperations
- count
```
public long count(Class<?> type,
                  String setName)
```
  Specified by:
  
  count in interface AerospikeOperations
  
  Returns:
- prepend
```
public <T> T prepend(T objectToPrependTo,
                     String fieldName,
                     String value)
```
  Specified by:
  
  prepend in interface AerospikeOperations
- prepend
```
public <T> T prepend(T objectToPrependTo,
                     Map<String,String> values)
```
  Specified by:
  
  prepend in interface AerospikeOperations
- append
```
public <T> T append(T objectToAppendTo,
                    Map<String,String> values)
```
  Specified by:
  
  append in interface AerospikeOperations
- append
```
public <T> T append(T objectToAppendTo,
                    String binName,
                    String value)
```
  Specified by:
  
  append in interface AerospikeOperations
- add
```
public <T> T add(T objectToAddTo,
                 Map<String,Long> values)
```
  Specified by:
  
  add in interface AerospikeOperations
- add
```
public <T> T add(T objectToAddTo,
                 String binName,
                 long value)
```
  Specified by:
  
  add in interface AerospikeOperations

Class AerospikeTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AerospikeTemplate

AerospikeTemplate

Method Detail

createIndex

deleteIndex

indexExists

save

persist

insertAll

insert

update

delete

delete

delete

exists

findAll

findById

findByIds

aggregate

getSetName

findAll

exists

execute

count

find

getMappingContext

getNamespace

findInRange

count

getAerospikeClient

count

prepend

prepend

append

append

add

add