org.gecko.emf.repository

Interface EMFRepository

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

DefaultEMFRepository

public interface EMFRepository
extends java.lang.AutoCloseable

Interface for a EMF persistence repository

Since:

12.04.2015

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_BASE_URI
static java.lang.String	PROP_CONTENT_TYPE
static java.lang.String	PROP_DEFAULT_LOAD_OPTIONS
static java.lang.String	PROP_ID

Method Summary

Modifier and Type	Method and Description
void	cleanResource(Resource allTlcResource) In EMF data are cached.
<T extends EObject> T	createProxy(EClass eClass, java.lang.String id) Returns the EObject tha is a proxy of the given EClass and with the given id
Resource	createResource(EObject object) Creates a resource for a given EObject.
Resource	createResource(EObject object, java.lang.String contentType) Creates a resource for a given EObject.
ResourceSet	createResourceSet() Creates a new ResourceSet out side the repository
URI	createUri(EObject object) Creates the URI from a given EObject
void	delete(EObject object) Deletes an object
EObject	detach(EObject object) Detaches an object from the resource
void	dispose() Cleans up all resources
java.lang.Object	getAdapter(java.lang.Class<?> adapter) An adapter method to adapt the repository for e.g.
<T extends EObject> java.util.List<T>	getAllEObjects(EClass eClass) Returns a list of all EObject of the given EClass or an empty List
<T extends EObject> java.util.List<T>	getAllEObjects(EClass eClass, java.util.Map<?,?> options) Returns a list of all EObject of the given EClass or an empty List
java.lang.String	getBaseUri() Returns the base uri
<T extends EObject> T	getEObject(EClass eClass, java.lang.Object id) Returns the EObject of the given EClass and id or null
<T extends EObject> T	getEObject(EClass eClass, java.lang.Object id, java.util.Map<?,?> options) Returns the EObject of the given EClass and id or null
<T extends EObject> T	getEObject(java.lang.String eClassName, java.lang.Object id) Returns the EObject of the given EClass name and id or null
<T extends EObject> T	getEObject(java.lang.String eClassName, java.lang.Object id, java.util.Map<?,?> options) Returns the EObject of the given EClass name and id or null
<T extends EObject> T	getEObject(URI uri) Returns the EObject for a given URI or null
<T extends EObject> T	getEObject(URI uri, java.util.Map<?,?> options) Returns the EObject for a given URI or null
java.lang.String	getId() Returns the id of the resource provider
Resource	getResource(URI createURI, boolean b) Gets a resource for the given URI and loads it on demand, if the parameter is set to true
ResourceSet	getResourceSet() Gets the repository owned ResourceSet
boolean	isDisposed() Returns true, if the repository was already disposed
void	reload(EObject object) Reloads an object
void	save(java.util.Collection<EObject> objects) Saves the given objects
void	save(java.util.Collection<EObject> object, java.util.Map<?,?> options) Saves the given objects
void	save(EObject... objects) Saves the given objects
void	save(EObject object) Saves the given object
void	save(EObject object, java.util.Map<?,?> options) Saves the given object
void	save(EObject object, java.lang.String contentType) Saves the given object
void	save(EObject object, java.lang.String contentType, java.util.Map<?,?> options) Saves the given object
void	save(EObject object, URI uri) Saves the given object at the given uri
void	save(EObject object, URI uri, java.util.Map<?,?> options) Saves the given object at the given uri
void	save(java.util.Map<?,?> options, EObject... objects) Saves the given objects

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

PROP_ID

static final java.lang.String PROP_ID

See Also:

Constant Field Values

PROP_BASE_URI

static final java.lang.String PROP_BASE_URI

See Also:

Constant Field Values

PROP_CONTENT_TYPE

static final java.lang.String PROP_CONTENT_TYPE

See Also:

Constant Field Values

PROP_DEFAULT_LOAD_OPTIONS

static final java.lang.String PROP_DEFAULT_LOAD_OPTIONS

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns the id of the resource provider

Returns:

the id of the resource provider

getResourceSet

ResourceSet getResourceSet()

Gets the repository owned ResourceSet

Returns:

the repository owned ResourceSet

createResourceSet

ResourceSet createResourceSet()

Creates a new ResourceSet out side the repository

Returns:

a new ResourceSet

getResource

Resource getResource(URI createURI,
                     boolean b)

Gets a resource for the given URI and loads it on demand, if the parameter is set to true

Parameters:

uri - the URI to create a resource from

loadOnDemand - set to true if the resource should be loaded

Returns:

the Resource or null

cleanResource

void cleanResource(Resource allTlcResource)

In EMF data are cached. Especially for query is this can be annoying, so this helper method unload the resource

Parameters:

resource - the resource to be cleaned

createResource

Resource createResource(EObject object,
                        java.lang.String contentType)

Creates a resource for a given EObject. If the object already has a resource, this will returned. Otherwise a new resource will be created and the object will be attached to the resource

Parameters:

object - the EObject to create the resource from

contentType - the content type of the object (find it in the package interface)

Returns:

the resource

createResource

Resource createResource(EObject object)

Creates a resource for a given EObject. If the object already has a resource, this will returned. Otherwise a new resource will be created and the object will be attached to the resource

Parameters:

object - the EObject to create the resource from

Returns:

the resource

getBaseUri

java.lang.String getBaseUri()

Returns the base uri

Returns:

the base uri

createProxy

<T extends EObject> T createProxy(EClass eClass,
                                  java.lang.String id)

Returns the EObject tha is a proxy of the given EClass and with the given id

Parameters:

eClass - the EClass to create the proxy for

id - the id of the Object

Returns:

the EObject as a proxy

getEObject

<T extends EObject> T getEObject(URI uri)

Returns the EObject for a given URI or null

Parameters:

uri - the object uri

Returns:

the EObject instance or null

getEObject

<T extends EObject> T getEObject(URI uri,
                                 java.util.Map<?,?> options)

Returns the EObject for a given URI or null

Parameters:

uri - the object uri

options - the load options

Returns:

the EObject instance or null

getEObject

<T extends EObject> T getEObject(java.lang.String eClassName,
                                 java.lang.Object id)

Returns the EObject of the given EClass name and id or null

Parameters:

eClassName - the String name of the EObject

id - the primary key of the object

Returns:

the EObject of the given EClass name and id or null

getEObject

<T extends EObject> T getEObject(java.lang.String eClassName,
                                 java.lang.Object id,
                                 java.util.Map<?,?> options)

Returns the EObject of the given EClass name and id or null

Parameters:

eClassName - the String name of the EObject

id - the primary key of the object

options - the load options

Returns:

the EObject of the given EClass name and id or null

createUri

URI createUri(EObject object)

Creates the URI from a given EObject

Parameters:

object - the EObject to create the URI from

Returns:

the URI or null on errors

reload

void reload(EObject object)

Reloads an object

Parameters:

object - the EObject to reload

delete

void delete(EObject object)

Deletes an object

Parameters:

object - the EObject to reload

save

void save(EObject object,
          java.lang.String contentType)

Saves the given object

Parameters:

object - the object to save

contentType - the corresponding content type of the model

save

void save(EObject object,
          java.lang.String contentType,
          java.util.Map<?,?> options)

Saves the given object

Parameters:

object - the object to save

contentType - the corresponding content type of the model

options - the save options

save

void save(EObject object)

Saves the given object

Parameters:

object - the object to save

save

void save(EObject object,
          java.util.Map<?,?> options)

Saves the given object

Parameters:

object - the object to save

options - the save options

save

void save(EObject object,
          URI uri)

Saves the given object at the given uri

Parameters:

object - the object to save

uri - the uri of the storage location

save

void save(EObject object,
          URI uri,
          java.util.Map<?,?> options)

Saves the given object at the given uri

Parameters:

object - the object to save

uri - the uri of the storage location

options - the save options

save

void save(java.util.Collection<EObject> object,
          java.util.Map<?,?> options)

Saves the given objects

Parameters:

object - the object to save

options - the save options

save

void save(java.util.Map<?,?> options,
          EObject... objects)

Saves the given objects

Parameters:

objects - the object to save

options - the save options

save

void save(java.util.Collection<EObject> objects)

Saves the given objects

Parameters:

objects - the object to save

options - the save options

save

void save(EObject... objects)

Saves the given objects

Parameters:

object - the object to save

options - the save options

detach

EObject detach(EObject object)

Detaches an object from the resource

Parameters:

object - the object to detach

Returns:

the detached EObject

getEObject

<T extends EObject> T getEObject(EClass eClass,
                                 java.lang.Object id)

Returns the EObject of the given EClass and id or null

Parameters:

eClass - the EClass of the EObject

id - the primary key of the object

Returns:

the EObject of the given EClass name and id or null

getEObject

<T extends EObject> T getEObject(EClass eClass,
                                 java.lang.Object id,
                                 java.util.Map<?,?> options)

Returns the EObject of the given EClass and id or null

Parameters:

eClass - the EClass of the EObject

id - the primary key of the object

options - the load options

Returns:

the EObject of the given EClass name and id or null

getAllEObjects

<T extends EObject> java.util.List<T> getAllEObjects(EClass eClass)

Returns a list of all EObject of the given EClass or an empty List

Parameters:

eClass - the EClass of the objects to return

Returns:

the list with objects or an empty List

getAllEObjects

<T extends EObject> java.util.List<T> getAllEObjects(EClass eClass,
                                                     java.util.Map<?,?> options)

Returns a list of all EObject of the given EClass or an empty List

Parameters:

eClass - the EClass of the objects to return

options - the load options

Returns:

the list with objects or an empty List

Throws:

EMFRepositoryException - thrown when an error during getting all objects occur

isDisposed

boolean isDisposed()

Returns true, if the repository was already disposed

dispose

void dispose()

Cleans up all resources

getAdapter

java.lang.Object getAdapter(java.lang.Class<?> adapter)

An adapter method to adapt the repository for e.g. query builders

Parameters:

adapter - the type to adapt to

Returns:

the instance of the adapted type or null