Package org.processmining.framework.providedobjects.impl

Class ProvidedObjectManagerImpl

java.lang.Object

org.processmining.framework.providedobjects.impl.ProvidedObjectManagerImpl

All Implemented Interfaces:

ProvidedObjectManager

public class ProvidedObjectManagerImpl
extends Object
implements ProvidedObjectManager

Constructor Summary

Constructors

Constructor	Description
ProvidedObjectManagerImpl()

Method Summary

Modifier and Type	Method	Description
void	changeProvidedObjectObject(ProvidedObjectID id, Object newObject)
void	clear()
<T> ProvidedObjectID	createProvidedObject(String label, T object, Class<? super T> type, PluginContext context)	This method creates a new providedObjectID.
<T> ProvidedObjectID	createProvidedObject(String label, T object, PluginContext context)	This method creates a new providedObjectID.
List<ProvidedObjectID>	createProvidedObjects(PluginContext context)	This method creates a list of new providedObjectIDs for each object in the PluginExecutionResult of the context.
void	deleteProvidedObject(ProvidedObjectID id)
String	getProvidedObjectLabel(ProvidedObjectID id)
ProvidedObjectLifeCycleListener.ListenerList	getProvidedObjectLifeCylceListeners()
Object	getProvidedObjectObject(ProvidedObjectID id, boolean waitIfFuture)	returns the provided object identified by this ID.
List<ProvidedObjectID>	getProvidedObjects()	Returns all provided Object IDs known to the framework.
Class<? extends Object>	getProvidedObjectType(ProvidedObjectID id)
boolean	isEnabled()
void	providedObjectNameChanged(ProvidedObjectID objectID)
void	providedObjectObjectChanged(ProvidedObjectID objectID)
void	relabelProvidedObject(ProvidedObjectID id, String label)
void	setEnabled(boolean enabled)

Methods inherited from class java.lang.Object

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

Constructor Details

ProvidedObjectManagerImpl

public ProvidedObjectManagerImpl()

Method Details

getProvidedObjectLifeCylceListeners

public ProvidedObjectLifeCycleListener.ListenerList getProvidedObjectLifeCylceListeners()

Specified by:

getProvidedObjectLifeCylceListeners in interface ProvidedObjectManager

createProvidedObject

public <T> ProvidedObjectID createProvidedObject(String label,
 T object,
 PluginContext context)

Description copied from interface: ProvidedObjectManager

This method creates a new providedObjectID. The context passed to this method should refer to the PluginContext of which the ProMFuture object is the result, i.e. this.getProvidedObjectObject(createProvidedObject( String name, PluginContext context)) = context.getFutureResult(); The object will be wrapped in a ProMFuture, and a new childContext is created for this ProMFuture Note that no type is provided with this method. Instead, the framework will use the type of the given object, or if an @SubstitutionType annotation was used on the object's class definition, the substitution type is used.

Specified by:

createProvidedObject in interface ProvidedObjectManager

Parameters:

label - The label of the providedObject identified by the returned ProvidedObjectID (can be retrieved with getProvidedObjectLabel()

object - the object to be wrapped in a new ProMFuture.

Returns:

a globally new id, identifying the providedObject

createProvidedObject

public <T> ProvidedObjectID createProvidedObject(String label,
 T object,
 Class<? super T> type,
 PluginContext context)

Description copied from interface: ProvidedObjectManager

This method creates a new providedObjectID. The context passed to this method should refer to the PluginContext of which the ProMFuture object is the result, i.e. this.getProvidedObjectObject(createProvidedObject( String name, PluginContext context)) = context.getFutureResult(); The object will be wrapped in a ProMFuture, and a new childContext is created for this ProMFuture

Specified by:

createProvidedObject in interface ProvidedObjectManager

Parameters:

label - The label of the providedObject identified by the returned ProvidedObjectID (can be retrieved with getProvidedObjectLabel()

object - the object to be wrapped in a new ProMFuture.

type - the type of the object,

Returns:

a globally new id, identifying the providedObject

createProvidedObjects

public List<ProvidedObjectID> createProvidedObjects(PluginContext context)

Description copied from interface: ProvidedObjectManager

This method creates a list of new providedObjectIDs for each object in the PluginExecutionResult of the context.

Specified by:

createProvidedObjects in interface ProvidedObjectManager

Parameters:

context - The context of which this providedObject will be the result

Returns:

a list of globally new ids, identifying the providedObjects

getProvidedObjectObject

public Object getProvidedObjectObject(ProvidedObjectID id,
 boolean waitIfFuture)
                               throws ProvidedObjectDeletedException

Description copied from interface: ProvidedObjectManager

returns the provided object identified by this ID. Do not use this method if not necessary, as the providedObject might not exist in memory locally.

Specified by:

getProvidedObjectObject in interface ProvidedObjectManager

waitIfFuture - TODO

Returns:

Throws:

ProvidedObjectDeletedException

getProvidedObjectLabel

public String getProvidedObjectLabel(ProvidedObjectID id)
                              throws ProvidedObjectDeletedException

Specified by:

getProvidedObjectLabel in interface ProvidedObjectManager

Throws:

ProvidedObjectDeletedException

getProvidedObjectType

public Class<? extends Object> getProvidedObjectType(ProvidedObjectID id)
                                              throws ProvidedObjectDeletedException

Specified by:

getProvidedObjectType in interface ProvidedObjectManager

Throws:

ProvidedObjectDeletedException

changeProvidedObjectObject

public void changeProvidedObjectObject(ProvidedObjectID id,
 Object newObject)
                                throws ProvidedObjectDeletedException

Specified by:

changeProvidedObjectObject in interface ProvidedObjectManager

Throws:

ProvidedObjectDeletedException

deleteProvidedObject

public void deleteProvidedObject(ProvidedObjectID id)
                          throws ProvidedObjectDeletedException

Specified by:

deleteProvidedObject in interface ProvidedObjectManager

Throws:

ProvidedObjectDeletedException

getProvidedObjects

public List<ProvidedObjectID> getProvidedObjects()

Description copied from interface: ProvidedObjectManager

Returns all provided Object IDs known to the framework. The list is ordered in order of Arrival, i.e. the first objectID added to the framework is returned first.

Specified by:

getProvidedObjects in interface ProvidedObjectManager

Returns:

relabelProvidedObject

public void relabelProvidedObject(ProvidedObjectID id,
 String label)
                           throws ProvidedObjectDeletedException

Specified by:

relabelProvidedObject in interface ProvidedObjectManager

Throws:

ProvidedObjectDeletedException

providedObjectNameChanged

public void providedObjectNameChanged(ProvidedObjectID objectID)

providedObjectObjectChanged

public void providedObjectObjectChanged(ProvidedObjectID objectID)

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface ProvidedObjectManager

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface ProvidedObjectManager

clear

public void clear()

Specified by:

clear in interface ProvidedObjectManager