org.gecko.emf.util.registry

Class DefaultRegistry<T extends EObject,R extends EObject>

java.lang.Object

org.gecko.emf.util.registry.DefaultRegistry<T,R>

public abstract class DefaultRegistry<T extends EObject,R extends EObject>
extends java.lang.Object

Implementation for an abstract registry that handles initializing and unregistering on close. The registry of type R can register objects of type T. The registry is persisted

Since:

05.08.2014

Constructor Summary

Constructors

Constructor and Description
DefaultRegistry()

Method Summary

Modifier and Type	Method and Description
void	addInitializer(RegistryIntializer<T> initializer) Adds a new RegistryIntializer to the registry
abstract boolean	addToRegistry(R registry, T object) Adds the given object to the given registry and returns true, on success otherwise false
protected abstract R	createEmptyRegistryInstance() Creates an emtpy instance of the registry
void	dispose() Disposes the registry
protected abstract java.util.List<T>	getAllObject(R registry) Returns all objects of the given registry
java.util.List<T>	getAllRegisteredObjects() Returns all registered objects or an empty list
LocationUriProvider	getLocationUriProvider() Returns the uri provider instance
protected R	getRegistry() Returns the registry object and initializes it lazy
protected ResourceSet	getResourceSet() Returns the ResourceSet
protected abstract void	initializeResourceSet(ResourceSet resourceSet) Initializes the resource set if necessary
protected void	initRegistry() Initializes the registry
boolean	registerObject(T object) Registers the object and returns true on success otherwise false, if e.g.
abstract boolean	removeFromRegistry(R registry, T object) Removes the given object from the given registry and returns true, on success otherwise false
void	removeInitializer(RegistryIntializer<T> initializer) Removes a new RegistryIntializer from the registry
protected void	saveRegistry() Saves the registry
void	setLocationUriProvider(LocationUriProvider uriProvider) Sets the LocationUriProvider instance
boolean	unregisterObject(T object) Unregisters the object and returns true on success otherwise false.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRegistry

public DefaultRegistry()

Method Detail

addToRegistry

public abstract boolean addToRegistry(R registry,
                                      T object)

Adds the given object to the given registry and returns true, on success otherwise false

Parameters:

registry - the registry to add the object to, cannot be null

object - the object to register, cannot be null

Returns:

true, on successful registration, otherwise false

removeFromRegistry

public abstract boolean removeFromRegistry(R registry,
                                           T object)

Removes the given object from the given registry and returns true, on success otherwise false

Parameters:

registry - the registry to remove the object to, cannot be null

object - the object to remove, cannot be null

Returns:

true, on successful un-registration, otherwise false

getAllRegisteredObjects

public java.util.List<T> getAllRegisteredObjects()

Returns all registered objects or an empty list

Returns:

all registered objects or an empty list

registerObject

public boolean registerObject(T object)

Registers the object and returns true on success otherwise false, if e.g. the object already exists or is null

Parameters:

object - the object to register

Returns:

true on success otherwise false

unregisterObject

public boolean unregisterObject(T object)

Unregisters the object and returns true on success otherwise false.

Parameters:

object - the object to un-register

Returns:

true on success otherwise false

addInitializer

public void addInitializer(RegistryIntializer<T> initializer)

Adds a new RegistryIntializer to the registry

Parameters:

initializer - the initializer to add

removeInitializer

public void removeInitializer(RegistryIntializer<T> initializer)

Removes a new RegistryIntializer from the registry

Parameters:

initializer - the initializer to remove

getLocationUriProvider

public LocationUriProvider getLocationUriProvider()

Returns the uri provider instance

Returns:

the uri provider instance

setLocationUriProvider

public void setLocationUriProvider(LocationUriProvider uriProvider)

Sets the LocationUriProvider instance

Parameters:

uriProvider - the instance to set

dispose

public void dispose()

Disposes the registry

getAllObject

protected abstract java.util.List<T> getAllObject(R registry)

Returns all objects of the given registry

Parameters:

registry - the registry

Returns:

a list of objects, or null

initializeResourceSet

protected abstract void initializeResourceSet(ResourceSet resourceSet)

Initializes the resource set if necessary

Parameters:

resourceSet - the resource set to initialize

createEmptyRegistryInstance

protected abstract R createEmptyRegistryInstance()

Creates an emtpy instance of the registry

Returns:

an emtpy instance of the registry

getResourceSet

protected ResourceSet getResourceSet()

Returns the ResourceSet

Returns:

the ResourceSet

getRegistry

protected R getRegistry()

Returns the registry object and initializes it lazy

Returns:

the registry object

initRegistry

protected void initRegistry()

Initializes the registry

saveRegistry

protected void saveRegistry()

Saves the registry