opyenxes.data_out package

Submodules

opyenxes.data_out.XMxmlGZIPSerializer module

class opyenxes.data_out.XMxmlGZIPSerializer.XMxmlGZIPSerializer

Bases: opyenxes.data_out.XMxmlSerializer.XMxmlSerializer

Compressed MXML serialization for XES data (legacy implementation). Note that this serialization may be lossy, you should preferrably use the XES.XML serialization for XES data.

static get_suffices()

Returns an array of possible file suffices for this serialization.

Returns:An array of possible file suffices for this serialization. Return type:list[str]

serialize(log, out, in_bytes=False)

Serializes a given log to the given output stream.

Parameters:

• log (XLog) – Log to be serialized.
• out (_io.TextIOWrapper) – TextIOWrapper for serialization.
• in_bytes (bool) – Private argument to decide if serialized as bytes or as string

opyenxes.data_out.XMxmlSerializer module

class opyenxes.data_out.XMxmlSerializer.XMxmlSerializer

Bases: object

MXML serialization for XES data (legacy implementation). Note that this serialization may be lossy, you should preferrably use the XES.XML serialization for XES data.

add_attribute(tag, attributes, key_prefix=None)

Helper method, adds attributes to a tag.

Parameters:

• tag (xml.etree.ElementTree.Element) – The tag to add attributes to.
• attributes (dict_values) – The attributes to add.
• key_prefix (str) – The Key prefix of attributes.

static add_model_reference(element, target)

Helper method, adds all model references of an attributable to the given tag.

Parameters:

• element (XAttributable) – Attributable element.
• target (xml.etree.ElementTree.Element) – Tag to add model references to.

static get_suffices()

Returns an array of possible file suffices for this serialization.

Returns:An array of possible file suffices for this serialization. Return type:list[str]

serialize(log, out, in_bytes=False)

Serializes a given log to the given output stream.

Parameters:

• log (XLog) – Log to be serialized.
• out (_io.TextIOWrapper) – TextIOWrapper for serialization.
• in_bytes (bool) – Private argument to decide if serialized in bytes or in string

opyenxes.data_out.XSerializerRegistry module

class opyenxes.data_out.XSerializerRegistry.XSerializerRegistry

Bases: opyenxes.utils.XRegistry.XRegistry

System-wide registry for XES serializer implementations. Applications can use this registry as a convenience to provide an overview about serializeable formats, e.g., in the user interface. Any custom serializer implementation can be registered with this registry, so that it transparently becomes available also to any other using application.

Uses the singleton metaclass

opyenxes.data_out.XesXmlGZIPSerializer module

class opyenxes.data_out.XesXmlGZIPSerializer.XesXmlGZIPSerializer

Bases: opyenxes.data_out.XesXmlSerializer.XesXmlSerializer

XES compressed XML serialization for the XES format.

static get_suffices()

Returns an array of possible file suffices for this serialization.

Returns:An array of possible file suffices for this serialization. Return type:list[str]

serialize(log, out, in_bytes=False)

Serializes a given log to the given output stream.

Parameters:

• log (XLog) – Log to be serialized.
• out (_io.TextIOWrapper) – TextIOWrapper for serialization.
• in_bytes (bool) – Private argument to decide if serialized as bytes or as string

opyenxes.data_out.XesXmlSerializer module

class opyenxes.data_out.XesXmlSerializer.XesXmlSerializer

Bases: object

XES plain XML serialization for the XES format.

add_attributes(tag, attributes)

Helper method, adds the given collection of attributes to the given Tag.

Parameters:

• tag (xml.etree.ElementTree.Element) – Tag to add attributes to.
• attributes (dict_values) – Collection with the attributes to add.

add_global_attributes(parent, scope, attributes)

Helper method for defining global attributes on a given scope.

Parameters:

• parent (xml.etree.ElementTree.Element) – xml element to add a children element with the global attributes
• scope (str) – Name of the global attributes, can be ‘trace’ or ‘event’.
• attributes (dict_values) – Collection with the attributes to add.

static get_author()

Returns the name of this serialization’s author.

Returns:The author name. Return type:str

static get_suffices()

Returns an array of possible file suffices for this serialization.

Returns:An array of possible file suffices for this serialization. Return type:list[str]

serialize(log, out, in_bytes=False)

Serializes a given log to the given output stream.

Parameters:

• log (XLog) – Log to be serialized.
• out (_io.TextIOWrapper) – TextIOWrapper for serialization.
• in_bytes (bool) – Private argument to decide if serialized as bytes or as string

Module contents