org.deckfour.xes.extension.std
Class XSemanticExtension

java.lang.Object
  org.deckfour.xes.extension.XExtension
      org.deckfour.xes.extension.std.XSemanticExtension

public class XSemanticExtension
extends XExtension

This extension adds semantic attributes to event log objects. These semantic attributes reference concepts, which are represented by event log objects, as unique URIs.

Author:

Christian W. Guenther (christian@deckfour.org)

Field Summary

static XAttributeLiteral	ATTR_MODELREFERENCE Model references attribute prototype.
static URI	EXTENSION_URI Unique URI of this extension.
static String	KEY_MODELREFERENCE Key for the model references attribute.

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

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

Method Summary

void	assignModelReferences(XAttributable target, List<String> modelReferences) Assigns to a log element (i.e., archive, log, trace, event, or attribute) a list of model references.
void	assignModelReferenceUris(XAttributable target, List<URI> modelReferenceURIs) Assigns to a log element (i.e., archive, log, trace, event, or attribute) a list of model references.
List<String>	extractModelReferences(XAttributable target) Retrieves the list of model references which describe a log element (archive, log, trace, event, attribute).
List<URI>	extractModelReferenceURIs(XAttributable target) Retrieves the list of model reference URIs which describe a log element (archive, log, trace, event, attribute).
static XSemanticExtension	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_MODELREFERENCE

public static final String KEY_MODELREFERENCE

Key for the model references attribute.

See Also:

Constant Field Values

ATTR_MODELREFERENCE

public static XAttributeLiteral ATTR_MODELREFERENCE

Model references attribute prototype.

Method Detail

instance

public static XSemanticExtension instance()

Provides access to the singleton instance.

Returns:

Singleton extension.

extractModelReferences

public List<String> extractModelReferences(XAttributable target)

Retrieves the list of model references which describe a log element (archive, log, trace, event, attribute).

Parameters:

target - Any log element (i.e., archive, log, trace, event, or attribute) to be queried.

Returns:

The list of model references, as a list of strings, referred to by this element.

extractModelReferenceURIs

public List<URI> extractModelReferenceURIs(XAttributable target)

Retrieves the list of model reference URIs which describe a log element (archive, log, trace, event, attribute).

Parameters:

target - Any log element (i.e., archive, log, trace, event, or attribute) to be queried.

Returns:

The list of model references, as a list of URIs, referred to by this element.

assignModelReferences

public void assignModelReferences(XAttributable target,
                                  List<String> modelReferences)

Assigns to a log element (i.e., archive, log, trace, event, or attribute) a list of model references.

Parameters:

target - Any log element (i.e., archive, log, trace, event, or attribute) to be assigned references to.

modelReferences - The list of model references, as a list of strings, referred to by this element.

assignModelReferenceUris

public void assignModelReferenceUris(XAttributable target,
                                     List<URI> modelReferenceURIs)

Assigns to a log element (i.e., archive, log, trace, event, or attribute) a list of model references.

Parameters:

target - Any log element (i.e., archive, log, trace, event, or attribute) to be assigned references to.

modelReferenceURIs - The list of model references, as a list of URIs, referred to by this element.