com.googlecode.n_orm.cf

Class SetColumnFamily<T>

java.lang.Object

com.googlecode.n_orm.cf.ColumnFamily<byte[]>

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

All Implemented Interfaces:

Comparable<ColumnFamily<byte[]>>, Iterable<T>, Collection<T>, Set<T>

public class SetColumnFamily<T>
extends ColumnFamily<byte[]>
implements Set<T>

Column family for sets. Elements are stored using their identifier as key (see PersistingElement.getIdentifier() and PersistingElement.getFullIdentifier()), and an empty byte array as value. Elements stored in this set should not be mutable, as they are referred to using their key, that is if it changes afterwards, it's its key value that is actually used to be stored. This Set does not support null values. Elements are not actually stored in a real Set, its only their key that is stored by this set. However, retrieving an element from this set is still efficient thanks to the cache (see KeyManagement.createElement(Class, String).

Nested Class Summary

Nested classes/interfaces inherited from class com.googlecode.n_orm.cf.ColumnFamily

ColumnFamily.ChangeKind

Field Summary

Fields inherited from class com.googlecode.n_orm.cf.ColumnFamily

addOnly, allChanged, changes, clazz, collection, increments, lastActivation, name, owner, property

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	activate(Object from, Object to)
boolean	add(T o) Adds an element to the column family.
boolean	addAll(Collection<? extends T> c) Adds elements to the column family.
protected void	addToPOJO(Object pojo, String key, byte[] element)
void	clear() Removes all activated elements from the column family.
boolean	contains(Object o) Check whether this element exists in the activated elements.
boolean	containsAll(Collection<?> c) Returns true if this collection contains all of the elements in the collection of activated values only.
boolean	containsInStore(Object o) Checks whether this element exists in the family.
boolean	equals(Object obj)
protected String	getIndex(T object)
Serializable	getSerializableVersion()
Class<T>	getSetElementClazz()
int	hashCode()
Iterator<T>	iterator() Supplies an iterator over activated values only.
protected byte[]	preparePut(String key, byte[] rep)
boolean	remove(Object o) Removes an element to the column family.
boolean	removeAll(Collection<?> c) Removes elements to the column family.
boolean	retainAll(Collection<?> c) Retains only the elements in this collection that are contained in the specified collection of activated elements.
protected void	storeToPOJO(Object pojo)
Object[]	toArray() Supplies an array that contains activated values only.
<U> U[]	toArray(U[] a) Supplies an array that contains activated values only.
protected void	updateFromPOJO(Object pojo)

Methods inherited from class com.googlecode.n_orm.cf.ColumnFamily

activate, activate, activate, assertIsActivated, changedKeySet, clearChanges, compareTo, containsKey, getActivationDate, getClazz, getElement, getFromStore, getIncrement, getKeys, getName, getOwner, getPOJO, getProperty, hasChanged, hasChanged, incrementedKeySet, isActivated, isActivated, isAddOnly, isEmpty, isEmptyInStore, putElement, rebuild, removeKey, setActivated, setAllChanged, size, storeToPOJO, updateFromPOJO, wasChanged, wasDeleted

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

isEmpty, size, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

SetColumnFamily

public SetColumnFamily()

SetColumnFamily

public SetColumnFamily(Class<T> clazz,
                       Field property,
                       PersistingElement owner)
                throws SecurityException,
                       NoSuchFieldException

Throws:

SecurityException

NoSuchFieldException

SetColumnFamily

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

Method Detail

getSetElementClazz

public Class<T> getSetElementClazz()

getSerializableVersion

public Serializable getSerializableVersion()

Specified by:

getSerializableVersion in class ColumnFamily<byte[]>

getIndex

protected String getIndex(T object)

preparePut

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

Overrides:

preparePut in class ColumnFamily<byte[]>

add

public boolean add(T o)

Adds an element to the column family. For this element to appear in the datastore, the owner object must be called the PersistingElement.store() method

Specified by:

add in interface Collection<T>

Specified by:

add in interface Set<T>

contains

public boolean contains(Object o)

Check whether this element exists in the activated elements.

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface Set<T>

containsInStore

public boolean containsInStore(Object o)
                        throws DatabaseNotReachedException

Checks whether this element exists in the family. If this element is unknown in the cache, it triggers a request to the data store. In the case it exists, the element is added as an activated element to the collection.

Throws:

DatabaseNotReachedException

remove

public boolean remove(Object o)

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

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface Set<T>

containsAll

public boolean containsAll(Collection<?> c)

Returns true if this collection contains all of the elements in the collection of activated values only.

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface Set<T>

addAll

public boolean addAll(Collection<? extends T> c)

Adds elements to the column family. For those elements to appear in the datastore, the owner object must be called the PersistingElement.store() method

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface Set<T>

removeAll

public boolean removeAll(Collection<?> c)

Removes elements to the column family. For those elements to appear in the datastore, the owner object must be called the PersistingElement.store() method.

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface Set<T>

retainAll

public boolean retainAll(Collection<?> c)

Retains only the elements in this collection that are contained in the specified collection of activated elements. In other words, removes from this collection all of its elements that are not contained in the specified collection. For those elements not to appear anymore in the datastore, the owner object must be called the PersistingElement.store() method.

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface Set<T>

clear

public void clear()

Removes all activated elements from the column family. For those activated elements not to appear anymore in the datastore, the owner object must be called the PersistingElement.store() method.

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface Set<T>

iterator

public Iterator<T> iterator()

Supplies an iterator over activated values only.

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Set<T>

toArray

public Object[] toArray()

Supplies an array that contains activated values only.

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

toArray

public <U> U[] toArray(U[] a)

Supplies an array that contains activated values only.

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface Set<T>

equals

public boolean equals(Object obj)

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface Set<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface Set<T>

Overrides:

hashCode in class Object

activate

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

Specified by:

activate in class ColumnFamily<byte[]>

Throws:

DatabaseNotReachedException

updateFromPOJO

protected void updateFromPOJO(Object pojo)

Specified by:

updateFromPOJO in class ColumnFamily<byte[]>

storeToPOJO

protected void storeToPOJO(Object pojo)

Specified by:

storeToPOJO in class ColumnFamily<byte[]>

addToPOJO

protected void addToPOJO(Object pojo,
                         String key,
                         byte[] element)

Specified by:

addToPOJO in class ColumnFamily<byte[]>