fr.inria.atlanmod.neoemf.data

Interface PersistenceBackendFactory

All Known Implementing Classes:

AbstractPersistenceBackendFactory, BlueprintsPersistenceBackendFactory, HBasePersistenceBackendFactory, MapDbPersistenceBackendFactory

public interface PersistenceBackendFactory

A factory of PersistenceBackend and PersistentStore.

The creation can be configured using Resource.save(Map) and Resource.load(Map) option maps.

See Also:

PersistenceOptionsBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACKEND_PROPERTY The "back-end" property in the configuration file.
static String	CONFIG_FILE The name of the configuration file of a back-end persistence.

Method Summary

Modifier and Type	Method and Description
void	copyBackend(PersistenceBackend from, PersistenceBackend to) Copies the content from a PersistenceBackend to another.
PersistenceBackend	createPersistentBackend(File directory, Map<?,?> options) Creates a PersistenceBackend in the given directory.
PersistentStore	createPersistentStore(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.

Field Detail

CONFIG_FILE

static final String CONFIG_FILE

The name of the configuration file of a back-end persistence.

See Also:

Constant Field Values

BACKEND_PROPERTY

static final String BACKEND_PROPERTY

The "back-end" property in the configuration file.

See Also:

Constant Field Values

Method Detail

createTransientBackend

PersistenceBackend createTransientBackend()

Creates an in-memory PersistenceBackend.

Returns:

the persistence back-end

createPersistentBackend

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

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

PersistentStore createTransientStore(PersistentResource resource,
                                     PersistenceBackend backend)

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.

createPersistentStore

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

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.

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

IllegalArgumentException - if the given backend is not an instance of the targeted PersistenceBackend for this factory

copyBackend

void copyBackend(PersistenceBackend from,
                 PersistenceBackend to)

Copies the content from a PersistenceBackend to another.

Parameters:

from - the back-end to copy

to - the destination