ObjectConstructor (ProM-Framework)

All Known Subinterfaces:

PluginContext

All Known Implementing Classes:

AbstractPluginContext
```
public interface ObjectConstructor
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<T,C extends Connection> java.util.Collection<T>`	`tryToFindOrConstructAllObjects(java.lang.Class<T> type, java.lang.Class<C> connectionType, java.lang.String role, java.lang.Object... input)` Finds as many objects of the given type as can be found through the connections of the other given type.
`<T,C extends Connection> T`	`tryToFindOrConstructFirstNamedObject(java.lang.Class<T> type, java.lang.String name, java.lang.Class<C> connectionType, java.lang.String role, java.lang.Object... input)` Returns the first object of the given type as can be found through the connections of the other given type.
`<T,C extends Connection> T`	`tryToFindOrConstructFirstObject(java.lang.Class<T> type, java.lang.Class<C> connectionType, java.lang.String role, java.lang.Object... input)` Returns the first object of the given type as can be found through the connections of the other given type.

- Method Detail
  - tryToFindOrConstructAllObjects
```
<T,C extends Connection> java.util.Collection<T> tryToFindOrConstructAllObjects(java.lang.Class<T> type,
                                                                                java.lang.Class<C> connectionType,
                                                                                java.lang.String role,
                                                                                java.lang.Object... input)
                                                                         throws ConnectionCannotBeObtained
```
    Finds as many objects of the given type as can be found through the connections of the other given type. If no objects can be found, it constructs as many objects of the given type as there are plugins available to the framework to do so. These plugins should be able to execute in a child of the given context and accept, in any order, exactly the input provided. Any other objects returned by the plugin, not being the requested type are added to the provided objects of the framework. Also, listeners are notified where applicable. If no plugings exist, or if these plugins fail, a ConnectionDoesntExistException is thrown.
    
    Type Parameters:
    
    T - The type of the return object required.
    
    Parameters:
    
    - extends Connection> The type of the connections to use when trying to find the objects.
    type - the type of the return object required. connectionType - the type of the connections to use when trying to find the objects. role - the assumed role of the object in the connection. Given a connection, the object can be retrieved through the role. input - the input on which the plugin should work Returns: a collection of objects as found or returned by the plugins. Throws: ConnectionCannotBeObtained
  tryToFindOrConstructFirstObject <T,C extends Connection> T tryToFindOrConstructFirstObject(java.lang.Class<T> type, java.lang.Class<C> connectionType, java.lang.String role, java.lang.Object... input) throws ConnectionCannotBeObtained Returns the first object of the given type as can be found through the connections of the other given type. If no objects can be found, it constructs as an object of the given type using a plugin available to the framework to do so. This plugins should be able to execute in a child of the given context and accept, in any order, exactly the input provided. Any other objects returned by the plugin, not being the requested type are added to the provided objects of the framework. Also, listeners are notified where applicable. If no plugins exist, or if these plugins fail, a ConnectionDoesntExistException is thrown. Type Parameters: T - The type of the return object required. Parameters: - extends Connection> The type of the connections to use when trying to find the objects. type - the type of the return object required. connectionType - the type of the connections to use when trying to find the objects. role - the assumed role of the object in the connection. Given a connection, the object can be retrieved through the role. input - the input on which the plugin should work Returns: a collection of objects as returned by the plugins. Throws: ConnectionCannotBeObtained tryToFindOrConstructFirstNamedObject <T,C extends Connection> T tryToFindOrConstructFirstNamedObject(java.lang.Class<T> type, java.lang.String name, java.lang.Class<C> connectionType, java.lang.String role, java.lang.Object... input) throws ConnectionCannotBeObtained Returns the first object of the given type as can be found through the connections of the other given type. If no objects can be found, it constructs as an object of the given type using a plugin available to the framework to do so. This plugins should be able to execute in a child of the given context and accept, in any order, exactly the input provided. Furthermore, the returned object should have the right label assigned to it in the plugin definition. Any other objects returned by the plugin, not being the requested type are added to the provided objects of the framework. Also, listeners are notified where applicable. If no plugins exist, or if these plugins fail, a ConnectionDoesntExistException is thrown. Type Parameters: T - The type of the return object required. Parameters: - extends Connection> The type of the connections to use when trying to find the objects. type - the type of the return object required. name - the name of the plugin to use. connectionType - the type of the connections to use when trying to find the objects. role - the assumed role of the object in the connection. Given a connection, the object can be retrieved through the role. input - the input on which the plugin should work Returns: a collection of objects as returned by the plugins. Throws: ConnectionCannotBeObtained

Interface ObjectConstructor

Method Summary

Method Detail

tryToFindOrConstructAllObjects

tryToFindOrConstructFirstObject

tryToFindOrConstructFirstNamedObject