fr.inria.atlanmod.neoemf.data.blueprints.store

Class DirectWriteBlueprintsStore

java.lang.Object

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

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

fr.inria.atlanmod.neoemf.data.blueprints.store.DirectWriteBlueprintsStore

All Implemented Interfaces:

DirectWriteStore, PersistentStore, InternalEObject.EStore

Direct Known Subclasses:

DirectWriteBlueprintsCacheManyStore

public class DirectWriteBlueprintsStore
extends AbstractDirectWriteStore<BlueprintsPersistenceBackend>

A DirectWriteStore that translates model-level operations to Blueprints calls.

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 database serialization and deserialization using its embedded BlueprintsPersistenceBackend.

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, BlueprintsPersistenceBackend, AbstractPersistentStoreDecorator

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONTAINER The label used to define container Edges.
protected static String	CONTAINING_FEATURE The property key used to define the opposite containing feature in container Edges.
protected static String	CONTENTS The label used to link root vertex to top-level elements.
protected static String	POSITION The property key used to define the index of an edge.
protected static String	SEPARATOR The string used as a separator between values of multi-valued attributes.
protected static String	SIZE_LITERAL The property key used to define the number of edges with a specific label.

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
DirectWriteBlueprintsStore(Resource.Internal resource, BlueprintsPersistenceBackend backend) Constructs a new DirectWriteBlueprintsStore between the given resource and the backend.

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 value) Adds the value at the index in the content of the reference of the object.
protected void	clearAttribute(PersistentEObject object, EAttribute attribute) Removes all values form the content of the attribute of the object.
protected void	clearReference(PersistentEObject object, EReference reference) Removes all values form the content of the reference of the object.
protected boolean	containsAttribute(PersistentEObject object, EAttribute attribute, Object value) Returns whether the content of the attribute of the object contains the given value.
protected boolean	containsReference(PersistentEObject object, EReference reference, PersistentEObject value) Returns whether the content of the reference of the object contains the given value.
EObject	eObject(Id id) Search in the database the Vertex corresponding to the given id and reifies it.
EList<EObject>	getAllInstances(EClass eClass, boolean strict) Computes efficiently allInstances operation by using underlying graph facilities.
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	getReference(PersistentEObject object, EReference reference, int index) Returns the value at the index in the content of the reference of the object.
protected Integer	getSize(Vertex vertex, EStructuralFeature feature) Finds the number of elements contained in the given feature.
protected int	indexOfAttribute(PersistentEObject object, EAttribute attribute, Object value) Returns the first index of the given value in the content of the attribute of the object.
protected int	indexOfReference(PersistentEObject object, EReference reference, PersistentEObject value) Returns the first index of the given value in the content of the reference of the object.
protected boolean	isSetAttribute(PersistentEObject object, EAttribute attribute) Returns whether the attribute of the object is considered set.
protected boolean	isSetReference(PersistentEObject object, EReference reference) Returns whether the reference of the object is considered set.
protected int	lastIndexOfAttribute(PersistentEObject object, EAttribute attribute, Object value) Returns the last index of the given value in the content of the attribute of the object.
protected int	lastIndexOfReference(PersistentEObject object, EReference reference, PersistentEObject value) Returns the last index of the given value in the content of the reference of the object.
protected InternalEObject	reifyVertex(Vertex vertex) Creates an InternalEObject from the given vertex.
protected InternalEObject	reifyVertex(Vertex vertex, EClass eClass) Creates an InternalEObject from the given vertex, and sets its EClass with the given EClass.
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.
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 value) 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.
protected void	unsetAttribute(PersistentEObject object, EAttribute attribute) Unsets the attribute of the object.
protected void	unsetReference(PersistentEObject object, EReference reference) Unsets the reference of the object.

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

add, clear, contains, create, get, hashCode, indexOf, isEmpty, isSet, lastIndexOf, move, parseProperty, remove, resource, save, serializeToProperty, set, toArray, toArray, unset

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR

protected static final String SEPARATOR

The string used as a separator between values of multi-valued attributes.

See Also:

Constant Field Values

POSITION

protected static final String POSITION

The property key used to define the index of an edge.

See Also:

Constant Field Values

CONTAINER

protected static final String CONTAINER

The label used to define container Edges.

See Also:

Constant Field Values

CONTENTS

protected static final String CONTENTS

The label used to link root vertex to top-level elements.

See Also:

Constant Field Values

CONTAINING_FEATURE

protected static final String CONTAINING_FEATURE

The property key used to define the opposite containing feature in container Edges.

See Also:

Constant Field Values

SIZE_LITERAL

protected static final String SIZE_LITERAL

The property key used to define the number of edges with a specific label.

See Also:

Constant Field Values

Constructor Detail

DirectWriteBlueprintsStore

public DirectWriteBlueprintsStore(Resource.Internal resource,
                                  BlueprintsPersistenceBackend backend)

Constructs a new DirectWriteBlueprintsStore between the given resource and the backend.

Parameters:

resource - the resource to persist and access

backend - the persistence back-end used to store the model

Method Detail

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<BlueprintsPersistenceBackend>

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<BlueprintsPersistenceBackend>

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<BlueprintsPersistenceBackend>

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 value)

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<BlueprintsPersistenceBackend>

Parameters:

object - the object

reference - a reference 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)

isSetAttribute

protected boolean isSetAttribute(PersistentEObject object,
                                 EAttribute attribute)

Description copied from class: AbstractDirectWriteStore

Returns whether the attribute of the object is considered set.

Overrides:

isSetAttribute in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

attribute - an attribute of the object

Returns:

true if the attribute is considered set

See Also:

AbstractDirectWriteStore.isSet(InternalEObject, EStructuralFeature)

isSetReference

protected boolean isSetReference(PersistentEObject object,
                                 EReference reference)

Description copied from class: AbstractDirectWriteStore

Returns whether the reference of the object is considered set.

Overrides:

isSetReference in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

reference - a reference of the object

Returns:

true if the reference is considered set

See Also:

AbstractDirectWriteStore.isSet(InternalEObject, EStructuralFeature)

unsetAttribute

protected void unsetAttribute(PersistentEObject object,
                              EAttribute attribute)

Description copied from class: AbstractDirectWriteStore

Unsets the attribute of the object.

Overrides:

unsetAttribute in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

attribute - an attribute of the object

See Also:

AbstractDirectWriteStore.unset(InternalEObject, EStructuralFeature)

unsetReference

protected void unsetReference(PersistentEObject object,
                              EReference reference)

Description copied from class: AbstractDirectWriteStore

Unsets the reference of the object.

Overrides:

unsetReference in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

reference - a reference of the object

See Also:

AbstractDirectWriteStore.unset(InternalEObject, EStructuralFeature)

containsAttribute

protected boolean containsAttribute(PersistentEObject object,
                                    EAttribute attribute,
                                    Object value)

Description copied from class: AbstractDirectWriteStore

Returns whether the content of the attribute of the object contains the given value.

Overrides:

containsAttribute in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

attribute - a many-valued attribute of the object

value - the value to look for

Returns:

true if the attribute contains the given value

See Also:

AbstractDirectWriteStore.contains(InternalEObject, EStructuralFeature, Object)

containsReference

protected boolean containsReference(PersistentEObject object,
                                    EReference reference,
                                    PersistentEObject value)

Description copied from class: AbstractDirectWriteStore

Returns whether the content of the reference of the object contains the given value.

Overrides:

containsReference in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

reference - a many-valued reference of the object

value - the value to look for

Returns:

true if the reference contains the given value

See Also:

AbstractDirectWriteStore.contains(InternalEObject, EStructuralFeature, Object)

indexOfAttribute

protected int indexOfAttribute(PersistentEObject object,
                               EAttribute attribute,
                               Object value)

Description copied from class: AbstractDirectWriteStore

Returns the first index of the given value in the content of the attribute of the object.

Overrides:

indexOfAttribute in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

attribute - a many-valued attribute of the object

value - the value to look for

Returns:

the first index of the given value, or PersistentStore.NO_INDEX if it is not found

See Also:

AbstractDirectWriteStore.indexOf(InternalEObject, EStructuralFeature, Object)

indexOfReference

protected int indexOfReference(PersistentEObject object,
                               EReference reference,
                               PersistentEObject value)

Description copied from class: AbstractDirectWriteStore

Returns the first index of the given value in the content of the reference of the object.

Overrides:

indexOfReference in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

reference - a many-valued reference of the object

value - the value to look for

Returns:

the first index of the given value, or PersistentStore.NO_INDEX if it is not found

See Also:

AbstractDirectWriteStore.indexOf(InternalEObject, EStructuralFeature, Object)

lastIndexOfAttribute

protected int lastIndexOfAttribute(PersistentEObject object,
                                   EAttribute attribute,
                                   Object value)

Description copied from class: AbstractDirectWriteStore

Returns the last index of the given value in the content of the attribute of the object.

Overrides:

lastIndexOfAttribute in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

attribute - a many-valued attribute of the object

value - the value to look for

Returns:

the last index of the given value, or PersistentStore.NO_INDEX if it is not found

See Also:

AbstractDirectWriteStore.lastIndexOf(InternalEObject, EStructuralFeature, Object)

lastIndexOfReference

protected int lastIndexOfReference(PersistentEObject object,
                                   EReference reference,
                                   PersistentEObject value)

Description copied from class: AbstractDirectWriteStore

Returns the last index of the given value in the content of the reference of the object.

Overrides:

lastIndexOfReference in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

reference - a many-valued reference of the object

value - the value to look for

Returns:

the last index of the given value, or PersistentStore.NO_INDEX if it is not

See Also:

AbstractDirectWriteStore.lastIndexOf(InternalEObject, EStructuralFeature, 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<BlueprintsPersistenceBackend>

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 value)

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<BlueprintsPersistenceBackend>

Parameters:

object - the object

reference - a many-valued reference of the object

index - an index within the content

value - 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<BlueprintsPersistenceBackend>

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<BlueprintsPersistenceBackend>

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)

clearAttribute

protected void clearAttribute(PersistentEObject object,
                              EAttribute attribute)

Description copied from class: AbstractDirectWriteStore

Removes all values form the content of the attribute of the object.

Overrides:

clearAttribute in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

attribute - a many-valued attribute of the object

See Also:

AbstractDirectWriteStore.clear(InternalEObject, EStructuralFeature)

clearReference

protected void clearReference(PersistentEObject object,
                              EReference reference)

Description copied from class: AbstractDirectWriteStore

Removes all values form the content of the reference of the object.

Overrides:

clearReference in class AbstractDirectWriteStore<BlueprintsPersistenceBackend>

Parameters:

object - the object

reference - a many-valued reference of the object

See Also:

AbstractDirectWriteStore.clear(InternalEObject, EStructuralFeature)

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()

getSize

protected Integer getSize(Vertex vertex,
                          EStructuralFeature feature)

Finds the number of elements contained in the given feature.

Parameters:

vertex - the input Vertex of the feature

feature - the EStructuralFeature describing the feature to access

Returns:

the size of the feature if it is multi-valued, 0 otherwise

reifyVertex

protected InternalEObject reifyVertex(Vertex vertex)

Creates an InternalEObject from the given vertex.

Parameters:

vertex - the Vertex to reify

Returns:

an InternalEObject built from the provided Vertex

See Also:

reifyVertex(Vertex, EClass)

reifyVertex

protected InternalEObject reifyVertex(Vertex vertex,
                                      EClass eClass)

Creates an InternalEObject from the given vertex, and sets its EClass with the given EClass.

This method speeds-up the reification for objects with a known EClass by avoiding unnecessary database accesses.

Parameters:

vertex - the Vertex to reify

eClass - the EClass representing the type of the element to create

Returns:

an InternalEObject build from the provided Vertex

eObject

public EObject eObject(Id id)

Search in the database the Vertex corresponding to the given id and reifies it.

Parameters:

id - the Id to search

Returns:

a reified EObject if the corresponding Vertex has been found in the database, null otherwise

getAllInstances

public EList<EObject> getAllInstances(EClass eClass,
                                      boolean strict)

Computes efficiently allInstances operation by using underlying graph facilities. This method uses database indices to avoid costly traversal of the entire model.

Parameters:

eClass - the EClass to get the instances of

strict - set to true if the method should look for instances of eClass only, set to false if the method should also return elements that are subclasses of eClass

Returns:

an EList containing all the EObjects that are instances of the given EClass