fr.inria.atlanmod.neoemf.data

Class AbstractPersistenceBackendFactory

java.lang.Object

fr.inria.atlanmod.neoemf.data.AbstractPersistenceBackendFactory

All Implemented Interfaces:

PersistenceBackendFactory

Direct Known Subclasses:

BlueprintsPersistenceBackendFactory, HBasePersistenceBackendFactory, MapDbPersistenceBackendFactory

public abstract class AbstractPersistenceBackendFactory
extends Object
implements PersistenceBackendFactory

An abstract PersistenceBackendFactory that processes common store options and manages the configuration.

Field Summary

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

BACKEND_PROPERTY, CONFIG_FILE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPersistenceBackendFactory() Constructs a new AbstractPersistenceBackendFactory.

Method Summary

Modifier and Type	Method and Description
PersistentStore	createPersistentStore(PersistentResource resource, PersistenceBackend backend, Map<?,?> options) Creates a PersistentStore between the given resource and the given backend according to the given options.
protected abstract PersistentStore	createSpecificPersistentStore(PersistentResource resource, PersistenceBackend backend, Map<?,?> options) Creates a PersistentStore between the given resource and the given backend according to the given options.
protected abstract String	getName() Returns the literal description of the created PersistenceBackend.
protected static List<PersistentStoreOptions>	getStoreOptions(Map<?,?> options) Parses the store options from the given options.
protected void	processGlobalConfiguration(File directory) Creates and saves the NeoEMF configuration.

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.PersistenceBackendFactory

copyBackend, createPersistentBackend, createTransientBackend, createTransientStore

Constructor Detail

AbstractPersistenceBackendFactory

protected AbstractPersistenceBackendFactory()

Constructs a new AbstractPersistenceBackendFactory.

Method Detail

getStoreOptions

@Nonnull
protected static List<PersistentStoreOptions> getStoreOptions(@Nullable
                                                                        Map<?,?> options)

Parses the store options from the given options.

The store options must be a List<PersistentStoreOptions> registered with the PersistentResourceOptions.STORE_OPTIONS key.

Parameters:

options - the options

Returns:

a immutable list of store options

getName

protected abstract String getName()

Returns the literal description of the created PersistenceBackend.

Returns:

the literal description of the created PersistenceBackend

createPersistentStore

public PersistentStore createPersistentStore(PersistentResource resource,
                                             PersistenceBackend backend,
                                             Map<?,?> options)
                                      throws InvalidDataStoreException

Description copied from interface: PersistenceBackendFactory

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.

Specified by:

createPersistentStore in interface PersistenceBackendFactory

Parameters:

resource - the resource

backend - the back-end

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

Returns:

the newly created persistent store.

Throws:

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

createSpecificPersistentStore

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

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 createPersistentStore(PersistentResource, PersistenceBackend, Map), this method is associated to a specific PersistenceBackend, and called before creating global PersistentStore.

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

processGlobalConfiguration

protected void processGlobalConfiguration(File directory)
                                   throws InvalidDataStoreException

Creates and saves the NeoEMF configuration.

The configuration is stored as a properties file beside a database in order to identify a PersistenceBackend.

Parameters:

directory - the directory where the configuration must be stored

Throws:

InvalidDataStoreException - if the configuration cannot be created in the directory