MacroPluginDescriptorImpl (ProM-Framework)

java.lang.Object
- org.processmining.framework.plugin.impl.AbstractPluginDescriptor
- - org.processmining.framework.plugin.impl.MacroPluginDescriptorImpl

Type Parameters:

edge -

All Implemented Interfaces:

java.lang.Comparable<PluginDescriptor>, PluginDescriptor
```
public class MacroPluginDescriptorImpl
extends AbstractPluginDescriptor
```
Implements a PluginDescriptor that reads and executes .mcr files. These files can be generated with the macro definition frame in the GUI context. TODO: Output parameters.

Author:

bfvdonge

Constructor Summary

Constructors
Constructor and Description

MacroPluginDescriptorImpl(java.io.File file, PluginManager manager, PackageDescriptor pack)

Constructors
Constructor and Description
`MacroPluginDescriptorImpl(java.io.File file, PluginManager manager, PackageDescriptor pack)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(PluginDescriptor plugin)` Compares this plugin with another plugins.
`protected java.lang.Object[]`	`execute(PluginContext context, int methodIndex, java.lang.Object... args)` In this method, the pluginDescriptor should do the actual work of concstructing the result.
`<T extends java.lang.annotation.Annotation> T`	`getAnnotation(java.lang.Class<T> annotationClass)` Return the annotation of the given class carried by this plugin.
`<T extends java.lang.annotation.Annotation> T`	`getAnnotation(java.lang.Class<T> annotationClass, int methodIndex)` Return the annotation of the method at the given index.
`java.lang.String[]`	`getCategories()` Return the set of categories.
`java.lang.Class<? extends PluginContext>`	`getContextType(int methodIndex)` Returns the context type required by the method at index methodIndex.
`java.lang.String`	`getFileName()`
`java.lang.String`	`getHelp()` Return the help / description of the plugin.
`PluginDescriptorID`	`getID()` returns the ID of this Plugin.
`int`	`getIndexInMethod(int methodIndex, int globalParameterIndex)` Returns the index of the global parameter to the index of that parameter in the given method.
`int`	`getIndexInParameterNames(int methodIndex, int methodParameterIndex)` Returns the index of the method parameter of the given method in the list of global parameters.
`java.lang.String[]`	`getKeywords()` Return the set of keywords.
`java.lang.String`	`getMethodHelp(int methodIndex)` Return the help / description of the given method, if specified.
`java.lang.String`	`getMethodLabel(int methodIndex)` Return the label of the given method, if specified.
`int`	`getMostSignificantResult()` Returns the index in the result array of the most significant result for this plugin
`java.lang.String`	`getName()` Return the name of the plugin.
`int`	`getNumberOfMethods()` Return the number of methods in this plugin.
`PackageDescriptor`	`getPackage()` Return the package where the plug-in resides.
`java.util.List<java.lang.String>`	`getParameterNames()` Returns a list of labels that represent the possible parameters of this plugin.
`java.util.List<java.lang.String>`	`getParameterNames(int methodIndex)` Returns a list of labels that represent the required parameters of the method at the given index.
`java.util.List<java.util.List<java.lang.Class<?>>>`	`getParameterTypes()` returns a list of size `getNumberOfMethods()`, such that element at index `i` of the list equals `getParameterTypes(i)`
`java.util.List<java.lang.Class<?>>`	`getParameterTypes(int methodIndex)` Returns a list of types that represent the required parameters of the method at the given index.
`java.lang.String`	`getPluginParameterName(int methodIndex, int parameterIndex)` Return the label of the parameter at index `parameterIndex` of the method at `methodIndex`.
`java.lang.Class<?>`	`getPluginParameterType(int methodIndex, int parameterIndex)` Return the type of the parameter at index `parameterIndex` of the method at `methodIndex`.
`java.util.List<java.lang.String>`	`getReturnNames()` returns the labels of the objects returned if this plugin is invoked, in the order in which they are returned.
`java.util.List<java.lang.Class<?>>`	`getReturnTypes()` returns the types of the objects returned if this plugin is invoked, in the order in which they are returned
`java.util.Set<java.lang.Class<?>>`	`getTypesAtParameterIndex(int globalParameterIndex)` Returns a list of types that can be accepted for the parameter at index `globalParameterIndex`.
`boolean`	`handlesCancel()` Returns whether the plugin handles termination itself.
`boolean`	`hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)` Check if this plugin carries the given annotation.
`boolean`	`hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass, int methodIndex)` Check if the method at the given index carries the given annotation.
`PluginExecutionResult`	`invoke(int methodIndex, PluginContext context, java.lang.Object... args)` Asynchronously invokes a method of this plugin.
`boolean`	`isUserAccessible()` Returns true if this plugin can be used by the end-users.
`boolean`	`meetsLevelThreshold()` Return whether this plug-in meets the level threshold.
`boolean`	`meetsQualityThreshold()` Return whether this plug-in meets the quality threshold.
`java.lang.String`	`toString()` Returns a String representation of the plugin

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.processmining.framework.plugin.PluginDescriptor
equals, hashCode

- Constructor Detail
  - MacroPluginDescriptorImpl
```
public MacroPluginDescriptorImpl(java.io.File file,
                                 PluginManager manager,
                                 PackageDescriptor pack)
                          throws java.io.IOException,
                                 org.w3c.dom.DOMException,
                                 org.xml.sax.SAXException,
                                 javax.xml.parsers.ParserConfigurationException,
                                 java.lang.ClassNotFoundException,
                                 DependsOnUnknownException
```
    Throws:
    
    java.io.IOException
    
    org.w3c.dom.DOMException
    
    org.xml.sax.SAXException
    
    javax.xml.parsers.ParserConfigurationException
    
    java.lang.ClassNotFoundException
    
    DependsOnUnknownException
- Method Detail
  - getPackage
```
public PackageDescriptor getPackage()
```
    Description copied from interface: PluginDescriptor
    
    Return the package where the plug-in resides.
    
    Returns:
  - compareTo
```
public int compareTo(PluginDescriptor plugin)
```
    Description copied from interface: PluginDescriptor
    
    Compares this plugin with another plugins. Uses the getName().toLowerCase() for comparing. Only if names are equal, then the IDs are used for comparison. Comparison should be name-based between different implementing classes.
  - getAnnotation
```
public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotationClass)
```
    Description copied from interface: PluginDescriptor
    
    Return the annotation of the given class carried by this plugin. Note that hasAnnotationClass(annotationClass) is assumed. This method should not be used to access any annotation elements carried by Plugin.class. Implementing classes are allows to return null when called with Plugin.class.
    
    Returns:
  - getContextType
```
public java.lang.Class<? extends PluginContext> getContextType(int methodIndex)
```
    Description copied from interface: PluginDescriptor
    
    Returns the context type required by the method at index methodIndex.
    
    Parameters:
    
    methodIndex - 0 <= methodIndex < getNumberOfMethods()
    
    Returns:
  - getID
```
public PluginDescriptorID getID()
```
    Description copied from interface: PluginDescriptor
    
    returns the ID of this Plugin. Provided that the code of a plugin does not change, these IDs are persistent between executions of ProM.
    
    Returns:
  - getIndexInMethod
```
public int getIndexInMethod(int methodIndex,
                            int globalParameterIndex)
```
    Description copied from interface: PluginDescriptor
    
    Returns the index of the global parameter to the index of that parameter in the given method. Each method of a plugin requires a subset of the global set of parameters that the plugin defines. This method can be used to map the index of each global parameter to the index of the method parameter. Note that if the given method does not require the global parameter, -1 is returned.
    
    Parameters:
    
    methodIndex - 0 <= methodIndex < getNumberOfMethods()
    
    globalParameterIndex - 0 <= globalParameterIndex < getParameterNames().size()
    
    Returns:
    
    -1 <= return < getParameterNames(methodIndex).size()
  - getIndexInParameterNames
```
public int getIndexInParameterNames(int methodIndex,
                                    int methodParameterIndex)
```
    Description copied from interface: PluginDescriptor
    
    Returns the index of the method parameter of the given method in the list of global parameters. Each method of a plugin requires a subset of the global set of parameters that the plugin defines. This method can be used to map the index of each method parameter to the index of the global parameter.
    
    Parameters:
    
    methodIndex - 0 <= methodIndex < getNumberOfMethods()
    
    methodParameterIndex - 0 <= methodParameterIndex < getParameterNames(methodIndex).size()
    
    Returns:
    
    0 <= return < getParameterNames().size()
  - getMethodLabel
```
public java.lang.String getMethodLabel(int methodIndex)
```
    Description copied from interface: PluginDescriptor
    
    Return the label of the given method, if specified. If no label was specified, the name of the plugin is returned.
    
    Returns:
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: PluginDescriptor
    
    Return the name of the plugin. This name is not unique within ProM.
    
    Returns:
  - getNumberOfMethods
```
public int getNumberOfMethods()
```
    Description copied from interface: PluginDescriptor
    
    Return the number of methods in this plugin. There's always at least 1.
    
    Returns:
  - getPluginParameterName
```
public java.lang.String getPluginParameterName(int methodIndex,
                                               int parameterIndex)
```
    Description copied from interface: PluginDescriptor
    
    Return the label of the parameter at index parameterIndex of the method at methodIndex.
    
    Parameters:
    
    methodIndex - 0 <= methodIndex < getNumberOfMethods()
    
    parameterIndex - 0 <= parameterIndex < getParameterTypes(methodIndex).size()
    
    Returns:
    
    may return null if the parameter is not used by the given method
  - getParameterNames
```
public java.util.List<java.lang.String> getParameterNames()
```
    Description copied from interface: PluginDescriptor
    
    Returns a list of labels that represent the possible parameters of this plugin. Each method required a subset of these labels, while preserving their order.
    
    Returns:
  - getParameterNames
```
public java.util.List<java.lang.String> getParameterNames(int methodIndex)
```
    Description copied from interface: PluginDescriptor
    
    Returns a list of labels that represent the required parameters of the method at the given index. In other words, the method at index methodIndex requires exactly the parameter labels as provided in the returned list, in that order.
    
    Returns:
  - getPluginParameterType
```
public java.lang.Class<?> getPluginParameterType(int methodIndex,
                                                 int parameterIndex)
```
    Description copied from interface: PluginDescriptor
    
    Return the type of the parameter at index parameterIndex of the method at methodIndex.
    
    Parameters:
    
    methodIndex - 0 <= methodIndex < getNumberOfMethods()
    
    parameterIndex - 0 <= parameterIndex < getParameterTypes().size()
    
    Returns:
    
    may return null if the parameter is not used by the given method
  - getParameterTypes
```
public java.util.List<java.util.List<java.lang.Class<?>>> getParameterTypes()
```
    Description copied from interface: PluginDescriptor
    
    returns a list of size getNumberOfMethods(), such that element at index i of the list equals getParameterTypes(i)
    
    Returns:
  - getParameterTypes
```
public java.util.List<java.lang.Class<?>> getParameterTypes(int methodIndex)
```
    Description copied from interface: PluginDescriptor
    
    Returns a list of types that represent the required parameters of the method at the given index. In other words, the method at index methodIndex requires exectly the parameter types as provided in the returned list, in that order.
    
    Returns:
  - getReturnNames
```
public java.util.List<java.lang.String> getReturnNames()
```
    Description copied from interface: PluginDescriptor
    
    returns the labels of the objects returned if this plugin is invoked, in the order in which they are returned. These are the labels provided by the plugin definition, not the labels of the objects resulting from a specific invokation, as these can be obtained through the PluginExecutionResult object.
    
    Returns:
  - getReturnTypes
```
public java.util.List<java.lang.Class<?>> getReturnTypes()
```
    Description copied from interface: PluginDescriptor
    
    returns the types of the objects returned if this plugin is invoked, in the order in which they are returned
    
    Returns:
  - getTypesAtParameterIndex
```
public java.util.Set<java.lang.Class<?>> getTypesAtParameterIndex(int globalParameterIndex)
```
    Description copied from interface: PluginDescriptor
    
    Returns a list of types that can be accepted for the parameter at index globalParameterIndex. The parameter index is global, i.e. not method specific. Instead, for each type t in the set returned by this method it is guaranteed that there is at least one method (suppose at index i), such that getParameterType(i, getIndexInMethod(i, globalParameterIndex)) == t
    
    Parameters:
    
    globalParameterIndex - 0 <= globalParameterIndex < getParameterNames().size()
    
    Returns:
  - hasAnnotation
```
public boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
```
    Description copied from interface: PluginDescriptor
    
    Check if this plugin carries the given annotation. Implementing classes can return false at their discretion, i.e. they are not required to return true for all annotations carried by the plugin.
    
    Returns:
  - invoke
```
public PluginExecutionResult invoke(int methodIndex,
                                    PluginContext context,
                                    java.lang.Object... args)
```
    Description copied from interface: PluginDescriptor
    
    Asynchronously invokes a method of this plugin. The methodIndex should refer to an existing method, i.e. 0 <= methodindex < getNumberOfMethods(); Note that the callers of this plugin should notify the lifeCycleListners of the given context of the creation of this plugin, i.e. they should call: context.getParentContext().getPluginLifeCycleEventListeners().firePluginCreated(context);
    
    Specified by:
    
    invoke in interface PluginDescriptor
    
    Overrides:
    
    invoke in class AbstractPluginDescriptor
    
    Parameters:
    
    methodIndex - The index of the method to be invoked
    
    context - the context in which this plugin should be invoked. The plugin may assume that this context is meant only for its execution.
    
    args - the objects to be passed to the plugin. These objects should be in the right order. However, if ProMFuture objects are provided, the plugin will synchronize on them. This syncrhonization is performed in a fast-fail fashion, i.e. the first future that results in an exception during execution will result in an exception while invoking this plugin. This exception is caught and the context is signaled about it.
    
    Returns:
    
    a PluginExecutionResult holding pointers to the future outcome of this invokation. If synchrounous execution is required, the calling method should synchronize on this result
  - execute
```
protected java.lang.Object[] execute(PluginContext context,
                                     int methodIndex,
                                     java.lang.Object... args)
                              throws java.lang.Exception
```
    Description copied from class: AbstractPluginDescriptor
    
    In this method, the pluginDescriptor should do the actual work of concstructing the result. Note that no objects passed in the allArgs argument are futures anymore.
    
    Specified by:
    
    execute in class AbstractPluginDescriptor
    
    Returns:
    
    Throws:
    
    java.lang.Exception
  - getFileName
```
public java.lang.String getFileName()
```
  - isUserAccessible
```
public boolean isUserAccessible()
```
    Description copied from interface: PluginDescriptor
    
    Returns true if this plugin can be used by the end-users. If this is set to false, such a plugin should not be presented to the end user by any context.
    
    Returns:
  - handlesCancel
```
public boolean handlesCancel()
```
    Description copied from interface: PluginDescriptor
    
    Returns whether the plugin handles termination itself.
    
    Returns:
  - toString
```
public java.lang.String toString()
```
    Description copied from interface: PluginDescriptor
    
    Returns a String representation of the plugin
    
    Specified by:
    
    toString in interface PluginDescriptor
    
    Overrides:
    
    toString in class java.lang.Object
  - getAnnotation
```
public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotationClass,
                                                                   int methodIndex)
```
    Description copied from interface: PluginDescriptor
    
    Return the annotation of the method at the given index. Note that hasAnnotationClass(annotationClass, methodIndex) is assumed. This method should not be used to access any annotation elements carried by Plugin.class. Implementing classes are allows to return null when called with Plugin.class.
    
    Returns:
  - hasAnnotation
```
public boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass,
                             int methodIndex)
```
    Description copied from interface: PluginDescriptor
    
    Check if the method at the given index carries the given annotation. Implementing classes can return false at their discretion, i.e. they are not required to return true for all annotations carried by the plugin.
    
    Returns:
  - getMostSignificantResult
```
public int getMostSignificantResult()
```
    Description copied from interface: PluginDescriptor
    
    Returns the index in the result array of the most significant result for this plugin
    
    Returns:
    
    the index in the result array of the most significant result. If no results are returned by this plugin, anything can be returned.
  - getHelp
```
public java.lang.String getHelp()
```
    Description copied from interface: PluginDescriptor
    
    Return the help / description of the plugin.
    
    Returns:
  - getMethodHelp
```
public java.lang.String getMethodHelp(int methodIndex)
```
    Description copied from interface: PluginDescriptor
    
    Return the help / description of the given method, if specified.
    
    Returns:
  - getKeywords
```
public java.lang.String[] getKeywords()
```
    Description copied from interface: PluginDescriptor
    
    Return the set of keywords.
    
    Returns:
    
    a set of keywords
  - getCategories
```
public java.lang.String[] getCategories()
```
    Description copied from interface: PluginDescriptor
    
    Return the set of categories.
    
    Returns:
    
    a set of categories
  - meetsQualityThreshold
```
public boolean meetsQualityThreshold()
```
    Description copied from interface: PluginDescriptor
    
    Return whether this plug-in meets the quality threshold.
    
    Returns:
    
    whether this plug-in meets the quality threshold
  - meetsLevelThreshold
```
public boolean meetsLevelThreshold()
```
    Description copied from interface: PluginDescriptor
    
    Return whether this plug-in meets the level threshold.
    
    Returns:
    
    whether this plug-in meets the level threshold

Class MacroPluginDescriptorImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.processmining.framework.plugin.PluginDescriptor

Constructor Detail

MacroPluginDescriptorImpl

Method Detail

getPackage

compareTo

getAnnotation

getContextType

getID

getIndexInMethod

getIndexInParameterNames

getMethodLabel

getName

getNumberOfMethods

getPluginParameterName

getParameterNames

getParameterNames

getPluginParameterType

getParameterTypes

getParameterTypes

getReturnNames

getReturnTypes

getTypesAtParameterIndex

hasAnnotation

invoke

execute

getFileName

isUserAccessible

handlesCancel

toString

getAnnotation

hasAnnotation

getMostSignificantResult

getHelp

getMethodHelp

getKeywords

getCategories

meetsQualityThreshold

meetsLevelThreshold