BlueprintsPersistenceBackend (NeoEMF 1.0.2 API)

java.lang.Object
- fr.inria.atlanmod.neoemf.data.AbstractPersistenceBackend
- - fr.inria.atlanmod.neoemf.data.blueprints.BlueprintsPersistenceBackend

All Implemented Interfaces:

PersistenceBackend, Closeable, AutoCloseable
```
public class BlueprintsPersistenceBackend
extends AbstractPersistenceBackend
```
A PersistenceBackend that is responsible of low-level access to a Blueprints database.
It wraps an existing Blueprints database and provides facilities to create and retrieve elements, map PersistentEObjects to Vertex elements in order to speed up attribute access, and manage a set of lightweight caches to improve access time of Vertex from their corresponding PersistentEObject.
This class is used in DirectWriteBlueprintsStore and DirectWriteBlueprintsCacheManyStore to access and manipulate the database.
Instances of BlueprintsPersistenceBackend are created by BlueprintsPersistenceBackendFactory that provides an usable KeyIndexableGraph that can be manipulated by this wrapper.

See Also:

BlueprintsPersistenceBackendFactory, DirectWriteBlueprintsStore, DirectWriteBlueprintsCacheManyStore

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_ECLASS_NAME` The property key used to set metaclass name in metaclass `Vertex`s.
`static String`	`KEY_EPACKAGE_NSURI` The property key used to set the `EPackage` `nsURI` in metaclass `Vertex`s.
`static String`	`KEY_INSTANCE_OF` The label of type conformance `Edge`s.
`static String`	`KEY_METACLASSES` The name of the index entry holding metaclass `Vertex`s.
`static String`	`KEY_NAME` The index key used to retrieve metaclass `Vertex`s.
`static String`	`NAME` The literal description of this back-end.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BlueprintsPersistenceBackend(KeyIndexableGraph baseGraph)` Constructs a new `BlueprintsPersistenceBackend` wrapping the provided `baseGraph`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Vertex`	`addVertex(Id id)` Create a new vertex, add it to the graph, and return the newly created vertex.
`void`	`close()` In our case, it cleanly stops the underlying database.
`void`	`copyTo(BlueprintsPersistenceBackend target)` Copies all the contents of this back-end to the target one.
`Map<EClass,Iterable<Vertex>>`	`getAllInstances(EClass eClass, boolean strict)` Back-end specific computation of `Resource.getAllContents()`.
`IdGraph<KeyIndexableGraph>`	`getGraph()` Provides a direct access to the underlying graph.
`Vertex`	`getOrCreateVertex(PersistentEObject object)` Return the vertex corresponding to the provided `PersistentEObject`.
`Vertex`	`getVertex(Id id)` Returns the vertex corresponding to the provided `id`.
`boolean`	`isClosed()` Returns whether the underlying database is closed.
`PersistentEObject`	`reifyVertex(Vertex vertex)` Reifies the given `Vertex` as a `PersistentEObject`.
`PersistentEObject`	`reifyVertex(Vertex vertex, EClass eClass)` Reifies the given `Vertex` as an `PersistentEObject`.
`void`	`save()` Saves the modifications of the owned `EObject`s in the underlying database.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME
```
public static final String NAME
```
    The literal description of this back-end.
    
    See Also:
    
    Constant Field Values
  - KEY_ECLASS_NAME
```
public static final String KEY_ECLASS_NAME
```
    The property key used to set metaclass name in metaclass Vertexs.
  - KEY_EPACKAGE_NSURI
```
public static final String KEY_EPACKAGE_NSURI
```
    The property key used to set the EPackage nsURI in metaclass Vertexs.
  - KEY_INSTANCE_OF
```
public static final String KEY_INSTANCE_OF
```
    The label of type conformance Edges.
    
    See Also:
    
    Constant Field Values
  - KEY_METACLASSES
```
public static final String KEY_METACLASSES
```
    The name of the index entry holding metaclass Vertexs.
    
    See Also:
    
    Constant Field Values
  - KEY_NAME
```
public static final String KEY_NAME
```
    The index key used to retrieve metaclass Vertexs.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BlueprintsPersistenceBackend
```
protected BlueprintsPersistenceBackend(KeyIndexableGraph baseGraph)
```
    Constructs a new BlueprintsPersistenceBackend wrapping the provided baseGraph.
    This constructor initialize the caches and create the metaclass index.
    This constructor is protected. To create a new BlueprintsPersistenceBackend use BlueprintsPersistenceBackendFactory.createPersistentBackend(java.io.File, Map).
    
    Parameters:
    
    baseGraph - the base KeyIndexableGraph used to access the database
    
    See Also:
    
    BlueprintsPersistenceBackendFactory
- Method Detail
  - isClosed
```
public boolean isClosed()
```
    Description copied from interface: PersistenceBackend
    
    Returns whether the underlying database is closed.
    
    Returns:
    
    true if the database is closed, otherwise false
  - close
```
public void close()
```
    Description copied from interface: PersistenceBackend
    
    In our case, it cleanly stops the underlying database.
  - save
```
public void save()
```
    Description copied from interface: PersistenceBackend
    
    Saves the modifications of the owned EObjects in the underlying database.
  - getAllInstances
```
public Map<EClass,Iterable<Vertex>> getAllInstances(EClass eClass,
                                                    boolean strict)
```
    Description copied from interface: PersistenceBackend
    
    Back-end specific computation of Resource.getAllContents().
    
    Parameters:
    
    eClass - the class to compute the instances of
    
    strict - true if the lookup searches for strict instances
    
    Returns:
    
    an Object containing the back-end specific objects corresponding to the instances of the EClass
  - addVertex
```
public Vertex addVertex(Id id)
```
    Create a new vertex, add it to the graph, and return the newly created vertex.
    
    Parameters:
    
    id - the identifier of the Vertex
    
    Returns:
    
    the newly created vertex
  - getVertex
```
public Vertex getVertex(Id id)
```
    Returns the vertex corresponding to the provided id. If no vertex corresponds to that id, then return null.
    
    Parameters:
    
    id - the Id of the element to find
    
    Returns:
    
    the vertex referenced by the provided EObject or null when no such vertex exists
  - getOrCreateVertex
```
public Vertex getOrCreateVertex(PersistentEObject object)
```
    Return the vertex corresponding to the provided PersistentEObject. If no vertex corresponds to that EObject, then the corresponding Vertex together with its KEY_INSTANCE_OF relationship is created.
    
    Parameters:
    
    object - the PersistentEObject to find
    
    Returns:
    
    the vertex referenced by the provided EObject or null when no such vertex exists
  - reifyVertex
```
public PersistentEObject reifyVertex(Vertex vertex)
```
    Reifies the given Vertex as a PersistentEObject.
    The method guarantees that the same PersistentEObject is returned for a given Vertex in subsequent calls, unless the PersistentEObject returned in previous calls has been already garbage collected.
    This method behaves like reifyVertex(vertex, null).
    
    Parameters:
    
    vertex - the Vertex to reify
    
    Returns:
    
    a PersistentEObject representing the given vertex
  - reifyVertex
```
public PersistentEObject reifyVertex(Vertex vertex,
                                     EClass eClass)
```
    Reifies the given Vertex as an PersistentEObject.
    The method guarantees that the same PersistentEObject is returned for a given Vertex in subsequent calls, unless the PersistentEObject returned in previous calls has been already garbage collected.
    
    Parameters:
    
    vertex - the Vertex to reify
    
    eClass - the expected EClass of the reified object. Can be set to null if not known.
    
    Returns:
    
    a PersistentEObject representing the given vertex
  - copyTo
```
public void copyTo(BlueprintsPersistenceBackend target)
```
    Copies all the contents of this back-end to the target one.
    
    Parameters:
    
    target - the BlueprintsPersistenceBackend to copy the elements to
  - getGraph
```
public IdGraph<KeyIndexableGraph> getGraph()
```
    Provides a direct access to the underlying graph.
    This method is public for tool compatibility (see the Mogwaï) framework, NeoEMF consistency is not guaranteed if the graph is modified manually.
    
    Returns:
    
    the underlying Blueprints graph

Class BlueprintsPersistenceBackend

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME

KEY_ECLASS_NAME

KEY_EPACKAGE_NSURI

KEY_INSTANCE_OF

KEY_METACLASSES

KEY_NAME

Constructor Detail

BlueprintsPersistenceBackend

Method Detail

isClosed

close

save

getAllInstances

addVertex

getVertex

getOrCreateVertex

reifyVertex

reifyVertex

copyTo

getGraph