fr.inria.atlanmod.neoemf.data

Class AbstractBackendFactory<C extends Config>

java.lang.Object

fr.inria.atlanmod.neoemf.data.mapping.AbstractMapperFactory

fr.inria.atlanmod.neoemf.data.AbstractBackendFactory<C>

All Implemented Interfaces:

BackendFactory

Direct Known Subclasses:

BerkeleyDbBackendFactory, BlueprintsBackendFactory, HBaseBackendFactory, InMemoryBackendFactory, MapDbBackendFactory, MongoDbBackendFactory

@ParametersAreNonnullByDefault
public abstract class AbstractBackendFactory<C extends Config>
extends AbstractMapperFactory
implements BackendFactory

An abstract BackendFactory.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBackendFactory(String name) Constructs a new AbstractBackendFactory.
protected	AbstractBackendFactory(String name, boolean supportsTransient) Constructs a new AbstractBackendFactory.

Method Summary

Modifier and Type	Method and Description
Backend	createBackend(org.eclipse.emf.common.util.URI uri, ImmutableConfig baseConfig) Creates a new Backend located by the uri.
protected Backend	createLocalBackend(Path directory, C config) Creates a new file-based Backend.
protected Backend	createRemoteBackend(URL url, C config) Creates a new server-based Backend.
String	name() Returns the literal description of the created Backend.
boolean	supportsTransient() Returns whether the Backends created by this factory support the transient state.

Methods inherited from class fr.inria.atlanmod.neoemf.data.mapping.AbstractMapperFactory

createMapper, createMapper

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBackendFactory

protected AbstractBackendFactory(String name)

Constructs a new AbstractBackendFactory.

Parameters:

name - the literal description of this factory

AbstractBackendFactory

protected AbstractBackendFactory(String name,
                                 boolean supportsTransient)

Constructs a new AbstractBackendFactory.

Parameters:

name - the literal description of this factory

supportsTransient - true if the backends created by this factory support the transient state

Method Detail

name

public final String name()

Description copied from interface: BackendFactory

Returns the literal description of the created Backend.

Specified by:

name in interface BackendFactory

Returns:

the literal description of the created Backend

supportsTransient

public boolean supportsTransient()

Description copied from interface: BackendFactory

Returns whether the Backends created by this factory support the transient state.

Specified by:

supportsTransient in interface BackendFactory

Returns:

true if the Backends created by this factory support the transient state, false otherwise

createBackend

@Nonnull
public Backend createBackend(org.eclipse.emf.common.util.URI uri,
                                       ImmutableConfig baseConfig)

Description copied from interface: BackendFactory

Creates a new Backend located by the uri.

Specified by:

createBackend in interface BackendFactory

Parameters:

uri - the URI where to store the back-end

baseConfig - the base configuration that defines the behaviour of the back-end

Returns:

a new back-end

createLocalBackend

@Nonnull
protected Backend createLocalBackend(Path directory,
                                               C config)
                                        throws Exception

Creates a new file-based Backend.

By default, this method throws an UnsupportedOperationException.

Parameters:

directory - the file path where to store the database

config - the configuration that defines the behaviour of the back-end

Returns:

a new back-end

Throws:

Exception - if an error occurs during the back-end initialization

createRemoteBackend

@Nonnull
protected Backend createRemoteBackend(URL url,
                                                C config)
                                         throws Exception

Creates a new server-based Backend.

By default, this method throws an UnsupportedOperationException.

Parameters:

url - the URL locating the database

config - the configuration that defines the behaviour of the back-end

Returns:

a new back-end

Throws:

Exception - if an error occurs during the back-end initialization