opyenxes.id package

Submodules

opyenxes.id.XID module

class opyenxes.id.XID.XID(uuid_arg=None)[source]

Bases: object

Implements a unique ID based on UUID.

Parameters:uuid_arg (uuid.UUID) – The UUID implementing XID uniqueness.
clone()[source]

Creates and returns a copy of this object.

Returns:A clone of this instance.
Return type:XID
compare_to(other)[source]

Helper method to compares this object with the specified object for order.

Parameters:other (XID) – the Object to be compared.
Returns:A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Return type:int
get_uuid()[source]

Retrieves the uuid value of this object.

Returns:The uuid attribute.
Return type:uuid.UUID
static parse(id_string)[source]

Parses an XID object from its text representation.

Parameters:id_string (str) – Text representation of an XID.
Returns:The parsed XID.
Return type:XID
set_uuid(uuid_arg)[source]

Assigns the uuid value of this object.

Parameters:uuid_arg (uuid.UUID) – The new uuid value.

opyenxes.id.XIDFactory module

class opyenxes.id.XIDFactory.XIDFactory[source]

Bases: object

This class is a factory for unique identifiers, as they are used throughout the XES model for element identification.

Uses the singleton metaclass

static create_id()[source]

Creates a new, unique ID

Returns:Unique ID
Return type:XID

Module contents