Module: XES

Defined in:
lib/xes.rb,
lib/xes/log.rb,
lib/xes/event.rb,
lib/xes/trace.rb,
lib/xes/global.rb,
lib/xes/version.rb,
lib/xes/document.rb,
lib/xes/attribute.rb,
lib/xes/extension.rb,
lib/xes/classifier.rb,
lib/xes/format-error.rb,
lib/xes/attribute-accessor.rb

Overview

XES is a module for genereting XES event log.

Defined Under Namespace

Modules: AttributeAccessor, EventAttributeAccessor, TraceAttributeAccessor Classes: Attribute, Classifier, Document, Event, Extension, FormatError, Global, Log, Trace

Constant Summary collapse

VERSION =

version of ruby-xes

"0.1.0"
EXTENSION =

known XES extension elements

{
  :concept => Extension.new("Concept", "concept", "http://www.xes-standard.org/concept.xesext"),
  :identity => Extension.new("Identity", "identity", "http://www.xes-standard.org/identity.xesext"),
  :time => Extension.new("Time", "time", "http://www.xes-standard.org/time.xesext"),
  :lifecycle => Extension.new("Lifecycle", "lifecycle", "http://www.xes-standard.org/lifecycle.xesext"),
  :organizational => Extension.new("Organizational", "org", "http://www.xes-standard.org/org.xesext")
}
CLASSIFIER =

known XES classifier elements

{
  :mxml_legacy_classifier => Classifier.new("MXML Legacy Classifier", "concept:name lifecycle:transition"),
  :event_name => Classifier.new("Event Name", "concept:name"),
  :resource => Classifier.new("Resource", "org:resource")
}

Class Method Summary collapse

Class Method Details

.boolean(key, value, meta = []) ⇒ Attribute

Return boolean attribute object.

Parameters:

  • key (String) —

    attribute name

  • value (Object) —

    attribute value

  • meta (Array<Attribute>) (defaults to: []) —

    meta attributes

Returns:



183
184
185
 
# File 'lib/xes/attribute.rb', line 183

def boolean(key, value, meta=[])
  Attribute.new("boolean", key, value, meta)
end

.date(key, value, meta = []) ⇒ Attribute

Return date attribute object.

Parameters:

  • key (String) —

    attribute name

  • value (Object) —

    attribute value

  • meta (Array<Attribute>) (defaults to: []) —

    meta attributes

Returns:



141
142
143
 
# File 'lib/xes/attribute.rb', line 141

def date(key, value, meta=[])
  Attribute.new("date", key, value, meta)
end

.float(key, value, meta = []) ⇒ Attribute

Return float attribute object.

Parameters:

  • key (String) —

    attribute name

  • value (Object) —

    attribute value

  • meta (Array<Attribute>) (defaults to: []) —

    meta attributes

Returns:



169
170
171
 
# File 'lib/xes/attribute.rb', line 169

def float(key, value, meta=[])
  Attribute.new("float", key, value, meta)
end

.id(key, value, meta = []) ⇒ Attribute

Return id attribute object.

Parameters:

  • key (String) —

    attribute name

  • value (Object) —

    attribute value

  • meta (Array<Attribute>) (defaults to: []) —

    meta attributes

Returns:



197
198
199
 
# File 'lib/xes/attribute.rb', line 197

def id(key, value, meta=[])
  Attribute.new("id", key, value, meta)
end

.int(key, value, meta = []) ⇒ Attribute

Return int attribute object.

Parameters:

  • key (String) —

    attribute name

  • value (Object) —

    attribute value

  • meta (Array<Attribute>) (defaults to: []) —

    meta attributes

Returns:



155
156
157
 
# File 'lib/xes/attribute.rb', line 155

def int(key, value, meta=[])
  Attribute.new("int", key, value, meta)
end

.string(key, value, meta = []) ⇒ Attribute

Return string attribute object.

Parameters:

  • key (String) —

    attribute name

  • value (Object) —

    attribute value

  • meta (Array<Attribute>) (defaults to: []) —

    meta attributes

Returns:



127
128
129
 
# File 'lib/xes/attribute.rb', line 127

def string(key, value, meta=[])
  Attribute.new("string", key, value, meta)
end