fr.inria.atlanmod.neoemf.data.blueprints

Class BlueprintsPersistenceBackendFactory

java.lang.Object

fr.inria.atlanmod.neoemf.data.AbstractPersistenceBackendFactory

fr.inria.atlanmod.neoemf.data.blueprints.BlueprintsPersistenceBackendFactory

All Implemented Interfaces:

PersistenceBackendFactory

public final class BlueprintsPersistenceBackendFactory
extends AbstractPersistenceBackendFactory

A factory that creates instances of BlueprintsPersistenceBackend.

As other implementations of PersistenceBackendFactory, this class can create transient and persistent databases. Persistent back-end creation can be configured using Resource.save(Map) and Resource.load(Map) option maps.

The factory handles transient back-ends by creating an in-memory TinkerGraph instance. Persistent back-ends are created according to the provided resource options (see BlueprintsResourceOptions and BlueprintsStoreOptions). Default back-end configuration (store directory and graph type) is called dynamically according to the provided Blueprints implementation InternalBlueprintsTgConfiguration.

See Also:

PersistentResource, BlueprintsPersistenceBackend, BlueprintsOptionsBuilder, BlueprintsResourceOptions, BlueprintsStoreOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The literal description of the factory.

Fields inherited from interface fr.inria.atlanmod.neoemf.data.PersistenceBackendFactory

BACKEND_PROPERTY, CONFIG_FILE

Method Summary

Modifier and Type	Method and Description
void	copyBackend(PersistenceBackend from, PersistenceBackend to) Copies the content from a PersistenceBackend to another.
BlueprintsPersistenceBackend	createPersistentBackend(File directory, Map<?,?> options) Creates a PersistenceBackend in the given directory.
protected PersistentStore	createSpecificPersistentStore(PersistentResource resource, PersistenceBackend backend, Map<?,?> options) Creates a PersistentStore between the given resource and the given backend according to the given options.
PersistenceBackend	createTransientBackend() Creates an in-memory PersistenceBackend.
PersistentStore	createTransientStore(PersistentResource resource, PersistenceBackend backend) Creates a PersistentStore between the given resource and the given in-memory backend.
static PersistenceBackendFactory	getInstance() Returns the instance of this class.
String	getName() Returns the literal description of the created PersistenceBackend.

Methods inherited from class fr.inria.atlanmod.neoemf.data.AbstractPersistenceBackendFactory

createPersistentStore, getStoreOptions, processGlobalConfiguration

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 the factory.

See Also:

Constant Field Values

Method Detail

getInstance

@Nonnull
public static PersistenceBackendFactory getInstance()

Returns the instance of this class.

Returns:

the instance of this class

getName

public String getName()

Description copied from class: AbstractPersistenceBackendFactory

Returns the literal description of the created PersistenceBackend.

Specified by:

getName in class AbstractPersistenceBackendFactory

Returns:

the literal description of the created PersistenceBackend

createSpecificPersistentStore

protected PersistentStore createSpecificPersistentStore(PersistentResource resource,
                                                        PersistenceBackend backend,
                                                        Map<?,?> options)
                                                 throws InvalidDataStoreException

Description copied from class: AbstractPersistenceBackendFactory

Creates a PersistentStore between the given resource and the given backend according to the given options.

The returned PersistentStore may be a succession of several PersistentStore.

Contrary to AbstractPersistenceBackendFactory.createPersistentStore(PersistentResource, PersistenceBackend, Map), this method is associated to a specific PersistenceBackend, and called before creating global PersistentStore.

Specified by:

createSpecificPersistentStore in class AbstractPersistenceBackendFactory

Parameters:

resource - the resource

backend - the back-end

options - the options

Returns:

the newly created persistent store

Throws:

InvalidDataStoreException - if there is at least one invalid value in options, or if an option is missing

createTransientBackend

public PersistenceBackend createTransientBackend()

Description copied from interface: PersistenceBackendFactory

Creates an in-memory PersistenceBackend.

Returns:

the persistence back-end

createPersistentBackend

public BlueprintsPersistenceBackend createPersistentBackend(File directory,
                                                            Map<?,?> options)
                                                     throws InvalidDataStoreException

Description copied from interface: PersistenceBackendFactory

Creates a PersistenceBackend in the given directory.

Parameters:

directory - the directory

options - the options that defines the behaviour of the back-end

Returns:

the persistence back-end

Throws:

InvalidDataStoreException - the invalid datastore exception

createTransientStore

public PersistentStore createTransientStore(PersistentResource resource,
                                            PersistenceBackend backend)

Description copied from interface: PersistenceBackendFactory

Creates a PersistentStore between the given resource and the given in-memory backend.

Parameters:

resource - the resource

backend - the back-end

Returns:

the newly created persistent store.

copyBackend

public void copyBackend(PersistenceBackend from,
                        PersistenceBackend to)

Description copied from interface: PersistenceBackendFactory

Copies the content from a PersistenceBackend to another.

Parameters:

from - the back-end to copy

to - the destination