org.gecko.emf.repository

Class DefaultEMFRepository

java.lang.Object

org.gecko.emf.repository.DefaultEMFRepository

All Implemented Interfaces:

java.lang.AutoCloseable, EMFRepository

public abstract class DefaultEMFRepository
extends java.lang.Object
implements EMFRepository

Default implementation if EMFRepository.

Since:

12.04.2015

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Object,java.lang.Object>	defaultResourceSetLoadOptions

Fields inherited from interface org.gecko.emf.repository.EMFRepository

PROP_BASE_URI, PROP_CONTENT_TYPE, PROP_DEFAULT_LOAD_OPTIONS, PROP_ID

Constructor Summary

Constructors

Constructor and Description
DefaultEMFRepository()

Method Summary

Modifier and Type	Method and Description
void	activate(java.util.Map<java.lang.String,?> properties) Called on service activation
void	cleanResource(Resource resource) In EMF data are cached.
void	close()
URI	createEClassUri(EClass eClass) Creates an uri for a given EClass
URI	createEClassUri(java.lang.String eClass) Creates an uri for a given EClass
<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.
Resource	createResource(URI uri) Creates a resource for the given URI
Resource	createResource(URI uri, java.lang.String contentType) Creates a resource for the given URI
ResourceSet	createResourceSet() Creates a new ResourceSet out side the repository
URI	createUri(EObject object) Creates the URI from a given EObject
void	deactivate() Called on service de-activation
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 name 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 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 uri, boolean loadOnDemand) 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
ResourceSetFactory	getResourceSetFactory() Returns the injected resource set factory
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 object
void	save(java.util.Collection<EObject> objects, java.util.Map<?,?> options) Saves the given object
void	save(EObject... objects) Saves the given object
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
void	save(EObject object, URI uri, java.util.Map<?,?> options) Saves the given object
void	save(java.util.Map<?,?> options, EObject... objects) Saves the given object at the given uri
void	setResourceSetFactory(ResourceSetFactory resourceSetFactory) Sets the resource set factory using OSGi DS
void	unsetResourceSetFactory(ResourceSetFactory resourceSetFactory) Un-sets the resource set factory using OSGi DS

Methods inherited from class java.lang.Object

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

Field Detail

defaultResourceSetLoadOptions

protected java.util.Map<java.lang.Object,java.lang.Object> defaultResourceSetLoadOptions

Constructor Detail

DefaultEMFRepository

public DefaultEMFRepository()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: EMFRepository

Returns the id of the resource provider

Specified by:

getId in interface EMFRepository

Returns:

the id of the resource provider

getBaseUri

public java.lang.String getBaseUri()

Description copied from interface: EMFRepository

Returns the base uri

Specified by:

getBaseUri in interface EMFRepository

Returns:

the base uri

save

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

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

object - the object to save

contentType - the corresponding content type of the model

options - the save options

createProxy

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

Description copied from interface: EMFRepository

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

Specified by:

createProxy in interface EMFRepository

Parameters:

eClass - the EClass to create the proxy for

id - the id of the Object

Returns:

the EObject as a proxy

save

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

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

object - the object to save

contentType - the corresponding content type of the model

save

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

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

objects - the object to save

save

public void save(EObject... objects)

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

objects - the object to save

save

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

Description copied from interface: EMFRepository

Saves the given object at the given uri

Specified by:

save in interface EMFRepository

Parameters:

options - the object to save

objects - the uri of the storage location

save

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

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

objects - the object to save

options - the save options

save

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

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

object - the object to save

options - the save options

save

public void save(EObject object)

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

object - the object to save

save

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

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

object - the object to save

uri - the corresponding content type of the model

options - the save options

save

public void save(EObject object,
                 URI uri)

Description copied from interface: EMFRepository

Saves the given object

Specified by:

save in interface EMFRepository

Parameters:

object - the object to save

uri - the corresponding content type of the model

getEObject

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

Description copied from interface: EMFRepository

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

Specified by:

getEObject in interface EMFRepository

Parameters:

eClass - 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

getEObject

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

Description copied from interface: EMFRepository

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

Specified by:

getEObject in interface EMFRepository

Parameters:

eClass - 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

getAllEObjects

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

Description copied from interface: EMFRepository

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

Specified by:

getAllEObjects in interface EMFRepository

Parameters:

eClass - the EClass of the objects to return

options - the load options

Returns:

the list with objects or an empty List

getAllEObjects

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

Description copied from interface: EMFRepository

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

Specified by:

getAllEObjects in interface EMFRepository

Parameters:

eClass - the EClass of the objects to return

Returns:

the list with objects or an empty List

getEObject

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

Description copied from interface: EMFRepository

Returns the EObject for a given URI or null

Specified by:

getEObject in interface EMFRepository

Parameters:

uri - the object uri

options - the load options

Returns:

the EObject instance or null

getEObject

public <T extends EObject> T getEObject(URI uri)

Description copied from interface: EMFRepository

Returns the EObject for a given URI or null

Specified by:

getEObject in interface EMFRepository

Parameters:

uri - the object uri

Returns:

the EObject instance or null

reload

public void reload(EObject object)

Description copied from interface: EMFRepository

Reloads an object

Specified by:

reload in interface EMFRepository

Parameters:

object - the EObject to reload

delete

public void delete(EObject object)

Description copied from interface: EMFRepository

Deletes an object

Specified by:

delete in interface EMFRepository

Parameters:

object - the EObject to reload

detach

public EObject detach(EObject object)

Description copied from interface: EMFRepository

Detaches an object from the resource

Specified by:

detach in interface EMFRepository

Parameters:

object - the object to detach

Returns:

the detached EObject

getResourceSet

public ResourceSet getResourceSet()

Description copied from interface: EMFRepository

Gets the repository owned ResourceSet

Specified by:

getResourceSet in interface EMFRepository

Returns:

the repository owned ResourceSet

createResourceSet

public ResourceSet createResourceSet()

Description copied from interface: EMFRepository

Creates a new ResourceSet out side the repository

Specified by:

createResourceSet in interface EMFRepository

Returns:

a new ResourceSet

getResource

public Resource getResource(URI uri,
                            boolean loadOnDemand)

Description copied from interface: EMFRepository

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

Specified by:

getResource in interface EMFRepository

Returns:

the Resource or null

createResource

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

Description copied from interface: EMFRepository

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

Specified by:

createResource in interface EMFRepository

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

public Resource createResource(EObject object)

Description copied from interface: EMFRepository

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

Specified by:

createResource in interface EMFRepository

Parameters:

object - the EObject to create the resource from

Returns:

the resource

cleanResource

public void cleanResource(Resource resource)

Description copied from interface: EMFRepository

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

Specified by:

cleanResource in interface EMFRepository

createUri

public URI createUri(EObject object)

Description copied from interface: EMFRepository

Creates the URI from a given EObject

Specified by:

createUri in interface EMFRepository

Parameters:

object - the EObject to create the URI from

Returns:

the URI or null on errors

createEClassUri

public URI createEClassUri(java.lang.String eClass)

Creates an uri for a given EClass

Parameters:

eClass - the EClass to create the URI from

Returns:

the URI or null

createEClassUri

public URI createEClassUri(EClass eClass)

Creates an uri for a given EClass

Parameters:

eClass - the EClass to create the URI from

Returns:

the URI or null

dispose

public void dispose()

Description copied from interface: EMFRepository

Cleans up all resources

Specified by:

dispose in interface EMFRepository

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception

isDisposed

public boolean isDisposed()

Description copied from interface: EMFRepository

Returns true, if the repository was already disposed

Specified by:

isDisposed in interface EMFRepository

createResource

public Resource createResource(URI uri)

Creates a resource for the given URI

Specified by:

createResource in interface EMFRepository

Parameters:

uri - the URI to create a resource from

Returns:

the Resource or null

createResource

public Resource createResource(URI uri,
                               java.lang.String contentType)

Creates a resource for the given URI

Specified by:

createResource in interface EMFRepository

Parameters:

uri - the URI to create a resource from

contentType - the content type of the object

Returns:

the Resource or null

getAdapter

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

Description copied from interface: EMFRepository

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

Specified by:

getAdapter in interface EMFRepository

Parameters:

adapter - the type to adapt to

Returns:

the instance of the adapted type or null

activate

public void activate(java.util.Map<java.lang.String,?> properties)

Called on service activation

Parameters:

properties - the service properties

deactivate

public void deactivate()

Called on service de-activation

getResourceSetFactory

public ResourceSetFactory getResourceSetFactory()

Returns the injected resource set factory

Returns:

the injected resource set factory

unsetResourceSetFactory

public void unsetResourceSetFactory(ResourceSetFactory resourceSetFactory)

Un-sets the resource set factory using OSGi DS

Parameters:

resourceSetFactory - the resource set factory to set

setResourceSetFactory

public void setResourceSetFactory(ResourceSetFactory resourceSetFactory)

Sets the resource set factory using OSGi DS

Parameters:

resourceSetFactory - the resource set factory to set