org.deckfour.xes.factory
Interface XFactory

All Known Implementing Classes:

XFactoryBufferedImpl, XFactoryNaiveImpl

public interface XFactory

Factory interface, providing factory methods for creating all element classes of the XES model type hierarchy.

Author:

Christian W. Guenther (christian@deckfour.org)

Method Summary

XAttributeBoolean	createAttributeBoolean(String key, boolean value, XExtension extension) Creates a new XES attribute with boolean type (Factory method).
XAttributeContinuous	createAttributeContinuous(String key, double value, XExtension extension) Creates a new XES attribute with continuous type (Factory method).
XAttributeDiscrete	createAttributeDiscrete(String key, long value, XExtension extension) Creates a new XES attribute with discrete type (Factory method).
XAttributeLiteral	createAttributeLiteral(String key, String value, XExtension extension) Creates a new XES attribute with literal type (Factory method).
XAttributeMap	createAttributeMap() Creates a new XES attribute map (Factory method).
XAttributeTimestamp	createAttributeTimestamp(String key, Date value, XExtension extension) Creates a new XES attribute with timestamp type (Factory method).
XAttributeTimestamp	createAttributeTimestamp(String key, long millis, XExtension extension) Creates a new XES attribute with timestamp type (Factory method).
XEvent	createEvent() Creates a new XES event instance (Factory method).
XEvent	createEvent(XAttributeMap attributes) Creates a new XES event instance (Factory method).
XLog	createLog() Creates a new XES log instance (Factory method).
XLog	createLog(XAttributeMap attributes) Creates a new XES log instance (Factory method).
XTrace	createTrace() Creates a new XES trace instance (Factory method).
XTrace	createTrace(XAttributeMap attributes) Creates a new XES trace instance (Factory method).
String	getAuthor() Returns the author name of the specific factory implementation.
String	getDescription() Returns a description of the specific factory implementation.
String	getName() Returns the name of the specific factory implementation.
URI	getUri() Returns an URI, pointing to more information about the specific factory implementation.
String	getVendor() Returns the vendor of the specific factory implementation.

Method Detail

getName

String getName()

Returns the name of the specific factory implementation.

getAuthor

String getAuthor()

Returns the author name of the specific factory implementation.

getVendor

String getVendor()

Returns the vendor of the specific factory implementation.

getDescription

String getDescription()

Returns a description of the specific factory implementation.

getUri

URI getUri()

Returns an URI, pointing to more information about the specific factory implementation.

createLog

XLog createLog()

Creates a new XES log instance (Factory method).

Returns:

A new log instance.

createLog

XLog createLog(XAttributeMap attributes)

Creates a new XES log instance (Factory method).

Parameters:

attributes - The attributes of the log.

Returns:

A new log instance.

createTrace

XTrace createTrace()

Creates a new XES trace instance (Factory method).

Returns:

A new trace instance.

createTrace

XTrace createTrace(XAttributeMap attributes)

Creates a new XES trace instance (Factory method).

Parameters:

attributes - The attributes of the trace.

Returns:

A new trace instance.

createEvent

XEvent createEvent()

Creates a new XES event instance (Factory method).

Returns:

A new event instance.

createEvent

XEvent createEvent(XAttributeMap attributes)

Creates a new XES event instance (Factory method).

Parameters:

attributes - The attributes of the event.

Returns:

A new event instance.

createAttributeMap

XAttributeMap createAttributeMap()

Creates a new XES attribute map (Factory method).

Returns:

A new XES attribute map instance.

createAttributeBoolean

XAttributeBoolean createAttributeBoolean(String key,
                                         boolean value,
                                         XExtension extension)

Creates a new XES attribute with boolean type (Factory method).

Parameters:

key - The key of the attribute.

value - The value of the attribute.

extension - The extension defining the attribute (set to null, if the attribute is not associated to an extension)

Returns:

A newly created attribute.

createAttributeContinuous

XAttributeContinuous createAttributeContinuous(String key,
                                               double value,
                                               XExtension extension)

Creates a new XES attribute with continuous type (Factory method).

Parameters:

key - The key of the attribute.

value - The value of the attribute.

extension - The extension defining the attribute (set to null, if the attribute is not associated to an extension)

Returns:

A newly created attribute.

createAttributeDiscrete

XAttributeDiscrete createAttributeDiscrete(String key,
                                           long value,
                                           XExtension extension)

Creates a new XES attribute with discrete type (Factory method).

Parameters:

key - The key of the attribute.

value - The value of the attribute.

extension - The extension defining the attribute (set to null, if the attribute is not associated to an extension)

Returns:

A newly created attribute.

createAttributeLiteral

XAttributeLiteral createAttributeLiteral(String key,
                                         String value,
                                         XExtension extension)

Creates a new XES attribute with literal type (Factory method).

Parameters:

key - The key of the attribute.

value - The value of the attribute.

extension - The extension defining the attribute (set to null, if the attribute is not associated to an extension)

Returns:

A newly created attribute.

createAttributeTimestamp

XAttributeTimestamp createAttributeTimestamp(String key,
                                             Date value,
                                             XExtension extension)

Creates a new XES attribute with timestamp type (Factory method).

Parameters:

key - The key of the attribute.

value - The value of the attribute.

extension - The extension defining the attribute (set to null, if the attribute is not associated to an extension)

Returns:

A newly created attribute.

createAttributeTimestamp

XAttributeTimestamp createAttributeTimestamp(String key,
                                             long millis,
                                             XExtension extension)

Creates a new XES attribute with timestamp type (Factory method).

Parameters:

key - The key of the attribute.

value - The value of the attribute, in milliseconds since 01/01/1970 0:00 GMT.

extension - The extension defining the attribute (set to null, if the attribute is not associated to an extension)

Returns:

A newly created attribute.