com.googlecode.n_orm

Aspect KeyManagement

java.lang.Object

com.googlecode.n_orm.KeyManagement

public aspect KeyManagement
extends java.lang.Object

Advised by:

com.googlecode.n_orm.ColumnFamiliyManagement.around(com.googlecode.n_orm.PersistingElement,java.lang.Object): ..

To be identifiable, a persisting object must define fields to setup the key by annotating them with Key. Keys must declare an order from 1 to N, must not overlap, and must be all there, e.g. if N=3, the class must declare keys for orders 1, 2 and 3. Keys are inherited. For non-persisting elements (i.e. elements that are not annotated with Persisting, all fields must be keys. As such, an element may be identified by a string, whose format is the following:

 id ::=   sid //for a simple element such as a character string, an integer, an enum...

        | id ( KEY_SEPARATOR id)* (KEY_END_SEPARATOR sid)? '}' //for an element as decribed above ; each included id representing its key values, and the last optional sid representing its class

        | id ( ARRAY_SEPARATOR  id)* //for an array

 sid ::= (~(KEY_SEPARATOR|KEY_END_SEPARATOR|ARRAY_SEPARATOR))*
 

Declare Summary
java.util.List	PersistingElement.getKeys() Declared on: com.googlecode.n_orm.PersistingElement
void	PersistingElement.checkIsValid() Declared on: com.googlecode.n_orm.PersistingElement
java.lang.String	PersistingElement.getIdentifier() Declared on: com.googlecode.n_orm.PersistingElement
java.lang.String	PersistingElement.getFullIdentifier() Declared on: com.googlecode.n_orm.PersistingElement

Advice Summary

afterReturning(com.googlecode.n_orm.PersistingElement): .. Advises: com.googlecode.n_orm.StorageManagement.PersistingElement.delete

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARRAY_SEPARATOR
static java.lang.String	KEY_END_SEPARATOR
static java.lang.String	KEY_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
KeyManagement()

Method Summary

Modifier and Type	Method and Description
boolean	canCreateFromKeys(java.lang.Class<?> type)
void	checkKey(java.lang.reflect.Field f)
void	cleanupKnownPersistingElements()
<T> T	createElement(java.lang.Class<T> expectedType, java.lang.String id) Creates an element of the expected type with the given id.
java.lang.String	createIdentifier(java.lang.Object element, java.lang.Class<?> expected)
java.lang.String	createIdentifier(java.lang.Object element, java.lang.Class<?> expected, boolean canCheckCache)
java.util.List<java.lang.reflect.Field>	detectKeys(java.lang.Class<?> clazz)
static KeyManagement	getInstance()
PersistingElement	getKnownPersistingElement(java.lang.String fullIdentifier)
PersistingElement	getKnownPersistingElement(java.lang.String identifier, java.lang.Class<? extends PersistingElement> clazz)
boolean	isKey(java.lang.reflect.Field key)
void	register(PersistingElement element)
void	unregister(java.lang.Class<? extends PersistingElement> clazz, java.lang.String id)
void	unregister(PersistingElement element)

Methods inherited from class java.lang.Object

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

Declare Detail

PersistingElement.getKeys()

public java.util.List PersistingElement.getKeys()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.checkIsValid()

public void PersistingElement.checkIsValid()

Declared on:

com.googlecode.n_orm.PersistingElement

Checks whether this persisting element has a stable key. This means that each one of its keys is set to a valid and unchanged value.

PersistingElement.getIdentifier()

public java.lang.String PersistingElement.getIdentifier()

Declared on:

com.googlecode.n_orm.PersistingElement

PersistingElement.getFullIdentifier()

public java.lang.String PersistingElement.getFullIdentifier()

Declared on:

com.googlecode.n_orm.PersistingElement

Advice Detail

afterReturning

afterReturning(com.googlecode.n_orm.PersistingElement): ..

Advises:

com.googlecode.n_orm.StorageManagement.PersistingElement.delete

Field Detail

KEY_SEPARATOR

public static final java.lang.String KEY_SEPARATOR

See Also:

Constant Field Values

KEY_END_SEPARATOR

public static final java.lang.String KEY_END_SEPARATOR

See Also:

Constant Field Values

ARRAY_SEPARATOR

public static final java.lang.String ARRAY_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

KeyManagement

public KeyManagement()

Method Detail

getInstance

public static KeyManagement getInstance()

register

public void register(PersistingElement element)

unregister

public void unregister(PersistingElement element)

unregister

public void unregister(java.lang.Class<? extends PersistingElement> clazz,
                       java.lang.String id)

getKnownPersistingElement

public PersistingElement getKnownPersistingElement(java.lang.String fullIdentifier)

getKnownPersistingElement

public PersistingElement getKnownPersistingElement(java.lang.String identifier,
                                                   java.lang.Class<? extends PersistingElement> clazz)

cleanupKnownPersistingElements

public void cleanupKnownPersistingElements()

createElement

public <T> T createElement(java.lang.Class<T> expectedType,
                           java.lang.String id)

Creates an element of the expected type with the given id. Id may be a simple id or a full id (including reference to the actual type). Elements are cached using a per-thread cache (see Cache).

canCreateFromKeys

public boolean canCreateFromKeys(java.lang.Class<?> type)

detectKeys

public java.util.List<java.lang.reflect.Field> detectKeys(java.lang.Class<?> clazz)

checkKey

public void checkKey(java.lang.reflect.Field f)

isKey

public boolean isKey(java.lang.reflect.Field key)

createIdentifier

public java.lang.String createIdentifier(java.lang.Object element,
                                         java.lang.Class<?> expected)

createIdentifier

public java.lang.String createIdentifier(java.lang.Object element,
                                         java.lang.Class<?> expected,
                                         boolean canCheckCache)