prompt.csv.utils

Class XLogHelper

java.lang.Object

prompt.csv.utils.XLogHelper

public class XLogHelper
extends java.lang.Object

This class is a helper that can be used to handle XLog objects. It is only made of static methods. For example, to create a log with two traces, each of them with two events, you have to write:

        XLog l = XLogHelper.generateNewXLog("Process Name");
 
        XTrace t1 = XLogHelper.insertTrace(l, "case1");
        XEvent e11 = XLogHelper.insertEvent(t1, "A", new Date());
        XEvent e12 = XLogHelper.insertEvent(t1, "B", new Date());
 
        XTrace t2 = XLogHelper.insertTrace(l, "case2");
        XEvent e21 = XLogHelper.insertEvent(t2, "A", new Date());
        XEvent e22 = XLogHelper.insertEvent(t2, "B", new Date());
 

It is also possible to "decorate" all the XAttributable elements, such as XLog, XTrace, and XEvent:

        XLogHelper.decorateElement(t1, "cost", 1000.00); // with no extension
        XLogHelper.decorateElement(e11, "org:group", "Department 1",
                "Organizational"); // with "Organizational" extension
 

There are decorateElement methods that can handle different element types, such as:

• boolean values;
• date values;
• integer values;
• long values;
• string values.

Author:

Andrea Burattin

Constructor Summary

Constructors

Constructor and Description
XLogHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.Boolean value) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a boolean value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.Boolean value, java.lang.String extensionName) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a boolean value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.util.Date value) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a date value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.util.Date value, java.lang.String extensionName) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a date value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.Double value) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a double value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.Double value, java.lang.String extensionName) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a double value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.Integer value) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with an integer value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.Integer value, java.lang.String extensionName) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with an integer value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.Long value) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a boolean value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.Long value, java.lang.String extensionName) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a long value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.String value) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a string value
static void	decorateElement(org.deckfour.xes.model.XAttributable element, java.lang.String attributeName, java.lang.String value, java.lang.String extensionName) This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a string value
static org.deckfour.xes.model.XLog	generateNewXLog(java.lang.String logName) This method generates a new XLog and returns it.
static java.lang.String	getName(org.deckfour.xes.model.XAttributable element) This method returns the value of the attribute concept:name for the given attributable element
static org.deckfour.xes.model.XEvent	insertEvent(org.deckfour.xes.model.XTrace trace, java.lang.String activityName, java.util.Date timestamp) This method creates a new XEvent referring to the given activity name, occurred at the given time.
static org.deckfour.xes.model.XTrace	insertTrace(org.deckfour.xes.model.XLog log, java.lang.String caseId) This method creates a new XTrace with the given case id, adds it to the given log object, and returns the new trace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XLogHelper

public XLogHelper()

Method Detail

generateNewXLog

public static org.deckfour.xes.model.XLog generateNewXLog(java.lang.String logName)

This method generates a new XLog and returns it. By default, some of the standard extensions are registered, specifically:

• XConceptExtension;
• XLifecycleExtension;
• XOrganizationalExtension;
• XTimeExtension.

Parameters:

logName - the name of the new log

Returns:

the generated log

insertTrace

public static org.deckfour.xes.model.XTrace insertTrace(org.deckfour.xes.model.XLog log,
                                        java.lang.String caseId)

This method creates a new XTrace with the given case id, adds it to the given log object, and returns the new trace

Parameters:

log - the log that is going to host the new trace

caseId - the case identifier of the new trace

Returns:

the new trace created, or null if the given log is not valid

insertEvent

public static org.deckfour.xes.model.XEvent insertEvent(org.deckfour.xes.model.XTrace trace,
                                        java.lang.String activityName,
                                        java.util.Date timestamp)

This method creates a new XEvent referring to the given activity name, occurred at the given time. The event is added to the given trace, and returned

Parameters:

trace - the trace that is going to host the new event

activityName - the name of the activity the new event is going to refer to

timestamp - the time the new event occurred

Returns:

the new event created, or null if the given trace is not valid

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.String value,
                   java.lang.String extensionName)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a string value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

extensionName - the extension name

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.String value)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a string value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.Double value,
                   java.lang.String extensionName)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a double value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

extensionName - the extension name

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.Double value)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a double value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.util.Date value,
                   java.lang.String extensionName)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a date value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

extensionName - the extension name

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.util.Date value)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a date value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.Boolean value,
                   java.lang.String extensionName)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a boolean value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

extensionName - the extension name

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.Boolean value)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a boolean value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.Long value,
                   java.lang.String extensionName)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a long value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

extensionName - the extension name

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.Long value)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with a boolean value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.Integer value,
                   java.lang.String extensionName)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with an integer value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

extensionName - the extension name

decorateElement

public static void decorateElement(org.deckfour.xes.model.XAttributable element,
                   java.lang.String attributeName,
                   java.lang.Integer value)

This method can be used to decorate an XAttributable element (such as XLog, XTrace, and XEvent) with an integer value

Parameters:

element - the element to decorate

attributeName - the attribute name

value - the attribute value

getName

public static java.lang.String getName(org.deckfour.xes.model.XAttributable element)

This method returns the value of the attribute concept:name for the given attributable element

Parameters:

element - the element to analyze

Returns:

the value of the concept:name attribute