org.deckfour.xes.extension.std
Class XConceptExtension

java.lang.Object
  extended by org.deckfour.xes.extension.XExtension
      extended by org.deckfour.xes.extension.std.XConceptExtension

public class XConceptExtension
extends XExtension

This extension provides naming for concepts in the event log type hierarchy. It defines two attributes:

Author:
Christian W. Guenther (christian@deckfour.org)

Field Summary
static XAttributeLiteral ATTR_INSTANCE
          Instance attribute prototype
static XAttributeLiteral ATTR_NAME
          Name attribute prototype
static URI EXTENSION_URI
          Unique URI of this extension.
static String KEY_INSTANCE
          Key for the instance attribute.
static String KEY_NAME
          Key for the name attribute.
 
Fields inherited from class org.deckfour.xes.extension.XExtension
allAttributes, eventAttributes, logAttributes, metaAttributes, name, prefix, traceAttributes, uri
 
Method Summary
 void assignInstance(XEvent event, String instance)
          Assigns any event its activity instance identifier, as defined by this extension's instance attribute.
 void assignName(XAttributable element, String name)
          Assigns any log data hierarchy element its name, as defined by this extension's name attribute.
 String extractInstance(XEvent event)
          Retrieves the activity instance identifier of an event, if set by this extension's instance attribute.
 String extractName(XAttributable element)
          Retrieves the name of a log data hierarchy element, if set by this extension's name attribute.
static XConceptExtension instance()
          Provides access to the singleton instance.
 
Methods inherited from class org.deckfour.xes.extension.XExtension
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 URI EXTENSION_URI
Unique URI of this extension.


KEY_NAME

public static final String KEY_NAME
Key for the name attribute.

See Also:
Constant Field Values

KEY_INSTANCE

public static final String KEY_INSTANCE
Key for the instance attribute.

See Also:
Constant Field Values

ATTR_NAME

public static XAttributeLiteral ATTR_NAME
Name attribute prototype


ATTR_INSTANCE

public static XAttributeLiteral ATTR_INSTANCE
Instance attribute prototype

Method Detail

instance

public static XConceptExtension instance()
Provides access to the singleton instance.

Returns:
Singleton extension.

extractName

public String extractName(XAttributable element)
Retrieves the name of a log data hierarchy element, if set by this extension's name attribute.

Parameters:
element - Log hierarchy element to extract name from.
Returns:
The requested element name.

assignName

public void assignName(XAttributable element,
                       String name)
Assigns any log data hierarchy element its name, as defined by this extension's name attribute.

Parameters:
element - Log hierarchy element to assign name to.
name - The name to be assigned.

extractInstance

public String extractInstance(XEvent event)
Retrieves the activity instance identifier of an event, if set by this extension's instance attribute.

Parameters:
event - Event to extract instance from.
Returns:
The requested activity instance identifier.

assignInstance

public void assignInstance(XEvent event,
                           String instance)
Assigns any event its activity instance identifier, as defined by this extension's instance attribute.

Parameters:
event - Event to assign activity instance identifier to.
name - The activity instance identifier to be assigned.