Package org.processmining.extension

Class XDataExtension

  • All Implemented Interfaces:
    java.io.Serializable
    public class XDataExtension
extends org.deckfour.xes.extension.XExtension
    This extension provides input attributes and output attributes for logs, traces and events It defines two attributes: - data:input: whose nested attributes are input attributes read by logs, traces or events - data:output: whose nested attributes are output attributes written by logs, traces or events
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.deckfour.xes.model.XAttributeLiteral ATTR_INPUT
      Attribute prototypes
      static org.deckfour.xes.model.XAttributeLiteral ATTR_OUTPUT  
      static java.net.URI EXTENSION_URI
      Unique URI of this extension.
      static java.lang.String KEY_INPUT
      Keys for the attributes
      static java.lang.String KEY_OUTPUT  

      • Fields inherited from class org.deckfour.xes.extension.XExtension

        allAttributes, eventAttributes, logAttributes, metaAttributes, name, prefix, traceAttributes, uri

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void assignInputAttributes​(org.deckfour.xes.model.XEvent event, org.deckfour.xes.model.XAttribute attribute)
      Add an input attribute to an event
      void assignInputAttributes​(org.deckfour.xes.model.XLog log, org.deckfour.xes.model.XAttribute attribute)
      Add an input attribute to a log
      void assignInputAttributes​(org.deckfour.xes.model.XTrace trace, org.deckfour.xes.model.XAttribute attribute)
      Add an input attribute to a trace
      void assignOutputAttributes​(org.deckfour.xes.model.XEvent event, org.deckfour.xes.model.XAttribute attribute)
      Add an output attribute to an event
      void assignOutputAttributes​(org.deckfour.xes.model.XLog log, org.deckfour.xes.model.XAttribute attribute)
      Add an output attribute to a log
      void assignOutputAttributes​(org.deckfour.xes.model.XTrace trace, org.deckfour.xes.model.XAttribute attribute)
      Add an output attribute to a trace
      void clearInputAttributes​(org.deckfour.xes.model.XEvent e)  
      void clearOutputAttributes​(org.deckfour.xes.model.XEvent e)  
      org.deckfour.xes.model.XAttributeMap extractInputAttributes​(org.deckfour.xes.model.XEvent event)
      Retrieves all input attributes of an event as a XAttributeMap
      org.deckfour.xes.model.XAttributeMap extractInputAttributes​(org.deckfour.xes.model.XLog log)
      Retrieves all input attributes of a log as a XAttributeMap
      org.deckfour.xes.model.XAttributeMap extractInputAttributes​(org.deckfour.xes.model.XTrace trace)
      Retrieves all input attributes of a trace as a XAttributeMap
      org.deckfour.xes.model.XAttributeMap extractOutputAttributes​(org.deckfour.xes.model.XEvent event)
      Retrieves all output attributes of an event as a XAttributeMap
      org.deckfour.xes.model.XAttributeMap extractOutputAttributes​(org.deckfour.xes.model.XLog log)
      Retrieves all output attributes of a log as a XAttributeMap
      org.deckfour.xes.model.XAttributeMap extractOutputAttributes​(org.deckfour.xes.model.XTrace trace)
      Retrieves all output attributes of a trace as a XAttributeMap
      static XDataExtension instance()
      Provides access to the singleton instance.

      • Methods inherited from class org.deckfour.xes.extension.XExtension

        accept, equals, getDefinedAttributes, getEventAttributes, getLogAttributes, getMetaAttributes, getName, getPrefix, getTraceAttributes, getUri, hashCode, toString

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • EXTENSION_URI

        public static final java.net.URI EXTENSION_URI
        Unique URI of this extension.

      • KEY_INPUT

        public static final java.lang.String KEY_INPUT
        Keys for the attributes
        See Also:
        Constant Field Values

      • ATTR_INPUT

        public static org.deckfour.xes.model.XAttributeLiteral ATTR_INPUT
        Attribute prototypes

      • ATTR_OUTPUT

        public static org.deckfour.xes.model.XAttributeLiteral ATTR_OUTPUT

    • Method Detail

      • instance

        public static XDataExtension instance()
        Provides access to the singleton instance.
        Returns:
        Singleton extension.

      • extractInputAttributes

        public org.deckfour.xes.model.XAttributeMap extractInputAttributes​(org.deckfour.xes.model.XLog log)
        Retrieves all input attributes of a log as a XAttributeMap
        Parameters:
        log - Log to retrieve input attributes for.
        Returns:
        The XAttributeMap containing input attributes.

      • extractInputAttributes

        public org.deckfour.xes.model.XAttributeMap extractInputAttributes​(org.deckfour.xes.model.XTrace trace)
        Retrieves all input attributes of a trace as a XAttributeMap
        Parameters:
        trace - Trace to retrieve input attributes for.
        Returns:
        The XAttributeMap containing input attributes.

      • extractInputAttributes

        public org.deckfour.xes.model.XAttributeMap extractInputAttributes​(org.deckfour.xes.model.XEvent event)
        Retrieves all input attributes of an event as a XAttributeMap
        Parameters:
        event - Event to retrieve input attributes for.
        Returns:
        The XAttributeMap containing input attributes.

      • extractOutputAttributes

        public org.deckfour.xes.model.XAttributeMap extractOutputAttributes​(org.deckfour.xes.model.XLog log)
        Retrieves all output attributes of a log as a XAttributeMap
        Parameters:
        log - Log to retrieve output attributes for.
        Returns:
        The XAttributeMap containing output attributes.

      • extractOutputAttributes

        public org.deckfour.xes.model.XAttributeMap extractOutputAttributes​(org.deckfour.xes.model.XTrace trace)
        Retrieves all output attributes of a trace as a XAttributeMap
        Parameters:
        trace - Trace to retrieve output attributes for.
        Returns:
        The XAttributeMap containing output attributes.

      • extractOutputAttributes

        public org.deckfour.xes.model.XAttributeMap extractOutputAttributes​(org.deckfour.xes.model.XEvent event)
        Retrieves all output attributes of an event as a XAttributeMap
        Parameters:
        event - Event to retrieve output attributes for.
        Returns:
        The XAttributeMap containing output attributes.

      • clearInputAttributes

        public void clearInputAttributes​(org.deckfour.xes.model.XEvent e)

      • clearOutputAttributes

        public void clearOutputAttributes​(org.deckfour.xes.model.XEvent e)

      • assignInputAttributes

        public void assignInputAttributes​(org.deckfour.xes.model.XLog log,
                                  org.deckfour.xes.model.XAttribute attribute)
        Add an input attribute to a log
        Parameters:
        log - Log to add the input attribute to.
        attribute - The input attribute to be added.

      • assignInputAttributes

        public void assignInputAttributes​(org.deckfour.xes.model.XTrace trace,
                                  org.deckfour.xes.model.XAttribute attribute)
        Add an input attribute to a trace
        Parameters:
        trace - Trace to add the input attribute to.
        attribute - The input attribute to be added.

      • assignInputAttributes

        public void assignInputAttributes​(org.deckfour.xes.model.XEvent event,
                                  org.deckfour.xes.model.XAttribute attribute)
        Add an input attribute to an event
        Parameters:
        event - Event to add the input attribute to.
        attribute - The input attribute to be added.

      • assignOutputAttributes

        public void assignOutputAttributes​(org.deckfour.xes.model.XLog log,
                                   org.deckfour.xes.model.XAttribute attribute)
        Add an output attribute to a log
        Parameters:
        log - Log to add the output attribute to.
        attribute - The output attribute to be added.

      • assignOutputAttributes

        public void assignOutputAttributes​(org.deckfour.xes.model.XTrace trace,
                                   org.deckfour.xes.model.XAttribute attribute)
        Add an output attribute to a trace
        Parameters:
        trace - Trace to add the output attribute to.
        attribute - The output attribute to be added.

      • assignOutputAttributes

        public void assignOutputAttributes​(org.deckfour.xes.model.XEvent event,
                                   org.deckfour.xes.model.XAttribute attribute)
        Add an output attribute to an event
        Parameters:
        event - Event to add the output attribute to.
        attribute - The output attribute to be added.