fr.inria.atlanmod.neoemf.data.hbase.store

Class DirectWriteHBaseStore

java.lang.Object

fr.inria.atlanmod.neoemf.data.store.AbstractPersistentStore

fr.inria.atlanmod.neoemf.data.store.AbstractDirectWriteStore<HBasePersistenceBackend>

fr.inria.atlanmod.neoemf.data.hbase.store.DirectWriteHBaseStore

All Implemented Interfaces:

DirectWriteStore, PersistentStore, InternalEObject.EStore

Direct Known Subclasses:

ReadOnlyHBaseStore

public class DirectWriteHBaseStore
extends AbstractDirectWriteStore<HBasePersistenceBackend>

An AbstractDirectWriteStore that translates model-level operations to HBase operations.

This class implements the PersistentStore interface that defines a set of operations to implement in order to allow EMF persistence delegation. If this store is used, every method call and property access on PersistentEObject is forwarded to this class, that takes care of the serialization/deserialization from/to HBase.

For historical purposes this class does not use a HBasePersistenceBackend, instead, it accesses HBase directly using the low-level database API.

This store can be used as a base store that can be complemented by plugging decorator stores on top of it (see AbstractPersistentStoreDecorator subclasses) to provide additional features such as caching or logging.

See Also:

PersistentEObject, HBasePersistenceBackend, AbstractDirectWriteStore

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_CACHE_SIZE The default cache size (10 000).
protected static byte[]	PROPERTY_FAMILY The column family holding properties.
protected Table	table The HBase table used to access the model.

Fields inherited from class fr.inria.atlanmod.neoemf.data.store.AbstractDirectWriteStore

backend

Fields inherited from interface fr.inria.atlanmod.neoemf.data.store.PersistentStore

NO_INDEX

Constructor Summary

Constructors

Constructor and Description
DirectWriteHBaseStore(Resource.Internal resource) Constructs a new DirectWriteHBaseStore on the given resource.

Method Summary

Modifier and Type	Method and Description
protected void	addAttribute(PersistentEObject object, EAttribute attribute, int index, Object value) Adds the value at the index in the content of the attribute of the object.
protected void	addReference(PersistentEObject object, EReference reference, int index, PersistentEObject referencedObject) Adds the value at the index in the content of the reference of the object.
void	clear(InternalEObject internalObject, EStructuralFeature feature) Removes all values form the content of the object's feature
boolean	contains(InternalEObject internalObject, EStructuralFeature feature, Object value) Returns whether the content of the object's feature contains the given value.
EObject	eObject(Id id) Returns the resolved EObject identified by the given id or null.
protected Object	getAttribute(PersistentEObject object, EAttribute attribute, int index) Returns the value at the index in the content of the attribute of the object.
InternalEObject	getContainer(InternalEObject internalObject) Returns the object's container.
EStructuralFeature	getContainingFeature(InternalEObject internalObject) Returns the object's containing feature.
protected Object	getFromTable(PersistentEObject object, EStructuralFeature feature) Gets the EStructuralFeature feature from the Table for the object.
protected Object	getReference(PersistentEObject object, EReference reference, int index) Returns the value at the index in the content of the reference of the object.
int	indexOf(InternalEObject internalObject, EStructuralFeature feature, Object value) Returns the first index of the given value in the content of the object's feature.
protected Table	initTable(Connection connection, TableName tableName, Admin admin) Initialize the HBase table by creating the columns and column families to store the model.
boolean	isSet(InternalEObject internalObject, EStructuralFeature feature) Returns whether the object's feature is considered set.
int	lastIndexOf(InternalEObject internalObject, EStructuralFeature feature, Object value) Returns the last index of the given value in the content of the object's feature.
protected Object	removeAttribute(PersistentEObject object, EAttribute attribute, int index) Removes the value at the index in the content of the attribute of the object.
protected Object	removeReference(PersistentEObject object, EReference reference, int index) Removes the value at the index in the content of the reference of the object.
void	save() Saves the modifications of the owned EObjects in the persistence back-end.
protected Object	setAttribute(PersistentEObject object, EAttribute attribute, int index, Object value) Sets the value at the index in the content of the attribute of the object.
protected Object	setReference(PersistentEObject object, EReference reference, int index, PersistentEObject referencedObject) Sets the value at the index in the content of the reference of the object.
int	size(InternalEObject internalObject, EStructuralFeature feature) Returns the number of values in the content of the object's feature.
void	unset(InternalEObject internalObject, EStructuralFeature feature) Unsets the feature of the object.
protected void	updateContainment(PersistentEObject object, EReference reference, PersistentEObject referencedObject) Add referencedObject in the reference containment list of object.
protected void	updateInstanceOf(PersistentEObject object) Computes object's metaclass information and persists them in the database.

Methods inherited from class fr.inria.atlanmod.neoemf.data.store.AbstractDirectWriteStore

add, clearAttribute, clearReference, containsAttribute, containsReference, create, get, hashCode, indexOfAttribute, indexOfReference, isEmpty, isSetAttribute, isSetReference, lastIndexOfAttribute, lastIndexOfReference, move, parseProperty, remove, resource, serializeToProperty, set, toArray, toArray, unsetAttribute, unsetReference

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.inria.atlanmod.neoemf.data.store.PersistentStore

getAllInstances

Field Detail

PROPERTY_FAMILY

protected static final byte[] PROPERTY_FAMILY

The column family holding properties.

DEFAULT_CACHE_SIZE

protected static final int DEFAULT_CACHE_SIZE

The default cache size (10 000).

See Also:

Constant Field Values

table

protected Table table

The HBase table used to access the model.

Constructor Detail

DirectWriteHBaseStore

public DirectWriteHBaseStore(Resource.Internal resource)
                      throws IOException

Constructs a new DirectWriteHBaseStore on the given resource.

Parameters:

resource - the resource to persist and access

Throws:

IOException - if the HBase server cannot be found

Method Detail

initTable

protected Table initTable(Connection connection,
                          TableName tableName,
                          Admin admin)
                   throws IOException

Initialize the HBase table by creating the columns and column families to store the model.

Parameters:

connection - the connection to the HBase server

tableName - the name of the table to access on the server

admin - the administrator client of the HBase server

Returns:

the created HBase table containing the columns and column families to store the model

Throws:

IOException - if the HBase server cannot be found

size

public int size(InternalEObject internalObject,
                EStructuralFeature feature)

Description copied from interface: org.eclipse.emf.ecore.InternalEObject.EStore

Returns the number of values in the content of the object's feature.

Parameters:

internalObject - the object in question.

feature - a many-valued feature of the object.

Returns:

the number of values in the content of the object's feature.

getContainer

public InternalEObject getContainer(InternalEObject internalObject)

Description copied from interface: org.eclipse.emf.ecore.InternalEObject.EStore

Returns the object's container.

Returns:

the object's container.

See Also:

EObject.eContainer()

getContainingFeature

public EStructuralFeature getContainingFeature(InternalEObject internalObject)

Description copied from interface: org.eclipse.emf.ecore.InternalEObject.EStore

Returns the object's containing feature.

Returns:

the object's containing feature.

See Also:

EObject.eContainingFeature()

eObject

public EObject eObject(Id id)

Description copied from interface: PersistentStore

Returns the resolved EObject identified by the given id or null.

Parameters:

id - the identifier of the EObject to resolve

Returns:

the resolved EObject, or null if no EObject can be resolved

updateContainment

protected void updateContainment(PersistentEObject object,
                                 EReference reference,
                                 PersistentEObject referencedObject)

Add referencedObject in the reference containment list of object. Inverse container feature between referencedObject and object is also updated.

Parameters:

object - the container element

reference - the containment EReference

referencedObject - the element to add to object's containment list

updateInstanceOf

protected void updateInstanceOf(PersistentEObject object)

Computes object's metaclass information and persists them in the database.

Parameters:

object - the PersistentEObject to persist the metaclass of

getFromTable

protected Object getFromTable(PersistentEObject object,
                              EStructuralFeature feature)

Gets the EStructuralFeature feature from the Table for the object.

Parameters:

object - the source element

feature - the EStructuralFeature to get the value of

Returns:

The value of the feature. It can be a String for single-valued EStructuralFeatures or a String[] for many-valued EStructuralFeatures

save

public void save()

Description copied from interface: PersistentStore

Saves the modifications of the owned EObjects in the persistence back-end.

Specified by:

save in interface PersistentStore

Overrides:

save in class AbstractDirectWriteStore<HBasePersistenceBackend>

isSet

public boolean isSet(InternalEObject internalObject,
                     EStructuralFeature feature)

Description copied from class: AbstractDirectWriteStore

Returns whether the object's feature is considered set.

By default, calls the associated methods depending on the type of the feature.

Specified by:

isSet in interface InternalEObject.EStore

Overrides:

isSet in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

internalObject - the object in question.

feature - a feature of the object.

Returns:

true if the object's feature is considered set.

See Also:

AbstractDirectWriteStore.isSetAttribute(PersistentEObject, EAttribute), AbstractDirectWriteStore.isSetReference(PersistentEObject, EReference)

unset

public void unset(InternalEObject internalObject,
                  EStructuralFeature feature)

Description copied from class: AbstractDirectWriteStore

Unsets the feature of the object.

By default, calls the associated methods depending on the type of the feature.

Specified by:

unset in interface InternalEObject.EStore

Overrides:

unset in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

internalObject - the object in question.

feature - a feature of the object.

See Also:

AbstractDirectWriteStore.unsetAttribute(PersistentEObject, EAttribute), AbstractDirectWriteStore.unsetReference(PersistentEObject, EReference)

contains

public boolean contains(InternalEObject internalObject,
                        EStructuralFeature feature,
                        Object value)

Description copied from class: AbstractDirectWriteStore

Returns whether the content of the object's feature contains the given value.

By default, calls the associated methods depending on the type of the feature.

Specified by:

contains in interface InternalEObject.EStore

Overrides:

contains in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

internalObject - the object in question.

feature - a many-valued feature of the object.

value - the value in question.

Returns:

true if the content of the object's feature contains the given value.

See Also:

AbstractDirectWriteStore.containsAttribute(PersistentEObject, EAttribute, Object), AbstractDirectWriteStore.containsReference(PersistentEObject, EReference, PersistentEObject)

indexOf

public int indexOf(InternalEObject internalObject,
                   EStructuralFeature feature,
                   Object value)

Description copied from class: AbstractDirectWriteStore

Returns the first index of the given value in the content of the object's feature.

By default, calls the associated methods depending on the type of the feature.

Specified by:

indexOf in interface InternalEObject.EStore

Overrides:

indexOf in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

internalObject - the object in question.

feature - a many-valued feature of the object.

value - the value in question.

Returns:

the first index of the given value in the content of the object's feature.

See Also:

AbstractDirectWriteStore.indexOfAttribute(PersistentEObject, EAttribute, Object), AbstractDirectWriteStore.indexOfReference(PersistentEObject, EReference, PersistentEObject)

lastIndexOf

public int lastIndexOf(InternalEObject internalObject,
                       EStructuralFeature feature,
                       Object value)

Description copied from class: AbstractDirectWriteStore

Returns the last index of the given value in the content of the object's feature.

By default, calls the associated methods depending on the type of the feature.

Specified by:

lastIndexOf in interface InternalEObject.EStore

Overrides:

lastIndexOf in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

internalObject - the object in question.

feature - a many-valued feature of the object.

value - the value in question.

Returns:

the last index of the given value in the content of the object's feature.

See Also:

AbstractDirectWriteStore.lastIndexOfAttribute(PersistentEObject, EAttribute, Object), AbstractDirectWriteStore.lastIndexOfReference(PersistentEObject, EReference, PersistentEObject)

clear

public void clear(InternalEObject internalObject,
                  EStructuralFeature feature)

Description copied from class: AbstractDirectWriteStore

Removes all values form the content of the object's feature

By default, calls the associated methods depending on the type of the feature.

Specified by:

clear in interface InternalEObject.EStore

Overrides:

clear in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

internalObject - the object in question.

feature - a many-valued feature of the object.

See Also:

AbstractDirectWriteStore.clearAttribute(PersistentEObject, EAttribute), AbstractDirectWriteStore.clearReference(PersistentEObject, EReference)

getAttribute

protected Object getAttribute(PersistentEObject object,
                              EAttribute attribute,
                              int index)

Description copied from class: AbstractDirectWriteStore

Returns the value at the index in the content of the attribute of the object.

Overrides:

getAttribute in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

object - the object

attribute - an attribute of the object

index - an index within the content or PersistentStore.NO_INDEX

Returns:

the value

See Also:

AbstractDirectWriteStore.get(InternalEObject, EStructuralFeature, int)

getReference

protected Object getReference(PersistentEObject object,
                              EReference reference,
                              int index)

Description copied from class: AbstractDirectWriteStore

Returns the value at the index in the content of the reference of the object.

Overrides:

getReference in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

object - the object

reference - a reference of the object

index - an index within the content or PersistentStore.NO_INDEX

Returns:

the value

See Also:

AbstractDirectWriteStore.get(InternalEObject, EStructuralFeature, int)

setAttribute

protected Object setAttribute(PersistentEObject object,
                              EAttribute attribute,
                              int index,
                              Object value)

Description copied from class: AbstractDirectWriteStore

Sets the value at the index in the content of the attribute of the object.

Overrides:

setAttribute in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

object - the object

attribute - an attribute of the object

index - an index within the content or PersistentStore.NO_INDEX

value - the new value

Returns:

the previous value

See Also:

AbstractDirectWriteStore.set(InternalEObject, EStructuralFeature, int, Object)

setReference

protected Object setReference(PersistentEObject object,
                              EReference reference,
                              int index,
                              PersistentEObject referencedObject)

Description copied from class: AbstractDirectWriteStore

Sets the value at the index in the content of the reference of the object.

Overrides:

setReference in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

object - the object

reference - a reference of the object

index - an index within the content or PersistentStore.NO_INDEX

referencedObject - the new value

Returns:

the previous value

See Also:

AbstractDirectWriteStore.set(InternalEObject, EStructuralFeature, int, Object)

addAttribute

protected void addAttribute(PersistentEObject object,
                            EAttribute attribute,
                            int index,
                            Object value)

Description copied from class: AbstractDirectWriteStore

Adds the value at the index in the content of the attribute of the object.

Overrides:

addAttribute in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

object - the object

attribute - a many-valued attribute of the object

index - an index within the content

value - the value to add

See Also:

AbstractDirectWriteStore.add(InternalEObject, EStructuralFeature, int, Object)

addReference

protected void addReference(PersistentEObject object,
                            EReference reference,
                            int index,
                            PersistentEObject referencedObject)

Description copied from class: AbstractDirectWriteStore

Adds the value at the index in the content of the reference of the object.

Overrides:

addReference in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

object - the object

reference - a many-valued reference of the object

index - an index within the content

referencedObject - the value to add

See Also:

AbstractDirectWriteStore.add(InternalEObject, EStructuralFeature, int, Object)

removeAttribute

protected Object removeAttribute(PersistentEObject object,
                                 EAttribute attribute,
                                 int index)

Description copied from class: AbstractDirectWriteStore

Removes the value at the index in the content of the attribute of the object.

Overrides:

removeAttribute in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

object - the object

attribute - a many-valued attribute of the object

index - the index within the content of the value to remove

Returns:

the removed value

See Also:

AbstractDirectWriteStore.remove(InternalEObject, EStructuralFeature, int)

removeReference

protected Object removeReference(PersistentEObject object,
                                 EReference reference,
                                 int index)

Description copied from class: AbstractDirectWriteStore

Removes the value at the index in the content of the reference of the object.

Overrides:

removeReference in class AbstractDirectWriteStore<HBasePersistenceBackend>

Parameters:

object - the object

reference - a many-valued reference of the object

index - the index within the content of the value to remove

Returns:

the removed value

See Also:

AbstractDirectWriteStore.remove(InternalEObject, EStructuralFeature, int)