public class MockupPluginDescriptor
extends org.processmining.framework.plugin.impl.AbstractPluginDescriptor
Constructor and Description |
---|
MockupPluginDescriptor() |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(org.processmining.framework.plugin.PluginDescriptor plugin)
Compares this plugin with another plugins.
|
protected java.lang.Object[] |
execute(org.processmining.framework.plugin.PluginContext context,
int methodIndex,
java.lang.Object... allArgs)
In this method, the pluginDescriptor should do the actual work of
concstructing the result.
|
<T extends java.lang.annotation.Annotation> |
getAnnotation(java.lang.Class<T> annotationClass)
Return the annotation of the given class carried by this plugin.
|
<T extends java.lang.annotation.Annotation> |
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 org.processmining.framework.plugin.PluginContext> |
getContextType(int methodIndex)
Returns the context type required by the method at index methodIndex.
|
java.lang.String |
getHelp()
Return the help / description of the plugin.
|
javax.swing.ImageIcon |
getIcon() |
org.processmining.framework.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.
|
org.processmining.framework.packages.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 . |
java.net.URL |
getURL() |
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.
|
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.
|
invoke
public boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
org.processmining.framework.plugin.PluginDescriptor
public boolean hasAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass, int methodIndex)
org.processmining.framework.plugin.PluginDescriptor
public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotationClass)
org.processmining.framework.plugin.PluginDescriptor
public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.Class<T> annotationClass, int methodIndex)
org.processmining.framework.plugin.PluginDescriptor
public org.processmining.framework.packages.PackageDescriptor getPackage()
org.processmining.framework.plugin.PluginDescriptor
public java.lang.String getName()
org.processmining.framework.plugin.PluginDescriptor
public int getNumberOfMethods()
org.processmining.framework.plugin.PluginDescriptor
public java.util.List<java.lang.Class<?>> getReturnTypes()
org.processmining.framework.plugin.PluginDescriptor
public java.util.List<java.lang.String> getReturnNames()
org.processmining.framework.plugin.PluginDescriptor
PluginExecutionResult
object.public java.util.List<java.util.List<java.lang.Class<?>>> getParameterTypes()
org.processmining.framework.plugin.PluginDescriptor
getNumberOfMethods()
, such that
element at index i
of the list equals
getParameterTypes(i)
public java.util.List<java.lang.Class<?>> getParameterTypes(int methodIndex)
org.processmining.framework.plugin.PluginDescriptor
methodIndex
requires exectly the parameter types as provided
in the returned list, in that order.public java.util.List<java.lang.String> getParameterNames()
org.processmining.framework.plugin.PluginDescriptor
public java.util.List<java.lang.String> getParameterNames(int methodIndex)
org.processmining.framework.plugin.PluginDescriptor
methodIndex
requires exactly the parameter labels as
provided in the returned list, in that order.public java.lang.Class<?> getPluginParameterType(int methodIndex, int parameterIndex)
org.processmining.framework.plugin.PluginDescriptor
parameterIndex
of
the method at methodIndex
.methodIndex
- 0 <= methodIndex < getNumberOfMethods()
parameterIndex
- 0 <= parameterIndex < getParameterTypes().size()
public java.lang.String getPluginParameterName(int methodIndex, int parameterIndex)
org.processmining.framework.plugin.PluginDescriptor
parameterIndex
of
the method at methodIndex
.methodIndex
- 0 <= methodIndex < getNumberOfMethods()
parameterIndex
- 0 <= parameterIndex < getParameterTypes(methodIndex).size()
public org.processmining.framework.plugin.PluginDescriptorID getID()
org.processmining.framework.plugin.PluginDescriptor
public java.lang.Class<? extends org.processmining.framework.plugin.PluginContext> getContextType(int methodIndex)
org.processmining.framework.plugin.PluginDescriptor
methodIndex
- 0 <= methodIndex < getNumberOfMethods()
public java.util.Set<java.lang.Class<?>> getTypesAtParameterIndex(int globalParameterIndex)
org.processmining.framework.plugin.PluginDescriptor
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
globalParameterIndex
- 0 <= globalParameterIndex < getParameterNames().size()
public int getIndexInParameterNames(int methodIndex, int methodParameterIndex)
org.processmining.framework.plugin.PluginDescriptor
methodIndex
- 0 <= methodIndex < getNumberOfMethods()
methodParameterIndex
- 0 <= methodParameterIndex < getParameterNames(methodIndex).size()
0 <= return < getParameterNames().size()
public int getIndexInMethod(int methodIndex, int globalParameterIndex)
org.processmining.framework.plugin.PluginDescriptor
methodIndex
- 0 <= methodIndex < getNumberOfMethods()
globalParameterIndex
- 0 <= globalParameterIndex < getParameterNames().size()
-1 <= return < getParameterNames(methodIndex).size()
public java.lang.String getMethodLabel(int methodIndex)
org.processmining.framework.plugin.PluginDescriptor
public int compareTo(org.processmining.framework.plugin.PluginDescriptor plugin)
org.processmining.framework.plugin.PluginDescriptor
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.public boolean isUserAccessible()
org.processmining.framework.plugin.PluginDescriptor
public boolean handlesCancel()
org.processmining.framework.plugin.PluginDescriptor
public int getMostSignificantResult()
org.processmining.framework.plugin.PluginDescriptor
public java.lang.String getHelp()
org.processmining.framework.plugin.PluginDescriptor
public java.lang.String getMethodHelp(int methodIndex)
org.processmining.framework.plugin.PluginDescriptor
public java.lang.String[] getKeywords()
org.processmining.framework.plugin.PluginDescriptor
public java.lang.String[] getCategories()
org.processmining.framework.plugin.PluginDescriptor
protected java.lang.Object[] execute(org.processmining.framework.plugin.PluginContext context, int methodIndex, java.lang.Object... allArgs) throws java.lang.Exception
org.processmining.framework.plugin.impl.AbstractPluginDescriptor
execute
in class org.processmining.framework.plugin.impl.AbstractPluginDescriptor
java.lang.Exception
public boolean meetsQualityThreshold()
org.processmining.framework.plugin.PluginDescriptor
public boolean meetsLevelThreshold()
org.processmining.framework.plugin.PluginDescriptor
public javax.swing.ImageIcon getIcon()
public java.net.URL getURL()