org.processmining.plugins.log.metrics.extensions

Class AbstractXMetricsMetadataExtension

java.lang.Object

org.deckfour.xes.extension.XExtension

org.processmining.plugins.log.metrics.extensions.AbstractXMetricsMetadataExtension

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

XCompletenessMetadataExtension, XComplexityMetadataExtension, XStructurednessMetadataExtension

public abstract class AbstractXMetricsMetadataExtension
extends org.deckfour.xes.extension.XExtension

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	KEY_ATTRIBUTE_TYPE_BIBTEX
protected static java.lang.String	KEY_ATTRIBUTE_TYPE_DOI
protected static java.lang.String	KEY_ATTRIBUTE_TYPE_REFERENCE

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXMetricsMetadataExtension(java.lang.String description, java.lang.String prefix, java.net.URI uri, java.lang.String typekey) Private constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.deckfour.xes.model.XAttribute	createMetricAttribute(LogMetricResult result) This method creates and sets the attribute that stores the values of the specified LogMetricResult result.
java.lang.String	extractAttributeBibtex(org.deckfour.xes.model.XLog log, java.lang.String metrickey)
java.lang.String	extractAttributeDoi(org.deckfour.xes.model.XLog log, java.lang.String metrickey)
java.lang.String	extractAttributeReference(org.deckfour.xes.model.XLog log, java.lang.String metrickey)
double	extractMetricValue(org.deckfour.xes.model.XLog log, java.lang.String metrickey) Get the specified log metric.
protected org.deckfour.xes.model.XAttributeMap	getAllMetrics(org.deckfour.xes.model.XLog log) Returns an XAttributeMap with XAttributeContinuous values.
protected org.deckfour.xes.model.XAttributeContinuous	getMetric(org.deckfour.xes.model.XLog log, java.lang.String metrickey)
protected org.deckfour.xes.model.XAttribute	getMetricAttribute(org.deckfour.xes.model.XLog log, java.lang.String metrickey, java.lang.String attributekey) Retrieve the attribute of which the key was specified or throws a NullPointerException in case of attribute not found.
LogMetricType	getType()
java.lang.String	getTypeKey()
void	putMetric(org.deckfour.xes.model.XAttributeMap attributes, LogMetricResult result)
void	putMetric(org.deckfour.xes.model.XLog log, LogMetricResult result) Put new metric data in the log.

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

KEY_ATTRIBUTE_TYPE_DOI

protected static final java.lang.String KEY_ATTRIBUTE_TYPE_DOI

See Also:

Constant Field Values

KEY_ATTRIBUTE_TYPE_REFERENCE

protected static final java.lang.String KEY_ATTRIBUTE_TYPE_REFERENCE

See Also:

Constant Field Values

KEY_ATTRIBUTE_TYPE_BIBTEX

protected static final java.lang.String KEY_ATTRIBUTE_TYPE_BIBTEX

See Also:

Constant Field Values

Constructor Detail

AbstractXMetricsMetadataExtension

protected AbstractXMetricsMetadataExtension(java.lang.String description,
                                 java.lang.String prefix,
                                 java.net.URI uri,
                                 java.lang.String typekey)

Private constructor. If you require an instance of this extension, see the static method 'instance()'.

Method Detail

getType

public LogMetricType getType()

getTypeKey

public java.lang.String getTypeKey()

getAllMetrics

protected org.deckfour.xes.model.XAttributeMap getAllMetrics(org.deckfour.xes.model.XLog log)

Returns an XAttributeMap with XAttributeContinuous values. If the provided key does not exist, a new XAttributeMap will be returned.

Parameters:

key - Key of which the attributes must be retrieved (e.g. KEY_STRUCTUREDNESS)

element - Element from which the attributes are retrieved.

Returns:

XAttributeMap consisting of XAttributeContinuous attributes for each of the stored metrics.

Throws:

UnknownLogMetricTypeException

getMetric

protected org.deckfour.xes.model.XAttributeContinuous getMetric(org.deckfour.xes.model.XLog log,
                                                    java.lang.String metrickey)
                                                         throws MetricNotExistException

Throws:

MetricNotExistException

getMetricAttribute

protected org.deckfour.xes.model.XAttribute getMetricAttribute(org.deckfour.xes.model.XLog log,
                                                   java.lang.String metrickey,
                                                   java.lang.String attributekey)
                                                        throws MetricNotExistException

Retrieve the attribute of which the key was specified or throws a NullPointerException in case of attribute not found.

Parameters:

log - The process log in which to search for the information.

metrickey - The metric key under which to search for the attribute.

attributekey - The key of the attribute.

Returns:

Returns the attribute or throws a NullPointerException if none found.

Throws:

MetricNotExistException - Throws in case the metric was not found.

UnknownLogMetricTypeException - Throws in case the type of metric is unknown.

extractMetricValue

public double extractMetricValue(org.deckfour.xes.model.XLog log,
                        java.lang.String metrickey)
                          throws MetricNotExistException

Get the specified log metric.

Parameters:

log - The log instance to get it from.

type - The type of log metric.

metrickey - The key of the log metric, usually formatted as in LogMetricResult ('name.key')

Returns:

Returns the value for the specified log metric.

Throws:

MetricNotExistException - Thrown in case the metric is not available.

UnknownLogMetricTypeException - Thrown in case an unknown log metric type is specified.

extractAttributeReference

public java.lang.String extractAttributeReference(org.deckfour.xes.model.XLog log,
                                         java.lang.String metrickey)
                                           throws MetricNotExistException

Throws:

MetricNotExistException

extractAttributeDoi

public java.lang.String extractAttributeDoi(org.deckfour.xes.model.XLog log,
                                   java.lang.String metrickey)
                                     throws MetricNotExistException

Throws:

MetricNotExistException

extractAttributeBibtex

public java.lang.String extractAttributeBibtex(org.deckfour.xes.model.XLog log,
                                      java.lang.String metrickey)
                                        throws MetricNotExistException

Throws:

MetricNotExistException

putMetric

public void putMetric(org.deckfour.xes.model.XLog log,
             LogMetricResult result)

Put new metric data in the log. The new metric is written to the log, together with all set attributes. All attributes that are going to be stored, are supposed to be implemented in the LogMetricResult class or any subclass thereof.

Parameters:

log - The (target) log instance

result - The LogMetricResult instance that contains the result.

Throws:

UnknownLogMetricTypeException - In case that an unknown type of log metric is specified this exception is thrown.

putMetric

public void putMetric(org.deckfour.xes.model.XAttributeMap attributes,
             LogMetricResult result)

createMetricAttribute

protected org.deckfour.xes.model.XAttribute createMetricAttribute(LogMetricResult result)

This method creates and sets the attribute that stores the values of the specified LogMetricResult result. This implementation stores the name and value of the metric and the attributes that are common to all types of log metrics. (At the time of writing: type_reference, type_doi, type_bibtex) If LogMetricResult gets extended, createMetricAttribute can be overridden such that it also stores any additional meta-attributes a specialization of LogMetricResult might have.

Parameters:

result -

Returns: