CompositeEntityManager (astyanax-entity-mapper 3.10.2 API)

java.lang.Object
- com.netflix.astyanax.entitystore.CompositeEntityManager<T,K>

Type Parameters:

T - Entity type

K - Partition key

All Implemented Interfaces:

EntityManager<T,K>
```
public class CompositeEntityManager<T,K>
extends java.lang.Object
implements EntityManager<T,K>
```
Entity manager for a composite column family. This entity manager expects the entity to have a single @Id which corresponds to the row key. It will then have at least 3 columns, with all but the last being parts of the composite.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CompositeEntityManager.Builder<T,K>

Nested Classes
Modifier and Type	Class and Description
`static class`	`CompositeEntityManager.Builder<T,K>`

Constructor Summary

Constructors
Constructor and Description

CompositeEntityManager(CompositeEntityManager.Builder<T,K> builder)

Constructors
Constructor and Description
`CompositeEntityManager(CompositeEntityManager.Builder<T,K> builder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static <T,K> CompositeEntityManager.Builder<T,K>`	`builder()`
`void`	`commit()` Commit the internal batch after multiple operations.
`NativeQuery<T,K>`	`createNativeQuery()` Execute a 'native' query using a simple API that adheres to cassandra's native model of rows and columns.
`void`	`createStorage(java.util.Map<java.lang.String,java.lang.Object> options)` Create the underlying storage for this entity.
`void`	`delete(java.util.Collection<K> ids)` Delete a set of entities by their id
`void`	`delete(K id)` delete the whole row by id
`void`	`deleteStorage()` Delete the underlying storage for this entity.
`java.util.List<T>`	`find(java.lang.String cql)` Execute a CQL query and return the found entites
`java.util.List<T>`	`get(java.util.Collection<K> ids)`
`T`	`get(K id)` fetch whole row and construct entity object mapping from columns
`java.util.List<T>`	`getAll()`
`void`	`put(java.util.Collection<T> entities)` Store a set of entities.
`void`	`put(T entity)` write entity to cassandra with mapped rowId and columns
`void`	`remove(java.util.Collection<T> entities)` Delete a set of entities
`void`	`remove(T entity)` remove an entire entity
`void`	`truncate()` Truncate all data in the underlying
`void`	`visitAll(com.google.common.base.Function<T,java.lang.Boolean> callback)` Visit all entities.

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

- Constructor Detail
  - CompositeEntityManager
```
public CompositeEntityManager(CompositeEntityManager.Builder<T,K> builder)
```
- Method Detail
  - builder
```
public static <T,K> CompositeEntityManager.Builder<T,K> builder()
```
  - put
```
public void put(T entity)
         throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    write entity to cassandra with mapped rowId and columns
    
    Specified by:
    
    put in interface EntityManager<T,K>
    
    Parameters:
    
    entity - entity object
    
    Throws:
    
    javax.persistence.PersistenceException
  - get
```
public T get(K id)
      throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    fetch whole row and construct entity object mapping from columns
    
    Specified by:
    
    get in interface EntityManager<T,K>
    
    Parameters:
    
    id - row key
    
    Returns:
    
    entity object. null if not exist
    
    Throws:
    
    javax.persistence.PersistenceException
  - delete
```
public void delete(K id)
            throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    delete the whole row by id
    
    Specified by:
    
    delete in interface EntityManager<T,K>
    
    Parameters:
    
    id - row key
    
    Throws:
    
    javax.persistence.PersistenceException
  - remove
```
public void remove(T entity)
            throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    remove an entire entity
    
    Specified by:
    
    remove in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - getAll
```
public java.util.List<T> getAll()
                         throws javax.persistence.PersistenceException
```
    Specified by:
    
    getAll in interface EntityManager<T,K>
    
    Returns:
    
    Return all entities.
    
    Throws:
    
    javax.persistence.PersistenceException
  - get
```
public java.util.List<T> get(java.util.Collection<K> ids)
                      throws javax.persistence.PersistenceException
```
    Specified by:
    
    get in interface EntityManager<T,K>
    
    Returns:
    
    Get a set of entities
    
    Throws:
    
    javax.persistence.PersistenceException
  - delete
```
public void delete(java.util.Collection<K> ids)
            throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Delete a set of entities by their id
    
    Specified by:
    
    delete in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - remove
```
public void remove(java.util.Collection<T> entities)
            throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Delete a set of entities
    
    Specified by:
    
    remove in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - put
```
public void put(java.util.Collection<T> entities)
         throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Store a set of entities.
    
    Specified by:
    
    put in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - visitAll
```
public void visitAll(com.google.common.base.Function<T,java.lang.Boolean> callback)
              throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Visit all entities.
    
    Specified by:
    
    visitAll in interface EntityManager<T,K>
    
    Parameters:
    
    callback - Callback when an entity is read. Note that the callback may be called from multiple threads.
    
    Throws:
    
    javax.persistence.PersistenceException
  - find
```
public java.util.List<T> find(java.lang.String cql)
                       throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Execute a CQL query and return the found entites
    
    Specified by:
    
    find in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - createStorage
```
public void createStorage(java.util.Map<java.lang.String,java.lang.Object> options)
                   throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Create the underlying storage for this entity. This should only be called once when first creating store and not part of the normal startup sequence.
    
    Specified by:
    
    createStorage in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - deleteStorage
```
public void deleteStorage()
                   throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Delete the underlying storage for this entity.
    
    Specified by:
    
    deleteStorage in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - truncate
```
public void truncate()
              throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Truncate all data in the underlying
    
    Specified by:
    
    truncate in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - commit
```
public void commit()
            throws javax.persistence.PersistenceException
```
    Description copied from interface: EntityManager
    
    Commit the internal batch after multiple operations. Note that an entity manager implementation may autocommit after each operation.
    
    Specified by:
    
    commit in interface EntityManager<T,K>
    
    Throws:
    
    javax.persistence.PersistenceException
  - createNativeQuery
```
public NativeQuery<T,K> createNativeQuery()
```
    Description copied from interface: EntityManager
    
    Execute a 'native' query using a simple API that adheres to cassandra's native model of rows and columns.
    
    Specified by:
    
    createNativeQuery in interface EntityManager<T,K>
    
    Returns:

Class CompositeEntityManager<T,K>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CompositeEntityManager

Method Detail

builder

put

get

delete

remove

getAll

get

delete

remove

put

visitAll

find

createStorage

deleteStorage

truncate

commit

createNativeQuery