com.googlecode.n_orm.cf

Class ColumnFamily<T>

java.lang.Object

com.googlecode.n_orm.cf.ColumnFamily<T>

All Implemented Interfaces:

Comparable<ColumnFamily<T>>

Direct Known Subclasses:

MapColumnFamily, SetColumnFamily

public abstract class ColumnFamily<T>
extends Object
implements Comparable<ColumnFamily<T>>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColumnFamily.ChangeKind

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addOnly
protected boolean	allChanged
protected Map<String,ColumnFamily.ChangeKind>	changes
protected Class<T>	clazz
protected Map<String,T>	collection
protected Map<String,Number>	increments
protected long	lastActivation
protected String	name
protected PersistingElement	owner
protected Field	property

Constructor Summary

Constructors

Constructor and Description
ColumnFamily()
ColumnFamily(Class<T> clazz, Field property, String name, PersistingElement owner)

Method Summary

Modifier and Type	Method and Description
void	activate()
void	activate(Constraint c)
abstract void	activate(Object from, Object to)
void	activate(String fromIndex, String toIndex)
protected abstract void	addToPOJO(Object pojoVersion, String key, T element)
void	assertIsActivated(String messageToDescribeTheContextOfTheCheck)
Set<String>	changedKeySet()
void	clearChanges()
int	compareTo(ColumnFamily<T> rhs)
boolean	containsKey(String key)
long	getActivationDate() The date (epoch) at which the column familu was last activated.
Class<T>	getClazz()
T	getElement(String key) Finds an cached element according to its key.
T	getFromStore(String key) Finds an element according to its key.
Number	getIncrement(String key)
Set<String>	getKeys() The set of identifiers for activated elements.
String	getName()
PersistingElement	getOwner()
Object	getPOJO(boolean createIfNull)
Field	getProperty()
abstract Serializable	getSerializableVersion()
boolean	hasChanged()
protected boolean	hasChanged(String key, T lhs, T rhs)
Set<String>	incrementedKeySet()
boolean	isActivated()
boolean	isActivated(long timeout) Whether this column family was activated during the last timeout period.
boolean	isAddOnly()
boolean	isEmpty() Checks whether this column family is empty.
boolean	isEmptyInStore() Checks whether this column family is empty in the data store.
protected T	preparePut(String key, byte[] rep)
void	putElement(String key, T element)
void	rebuild(Map<String,byte[]> rawData)
void	removeKey(String key) Removes an element to the column family given its key.
void	setActivated()
void	setAllChanged()
int	size() Returns the number of activated elements.
void	storeToPOJO()
protected abstract void	storeToPOJO(Object pojoVersion)
void	updateFromPOJO()
protected abstract void	updateFromPOJO(Object pojoVersion)
boolean	wasChanged(String key)
boolean	wasDeleted(String key)

Methods inherited from class java.lang.Object

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

Field Detail

clazz

protected final Class<T> clazz

property

protected final Field property

name

protected final String name

owner

protected final PersistingElement owner

collection

protected final Map<String,T> collection

allChanged

protected boolean allChanged

changes

protected Map<String,ColumnFamily.ChangeKind> changes

increments

protected final Map<String,Number> increments

addOnly

protected final boolean addOnly

lastActivation

protected long lastActivation

Constructor Detail

ColumnFamily

public ColumnFamily()

ColumnFamily

public ColumnFamily(Class<T> clazz,
                    Field property,
                    String name,
                    PersistingElement owner)

Method Detail

getSerializableVersion

public abstract Serializable getSerializableVersion()

updateFromPOJO

protected abstract void updateFromPOJO(Object pojoVersion)

storeToPOJO

protected abstract void storeToPOJO(Object pojoVersion)

addToPOJO

protected abstract void addToPOJO(Object pojoVersion,
                                  String key,
                                  T element)

compareTo

public int compareTo(ColumnFamily<T> rhs)

Specified by:

compareTo in interface Comparable<ColumnFamily<T>>

getName

public String getName()

getClazz

public Class<T> getClazz()

getProperty

public Field getProperty()

Returns:

the property corresponding to that column family ; may be null, e.g. for the properties or increments column families

getOwner

public PersistingElement getOwner()

isAddOnly

public boolean isAddOnly()

isActivated

public boolean isActivated()

isActivated

public boolean isActivated(long timeout)

Whether this column family was activated during the last timeout period.

Parameters:

timeout - negative value means at any time ; Long.MAX_VALUE bypasses clock read

setActivated

public void setActivated()

getActivationDate

public long getActivationDate()

The date (epoch) at which the column familu was last activated.

assertIsActivated

public void assertIsActivated(String messageToDescribeTheContextOfTheCheck)
                       throws IllegalStateException

Throws:

IllegalStateException

activate

public void activate()
              throws DatabaseNotReachedException

Throws:

DatabaseNotReachedException

activate

public abstract void activate(Object from,
                              Object to)
                       throws DatabaseNotReachedException

Throws:

DatabaseNotReachedException

activate

public void activate(String fromIndex,
                     String toIndex)
              throws DatabaseNotReachedException

Throws:

DatabaseNotReachedException

activate

public void activate(Constraint c)
              throws DatabaseNotReachedException

Throws:

DatabaseNotReachedException

rebuild

public void rebuild(Map<String,byte[]> rawData)
             throws DatabaseNotReachedException

Throws:

DatabaseNotReachedException

preparePut

protected T preparePut(String key,
                       byte[] rep)

size

public int size()

Returns the number of activated elements.

isEmpty

public boolean isEmpty()

Checks whether this column family is empty. If no element is cached, requests the data store.

isEmptyInStore

public boolean isEmptyInStore()
                       throws DatabaseNotReachedException

Checks whether this column family is empty in the data store.

Throws:

DatabaseNotReachedException

containsKey

public boolean containsKey(String key)

putElement

public void putElement(String key,
                       T element)
                throws IncrementException

Throws:

IncrementException

hasChanged

protected boolean hasChanged(String key,
                             T lhs,
                             T rhs)

getKeys

public Set<String> getKeys()

The set of identifiers for activated elements.

removeKey

public void removeKey(String key)

Removes an element to the column family given its key. For this element not to appear anymore in the datastore, the owner object must be called the PersistingElement.store() method.

getElement

public T getElement(String key)

Finds an cached element according to its key.

getFromStore

public T getFromStore(String key)
               throws DatabaseNotReachedException

Finds an element according to its key. If the element is not in the cache, attempts to get it from the data store. The found element goes into the cache.

Throws:

DatabaseNotReachedException

changedKeySet

public Set<String> changedKeySet()

incrementedKeySet

public Set<String> incrementedKeySet()

hasChanged

public boolean hasChanged()

wasChanged

public boolean wasChanged(String key)

wasDeleted

public boolean wasDeleted(String key)

getIncrement

public Number getIncrement(String key)

setAllChanged

public void setAllChanged()

clearChanges

public void clearChanges()

getPOJO

public Object getPOJO(boolean createIfNull)

updateFromPOJO

public void updateFromPOJO()

storeToPOJO

public void storeToPOJO()