org.processmining.aam.exp.util

Class ExpDummyPluginContext.ExpDummyConnectionManager

java.lang.Object

org.processmining.aam.exp.util.ExpDummyPluginContext.ExpDummyConnectionManager

All Implemented Interfaces:

org.processmining.framework.connections.ConnectionManager

Enclosing class:

ExpDummyPluginContext

public static class ExpDummyPluginContext.ExpDummyConnectionManager
extends java.lang.Object
implements org.processmining.framework.connections.ConnectionManager

Constructor Summary

Constructors

Constructor and Description
ExpDummyConnectionManager()

Method Summary

Modifier and Type	Method and Description
<T extends org.processmining.framework.connections.Connection> T	addConnection(T connection) Adds the given connection to the framework.
void	clear()
org.processmining.framework.connections.Connection	getConnection(org.processmining.framework.connections.ConnectionID id) Returns the connection with the given ID.
java.util.Collection<org.processmining.framework.connections.ConnectionID>	getConnectionIDs() Returns a collection of connection IDs registered to this global context.
org.processmining.framework.plugin.events.ConnectionObjectListener.ListenerList	getConnectionListeners() Returns the list of registered connectionObject listeners
<T extends org.processmining.framework.connections.Connection> java.util.Collection<T>	getConnections(java.lang.Class<T> connectionType, org.processmining.framework.plugin.PluginContext context, java.lang.Object... objects) Returns a collection of connections between the objects specified, such that the type of the connection is assignable from the given connectionType (unless the parameter equals null).
<T extends org.processmining.framework.connections.Connection> T	getFirstConnection(java.lang.Class<T> connectionType, org.processmining.framework.plugin.PluginContext context, java.lang.Object... objects) Returns a connection between the objects specified, such that the type of the connection is assignable from the given connectionType (unless the parameter equals null).
boolean	isEnabled() Returns whether connections are enabled.
void	setEnabled(boolean isEnabled) Sets whether connections are enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpDummyConnectionManager

public ExpDummyConnectionManager()

Method Detail

setEnabled

public void setEnabled(boolean isEnabled)

Description copied from interface: org.processmining.framework.connections.ConnectionManager

Sets whether connections are enabled.

Specified by:

setEnabled in interface org.processmining.framework.connections.ConnectionManager

Parameters:

isEnabled - whether connections should be enabled

isEnabled

public boolean isEnabled()

Description copied from interface: org.processmining.framework.connections.ConnectionManager

Returns whether connections are enabled. If not, then connecitons will not be added.

Specified by:

isEnabled in interface org.processmining.framework.connections.ConnectionManager

Returns:

whether connections are enabled

getFirstConnection

public <T extends org.processmining.framework.connections.Connection> T getFirstConnection(java.lang.Class<T> connectionType,
                                                                                           org.processmining.framework.plugin.PluginContext context,
                                                                                           java.lang.Object... objects)
                                                                                    throws org.processmining.framework.connections.ConnectionCannotBeObtained

Description copied from interface: org.processmining.framework.connections.ConnectionManager

Returns a connection between the objects specified, such that the type of the connection is assignable from the given connectionType (unless the parameter equals null). If no connections satisfying these criteria exist and the required type is specified and no required name is specified, then the global context searches for all available plugins with a ConnectionObjectFactory annotation, which can be executed in a child of the given PluginContext and accept the given objects as input If such plugins exist, the first of these plugins is selected and invoked on the given objects. The result is obtained from the plugin and a new connection is registered of the right type. This connection is then returned.

Specified by:

getFirstConnection in interface org.processmining.framework.connections.ConnectionManager

Type Parameters:

T - the type of the requested connection.

Parameters:

connectionType - The type of the object requested. This type can be null, in which case all types are considered.

context - The context which requests the connection. If a plugin is invoked to create a connection, a child context of this context is instantiated

objects - the objects which should be connected by the requested connection. There might be more objects involved in the connection

Returns:

A connection of the requested type T. If no connection exists, an exception is thrown, hence null is never returned.

Throws:

org.processmining.framework.connections.ConnectionCannotBeObtained - if the requested connection does not exist and cannot be produced in the given context.

getConnections

public <T extends org.processmining.framework.connections.Connection> java.util.Collection<T> getConnections(java.lang.Class<T> connectionType,
                                                                                                             org.processmining.framework.plugin.PluginContext context,
                                                                                                             java.lang.Object... objects)
                                                                                                      throws org.processmining.framework.connections.ConnectionCannotBeObtained

Description copied from interface: org.processmining.framework.connections.ConnectionManager

Returns a collection of connections between the objects specified, such that the type of the connection is assignable from the given connectionType (unless the parameter equals null). If no connections satisfying these criteria exist and the required type is specified and no required name is specified, then the global context searches for all available plugins with a ConnectionObjectFactory annotation, which can be executed in a child of the given PluginContext and accept the given objects as input If such plugins exist, the first of these plugins is selected and invoked on the given objects. The result is obtained from the plugin and a new connection is registered of the right type. This connection is then returned.

Specified by:

getConnections in interface org.processmining.framework.connections.ConnectionManager

Type Parameters:

T - the type of the requested connection.

Parameters:

connectionType - The type of the object requested. This type can be null, in which case all types are considered.

context - The context which requests the connection. If a plugin is invoked to create a connection, a child context of this context is instantiated

objects - the objects which should be connected by the requested connection. There might be more objects involved in the connection

Returns:

A collection of connections of the requested type T. If no connection exists, an exception is thrown, hence the collection is never empty.

Throws:

org.processmining.framework.connections.ConnectionCannotBeObtained - if the requested connection does not exist and cannot be produced in the given context.

getConnectionListeners

public org.processmining.framework.plugin.events.ConnectionObjectListener.ListenerList getConnectionListeners()

Description copied from interface: org.processmining.framework.connections.ConnectionManager

Returns the list of registered connectionObject listeners

Specified by:

getConnectionListeners in interface org.processmining.framework.connections.ConnectionManager

Returns:

the list of registered connectionObject listeners

getConnectionIDs

public java.util.Collection<org.processmining.framework.connections.ConnectionID> getConnectionIDs()

Description copied from interface: org.processmining.framework.connections.ConnectionManager

Returns a collection of connection IDs registered to this global context.

Specified by:

getConnectionIDs in interface org.processmining.framework.connections.ConnectionManager

Returns:

the ids of the registered connections

getConnection

public org.processmining.framework.connections.Connection getConnection(org.processmining.framework.connections.ConnectionID id)
                                                                 throws org.processmining.framework.connections.ConnectionCannotBeObtained

Description copied from interface: org.processmining.framework.connections.ConnectionManager

Returns the connection with the given ID.

Specified by:

getConnection in interface org.processmining.framework.connections.ConnectionManager

Parameters:

id - the connection ID

Returns:

the connection with the given ID

Throws:

org.processmining.framework.connections.ConnectionCannotBeObtained

clear

public void clear()

Specified by:

clear in interface org.processmining.framework.connections.ConnectionManager

addConnection

public <T extends org.processmining.framework.connections.Connection> T addConnection(T connection)

Description copied from interface: org.processmining.framework.connections.ConnectionManager

Adds the given connection to the framework.

Specified by:

addConnection in interface org.processmining.framework.connections.ConnectionManager

Parameters:

connection - The connection to be registered

Returns:

the given parameter connection