com.googlecode.n_orm

Aspect StorageManagement

java.lang.Object

com.googlecode.n_orm.StorageManagement

public aspect StorageManagement
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageManagement.SearchResultIterator<T extends PersistingElement>

Declare Summary
boolean	PersistingElement.isKnownAsExistingInStore() Declared on: com.googlecode.n_orm.PersistingElement
boolean	PersistingElement.isKnownAsNotExistingInStore() Declared on: com.googlecode.n_orm.PersistingElement
java.lang.Object	PersistingElement.addAdditionalProperty(java.lang.String,java.lang.Object,boolean) Declared on: com.googlecode.n_orm.PersistingElement
java.lang.Object	PersistingElement.getAdditionalProperty(java.lang.String) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.flush() Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.deleteNoCache() Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.delete() Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.storeNoCache() Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.store() Declared on: com.googlecode.n_orm.PersistingElement
java.util.Collection>	PersistingElement.getPersistingSuperClasses() Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateColumnFamily(java.lang.String) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateColumnFamily(java.lang.String,java.lang.Object,java.lang.Object) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,long) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,java.lang.Object,java.lang.Object) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,long,java.lang.Object,java.lang.Object) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateIfNotAlready(java.lang.String[]) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateIfNotAlready(long,java.lang.String[]) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activate(java.lang.String[]) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activate(java.lang.Object[]) Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.activateFromRawData(java.util.Set,com.googlecode.n_orm.storeapi.Row$ColumnFamilyData) Declared on: com.googlecode.n_orm.PersistingElement
boolean	PersistingElement.exists() Declared on: com.googlecode.n_orm.PersistingElement
boolean	PersistingElement.existsInStore() Declared on: com.googlecode.n_orm.PersistingElement
com.googlecode.n_orm.PersistingElement	PersistingElement.getCachedVersion() Declared on: com.googlecode.n_orm.PersistingElement

Constructor Summary

Constructors

Constructor and Description
StorageManagement()

Method Summary

Modifier and Type	Method and Description
static <T extends PersistingElement> long	countElements(java.lang.Class<T> clazz, Constraint c) Advised by: com.googlecode.n_orm.FederatedTableManagement.around(com.googlecode.n_orm.storeapi.MetaInformation,java.lang.String,com.googlecode.n_orm.storeapi.Constraint,com.googlecode.n_orm.storeapi.Store): ..
static <T extends PersistingElement> T	createElementFromRow(java.lang.Class<T> clazz, java.util.Map<java.lang.String,java.lang.reflect.Field> toBeActivated, Row data) Advised by: com.googlecode.n_orm.FederatedTableManagement.afterReturning(com.googlecode.n_orm.FederatedTableManagement$RowWithTable,com.googlecode.n_orm.PersistingElementOverFederatedTable): .. Creates an element from byte-array based data.
static <T extends PersistingElement> CloseableIterator<T>	findElement(java.lang.Class<T> clazz, Constraint c, int limit, java.lang.String... families) Advised by: com.googlecode.n_orm.FederatedTableManagement.around(com.googlecode.n_orm.storeapi.MetaInformation,java.lang.String,com.googlecode.n_orm.storeapi.Constraint,int,java.util.Set,com.googlecode.n_orm.storeapi.Store): ..
static ConstraintBuilder	findElements()
static <T extends PersistingElement> java.util.NavigableSet<T>	findElementsToSet(java.lang.Class<T> clazz, Constraint c, int limit, java.lang.String... families) // * WARNING: this function empties the cache for all elements of class clazz.
static java.util.Map<java.lang.String,java.lang.reflect.Field>	getAutoActivatedFamilies(java.lang.Class<? extends PersistingElement> clazz, java.lang.String... families) The list of column families that should be activated while providing the desired list of column families.
static <T> T	getElement(java.lang.Class<T> clazz, java.lang.String identifier)
static <T extends PersistingElement> T	getElementUsingCache(T element) Gets an element according to its keys.
static <T> T	getElementWithKeys(java.lang.Class<T> clazz, java.lang.Object... keyValues) Gets an element according to its key values.
static <E extends PersistingElement> E	getFromRawData(java.lang.Class<E> type, Row row, java.util.Set<java.lang.String> toBeActivated)

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageManagement

public StorageManagement()

Declare Detail

PersistingElement.isKnownAsExistingInStore()

public boolean PersistingElement.isKnownAsExistingInStore()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.isKnownAsNotExistingInStore()

public boolean PersistingElement.isKnownAsNotExistingInStore()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.addAdditionalProperty(java.lang.String,java.lang.Object,boolean)

public java.lang.Object PersistingElement.addAdditionalProperty(java.lang.String,java.lang.Object,boolean)

Declared on:

com.googlecode.n_orm.PersistingElement

A general purpose property attached to this persisting element. Primarily designed to help building data store drivers. Thread-safe using copy-on-write. @param key the key of the inserted element @param o the inserted value on this persisting element with the given key @param checkIfExists if set to true, given value o will be inserted if and only if no existing value with the same key exists @return The object inserted as an additional property or the previously existing value for the key in case checkIfExists was set to true @throws NullPointerException if key or o is null

PersistingElement.getAdditionalProperty(java.lang.String)

public java.lang.Object PersistingElement.getAdditionalProperty(java.lang.String)

Declared on:

com.googlecode.n_orm.PersistingElement

A general purpose property attached to this persisting element. Primarily designed to help building data store drivers.

PersistingElement.flush()

public void PersistingElement.flush()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.deleteNoCache()

public void PersistingElement.deleteNoCache()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.delete()

public void PersistingElement.delete()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.storeNoCache()

public void PersistingElement.storeNoCache()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.store()

public void PersistingElement.store()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.getPersistingSuperClasses()

public java.util.Collection> PersistingElement.getPersistingSuperClasses()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateColumnFamily(java.lang.String)

public void PersistingElement.activateColumnFamily(java.lang.String)

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateColumnFamily(java.lang.String,java.lang.Object,java.lang.Object)

public void PersistingElement.activateColumnFamily(java.lang.String,java.lang.Object,java.lang.Object)

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String)

public void PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String)

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,long)

public void PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,long)

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,java.lang.Object,java.lang.Object)

public void PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,java.lang.Object,java.lang.Object)

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,long,java.lang.Object,java.lang.Object)

public void PersistingElement.activateColumnFamilyIfNotAlready(java.lang.String,long,java.lang.Object,java.lang.Object)

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateIfNotAlready(java.lang.String[])

public void PersistingElement.activateIfNotAlready(java.lang.String[])

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateIfNotAlready(long,java.lang.String[])

public void PersistingElement.activateIfNotAlready(long,java.lang.String[])

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activate(java.lang.String[])

public void PersistingElement.activate(java.lang.String[])

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activate(java.lang.Object[])

public void PersistingElement.activate(java.lang.Object[])

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.activateFromRawData(java.util.Set,com.googlecode.n_orm.storeapi.Row$ColumnFamilyData)

public void PersistingElement.activateFromRawData(java.util.Set,com.googlecode.n_orm.storeapi.Row$ColumnFamilyData)

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.exists()

public boolean PersistingElement.exists()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.existsInStore()

public boolean PersistingElement.existsInStore()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.getCachedVersion()

public com.googlecode.n_orm.PersistingElement PersistingElement.getCachedVersion()

Declared on:

com.googlecode.n_orm.PersistingElement

Method Detail

getFromRawData

public static <E extends PersistingElement> E getFromRawData(java.lang.Class<E> type,
                                                             Row row,
                                                             java.util.Set<java.lang.String> toBeActivated)

getAutoActivatedFamilies

public static java.util.Map<java.lang.String,java.lang.reflect.Field> getAutoActivatedFamilies(java.lang.Class<? extends PersistingElement> clazz,
                                                                                               java.lang.String... families)

The list of column families that should be activated while providing the desired list of column families. This function takes care of the property column family and any ImplicitActivation marked column family.

Parameters:

clazz - the class of the element where column families should be found

families - the desired set of families

Returns:

names/fields for families to be activated

getElement

public static <T> T getElement(java.lang.Class<T> clazz,
                               java.lang.String identifier)

createElementFromRow

public static <T extends PersistingElement> T createElementFromRow(java.lang.Class<T> clazz,
                                                                   java.util.Map<java.lang.String,java.lang.reflect.Field> toBeActivated,
                                                                   Row data)

Advised by:

com.googlecode.n_orm.FederatedTableManagement.afterReturning(com.googlecode.n_orm.FederatedTableManagement$RowWithTable,com.googlecode.n_orm.PersistingElementOverFederatedTable): ..

Creates an element from byte-array based data. If element can be found in cache, it will. Any existing data is replaced by the given Row, except for families with no data.

Parameters:

clazz - the class of the returned element

toBeActivated - the list of families to be activated

data - the raw data as can be found in a data store

findElement

public static <T extends PersistingElement> CloseableIterator<T> findElement(java.lang.Class<T> clazz,
                                                                             Constraint c,
                                                                             int limit,
                                                                             java.lang.String... families)
                                                                      throws DatabaseNotReachedException

Advised by:

com.googlecode.n_orm.FederatedTableManagement.around(com.googlecode.n_orm.storeapi.MetaInformation,java.lang.String,com.googlecode.n_orm.storeapi.Constraint,int,java.util.Set,com.googlecode.n_orm.storeapi.Store): ..

Throws:

DatabaseNotReachedException

countElements

public static <T extends PersistingElement> long countElements(java.lang.Class<T> clazz,
                                                               Constraint c)

Advised by:

com.googlecode.n_orm.FederatedTableManagement.around(com.googlecode.n_orm.storeapi.MetaInformation,java.lang.String,com.googlecode.n_orm.storeapi.Constraint,com.googlecode.n_orm.storeapi.Store): ..

findElementsToSet

public static <T extends PersistingElement> java.util.NavigableSet<T> findElementsToSet(java.lang.Class<T> clazz,
                                                                                        Constraint c,
                                                                                        int limit,
                                                                                        java.lang.String... families)
                                                                                 throws DatabaseNotReachedException

// * WARNING: this function empties the cache for all elements of class clazz. //

Throws:

DatabaseNotReachedException

findElements

public static ConstraintBuilder findElements()

getElementUsingCache

public static <T extends PersistingElement> T getElementUsingCache(T element)

Gets an element according to its keys. In case the element is in cache, returns that element. Otherwise, returns the element sent in parameter. This method should be invoked an a newly created element.

See Also:

PersistingElement.getCachedVersion()

getElementWithKeys

public static <T> T getElementWithKeys(java.lang.Class<T> clazz,
                                       java.lang.Object... keyValues)

Gets an element according to its key values. In case the element is a PersistingElement, the cache is queried.

Parameters:

type - the class of the element

keyValues - the values for each key in the correct order

See Also:

PersistingElement.getCachedVersion()