Package org.processmining.logfiltering.visualizerModel

Class PluginDescriptorImpl2

  • All Implemented Interfaces:
    java.lang.Comparable<org.processmining.framework.plugin.PluginDescriptor>, org.processmining.framework.plugin.PluginDescriptor
    public class PluginDescriptorImpl2
extends org.processmining.framework.plugin.impl.AbstractPluginDescriptor

    • Constructor Summary

      Constructors 
      Constructor Description
      PluginDescriptorImpl2​(java.lang.Class<?> type, java.lang.Class<? extends org.processmining.framework.plugin.PluginContext> acceptedContext, org.processmining.framework.packages.PackageDescriptor pack)  
      PluginDescriptorImpl2​(java.lang.reflect.Method method, org.processmining.framework.packages.PackageDescriptor pack)  
      PluginDescriptorImpl2​(java.lang.String className, java.lang.String name, java.lang.Class<?>[] parTypes, org.processmining.framework.packages.PackageDescriptor pack)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(org.processmining.framework.plugin.PluginDescriptor plugin)
      Compares this plugin with another plugins.
      boolean equals​(java.lang.Object other)
      return equality of 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.
      protected java.lang.reflect.Method findMethod​(java.lang.Object[] allArgs)  
      <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 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 parameterIndex)
      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 types of the objects returned if this plugin is invoked, in the order in which they are returned
      java.util.List<java.lang.Class<? extends java.lang.Object>> getReturnTypes()
      returns the labels 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 index)
      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.
      int hashCode()
      return hashcode
      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 org.processmining.framework.plugin.impl.AbstractPluginDescriptor

        invoke

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • PluginDescriptorImpl2

        public PluginDescriptorImpl2​(java.lang.reflect.Method method,
                             org.processmining.framework.packages.PackageDescriptor pack)
                      throws java.lang.Exception
        Throws:
        java.lang.Exception

      • PluginDescriptorImpl2

        public PluginDescriptorImpl2​(java.lang.Class<?> type,
                             java.lang.Class<? extends org.processmining.framework.plugin.PluginContext> acceptedContext,
                             org.processmining.framework.packages.PackageDescriptor pack)
                      throws java.lang.Exception
        Throws:
        java.lang.Exception

      • PluginDescriptorImpl2

        public PluginDescriptorImpl2​(java.lang.String className,
                             java.lang.String name,
                             java.lang.Class<?>[] parTypes,
                             org.processmining.framework.packages.PackageDescriptor pack)
                      throws java.lang.Exception
        Throws:
        java.lang.Exception

    • Method Detail

      • getPackage

        public org.processmining.framework.packages.PackageDescriptor getPackage()
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Return the package where the plug-in resides.
        Returns:

      • getMostSignificantResult

        public int getMostSignificantResult()
        Description copied from interface: org.processmining.framework.plugin.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.

      • hasAnnotation

        public boolean hasAnnotation​(java.lang.Class<? extends java.lang.annotation.Annotation> annotationClass)
        Description copied from interface: org.processmining.framework.plugin.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:

      • getAnnotation

        public <T extends java.lang.annotation.Annotation> T getAnnotation​(java.lang.Class<T> annotationClass)
        Description copied from interface: org.processmining.framework.plugin.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:

      • getName

        public java.lang.String getName()
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Return the name of the plugin. This name is not unique within ProM.
        Returns:

      • hashCode

        public int hashCode()
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        return hashcode
        Specified by:
        hashCode in interface org.processmining.framework.plugin.PluginDescriptor
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        return equality of plugins. The ID is used for equality.
        Specified by:
        equals in interface org.processmining.framework.plugin.PluginDescriptor
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Returns a String representation of the plugin
        Specified by:
        toString in interface org.processmining.framework.plugin.PluginDescriptor
        Overrides:
        toString in class java.lang.Object

      • execute

        protected java.lang.Object[] execute​(org.processmining.framework.plugin.PluginContext context,
                                     int methodIndex,
                                     java.lang.Object... allArgs)
                              throws java.lang.Exception
        Description copied from class: org.processmining.framework.plugin.impl.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 org.processmining.framework.plugin.impl.AbstractPluginDescriptor
        Returns:
        Throws:
        java.lang.Exception

      • findMethod

        protected java.lang.reflect.Method findMethod​(java.lang.Object[] allArgs)

      • getReturnTypes

        public java.util.List<java.lang.Class<? extends java.lang.Object>> getReturnTypes()
        returns the labels of the objects returned if this plugin is invoked, in the order in which they are returned
        Returns:

      • getParameterTypes

        public java.util.List<java.lang.Class<?>> getParameterTypes​(int methodIndex)
        Description copied from interface: org.processmining.framework.plugin.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:

      • getPluginParameterType

        public java.lang.Class<?> getPluginParameterType​(int methodIndex,
                                                 int parameterIndex)
        Description copied from interface: org.processmining.framework.plugin.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: org.processmining.framework.plugin.PluginDescriptor
        returns a list of size getNumberOfMethods(), such that element at index i of the list equals getParameterTypes(i)
        Returns:

      • getParameterNames

        public java.util.List<java.lang.String> getParameterNames()
        Description copied from interface: org.processmining.framework.plugin.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:

      • getTypesAtParameterIndex

        public java.util.Set<java.lang.Class<?>> getTypesAtParameterIndex​(int index)
        Description copied from interface: org.processmining.framework.plugin.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:
        index - 0 <= globalParameterIndex < getParameterNames().size()
        Returns:

      • getNumberOfMethods

        public int getNumberOfMethods()
        Return the number of methods in this plugin.
        Returns:

      • getParameterNames

        public java.util.List<java.lang.String> getParameterNames​(int methodIndex)
        Description copied from interface: org.processmining.framework.plugin.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:

      • getPluginParameterName

        public java.lang.String getPluginParameterName​(int methodIndex,
                                               int parameterIndex)
        Description copied from interface: org.processmining.framework.plugin.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

      • getReturnNames

        public java.util.List<java.lang.String> getReturnNames()
        returns the types of the objects returned if this plugin is invoked, in the order in which they are returned
        Returns:

      • getID

        public org.processmining.framework.plugin.PluginDescriptorID getID()
        Description copied from interface: org.processmining.framework.plugin.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:

      • getContextType

        public java.lang.Class<? extends org.processmining.framework.plugin.PluginContext> getContextType​(int methodIndex)
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Returns the context type required by the method at index methodIndex.
        Parameters:
        methodIndex - 0 <= methodIndex < getNumberOfMethods()
        Returns:

      • compareTo

        public int compareTo​(org.processmining.framework.plugin.PluginDescriptor plugin)
        Description copied from interface: org.processmining.framework.plugin.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.

      • getIndexInParameterNames

        public int getIndexInParameterNames​(int methodIndex,
                                    int methodParameterIndex)
        Description copied from interface: org.processmining.framework.plugin.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()

      • getIndexInMethod

        public int getIndexInMethod​(int methodIndex,
                            int parameterIndex)
        Description copied from interface: org.processmining.framework.plugin.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()
        parameterIndex - 0 <= globalParameterIndex < getParameterNames().size()
        Returns:
        -1 <= return < getParameterNames(methodIndex).size()

      • getMethodLabel

        public java.lang.String getMethodLabel​(int methodIndex)
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Return the label of the given method, if specified. If no label was specified, the name of the plugin is returned.
        Returns:

      • isUserAccessible

        public boolean isUserAccessible()
        Description copied from interface: org.processmining.framework.plugin.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: org.processmining.framework.plugin.PluginDescriptor
        Returns whether the plugin handles termination itself.
        Returns:

      • getAnnotation

        public <T extends java.lang.annotation.Annotation> T getAnnotation​(java.lang.Class<T> annotationClass,
                                                                   int methodIndex)
        Description copied from interface: org.processmining.framework.plugin.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: org.processmining.framework.plugin.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:

      • getHelp

        public java.lang.String getHelp()
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Return the help / description of the plugin.
        Returns:

      • getMethodHelp

        public java.lang.String getMethodHelp​(int methodIndex)
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Return the help / description of the given method, if specified.
        Returns:

      • getKeywords

        public java.lang.String[] getKeywords()
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Return the set of keywords.
        Returns:
        a set of keywords

      • getCategories

        public java.lang.String[] getCategories()
        Description copied from interface: org.processmining.framework.plugin.PluginDescriptor
        Return the set of categories.
        Returns:
        a set of categories

      • meetsQualityThreshold

        public boolean meetsQualityThreshold()
        Description copied from interface: org.processmining.framework.plugin.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: org.processmining.framework.plugin.PluginDescriptor
        Return whether this plug-in meets the level threshold.
        Returns:
        whether this plug-in meets the level threshold

      • getIcon

        public javax.swing.ImageIcon getIcon()

      • getURL

        public java.net.URL getURL()