Package org.processmining.framework.plugin

Interface PluginDescriptor

All Superinterfaces:
Comparable<PluginDescriptor>
All Known Implementing Classes:
AbstractPluginDescriptor, PluginDescriptorImpl
public interface PluginDescriptor extends Comparable<PluginDescriptor>

  • Method Details

    • hasAnnotation

      boolean hasAnnotation(Class<? extends Annotation> annotationClass)
      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.
      Parameters:
      annotationClass -
      Returns:

    • hasAnnotation

      boolean hasAnnotation(Class<? extends Annotation> annotationClass, int methodIndex)
      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.
      Parameters:
      annotationClass -
      Returns:

    • getAnnotation

      <T extends Annotation> T getAnnotation(Class<T> annotationClass)
      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.
      Type Parameters:
      T -
      Parameters:
      annotationClass -
      Returns:

    • getAnnotation

      <T extends Annotation> T getAnnotation(Class<T> annotationClass, int methodIndex)
      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.
      Type Parameters:
      T -
      Parameters:
      annotationClass -
      methodIndex -
      Returns:

    • getPackage

      PackageDescriptor getPackage()
      Return the package where the plug-in resides.
      Returns:

    • getName

      String getName()
      Return the name of the plugin. This name is not unique within ProM.
      Returns:

    • hashCode

      int hashCode()
      return hashcode
      Overrides:
      hashCode in class Object
      Returns:

    • equals

      boolean equals(Object other)
      return equality of plugins. The ID is used for equality.
      Overrides:
      equals in class Object
      Parameters:
      other -
      Returns:

    • toString

      String toString()
      Returns a String representation of the plugin
      Overrides:
      toString in class Object
      Returns:

    • getNumberOfMethods

      int getNumberOfMethods()
      Return the number of methods in this plugin. There's always at least 1.
      Returns:

    • invoke

      PluginExecutionResult invoke(int methodIndex, PluginContext context, Object... args)
      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);
      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

    • getReturnTypes

      List<Class<?>> getReturnTypes()
      returns the types of the objects returned if this plugin is invoked, in the order in which they are returned
      Returns:

    • getReturnNames

      List<String> getReturnNames()
      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:

    • getParameterTypes

      List<List<Class<?>>> getParameterTypes()
      returns a list of size getNumberOfMethods(), such that element at index i of the list equals getParameterTypes(i)
      Returns:

    • getParameterTypes

      List<Class<?>> getParameterTypes(int methodIndex)
      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.
      Parameters:
      methodIndex -
      Returns:

    • getParameterNames

      List<String> getParameterNames()
      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

      List<String> getParameterNames(int methodIndex)
      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.
      Parameters:
      methodIndex -
      Returns:

    • getPluginParameterType

      Class<?> getPluginParameterType(int methodIndex, int parameterIndex)
      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

    • getPluginParameterName

      String getPluginParameterName(int methodIndex, int parameterIndex)
      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

    • getID

      PluginDescriptorID getID()
      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:

    • getContextType

      Class<? extends PluginContext> getContextType(int methodIndex)
      Returns the context type required by the method at index methodIndex.
      Parameters:
      methodIndex - 0 <= methodIndex < getNumberOfMethods()
      Returns:

    • getTypesAtParameterIndex

      Set<Class<?>> getTypesAtParameterIndex(int globalParameterIndex)
      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:

    • getIndexInParameterNames

      int getIndexInParameterNames(int methodIndex, int methodParameterIndex)
      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()

    • getIndexInMethod

      int getIndexInMethod(int methodIndex, int globalParameterIndex)
      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()

    • getMethodLabel

      String getMethodLabel(int methodIndex)
      Return the label of the given method, if specified. If no label was specified, the name of the plugin is returned.
      Parameters:
      methodIndex -
      Returns:

    • compareTo

      int compareTo(PluginDescriptor plugin)
      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.
      Specified by:
      compareTo in interface Comparable<PluginDescriptor>

    • isUserAccessible

      boolean isUserAccessible()
      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

      boolean handlesCancel()
      Returns whether the plugin handles termination itself.
      Returns:

    • getMostSignificantResult

      int getMostSignificantResult()
      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

      String getHelp()
      Return the help / description of the plugin.
      Returns:

    • getMethodHelp

      String getMethodHelp(int methodIndex)
      Return the help / description of the given method, if specified.
      Parameters:
      methodIndex -
      Returns:

    • getKeywords

      String[] getKeywords()
      Return the set of keywords.
      Returns:
      a set of keywords

    • getCategories

      String[] getCategories()
      Return the set of categories.
      Returns:
      a set of categories

    • meetsQualityThreshold

      boolean meetsQualityThreshold()
      Return whether this plug-in meets the quality threshold.
      Returns:
      whether this plug-in meets the quality threshold

    • meetsLevelThreshold

      boolean meetsLevelThreshold()
      Return whether this plug-in meets the level threshold.
      Returns:
      whether this plug-in meets the level threshold

    • getIcon

      ImageIcon getIcon()

    • getURL

      URL getURL()