Skip to main content

OcelLog

Struct OcelLog 

Source
pub struct OcelLog { /* private fields */ }
Expand description

A complete object-centric event log: objects, events, E2O & O2O links, and object changes.

This is the OCEL canon as one value. OcelLog::validate checks structural integrity (no dangling links, no duplicate ids, no empty types); it does not mine anything.

Structure-only: an admitted OcelLog is a substrate for object-centric discovery and conformance, which graduate to wasm4pm.

Implementations§

Source§

impl OcelLog

Source

pub fn new( objects: impl IntoIterator<Item = OcelObject>, events: impl IntoIterator<Item = OcelEvent>, e2o: impl IntoIterator<Item = EventObjectLink>, o2o: impl IntoIterator<Item = ObjectObjectLink>, changes: impl IntoIterator<Item = ObjectChange>, ) -> Self

Construct an OCEL log from its five constituent tables.

use wasm4pm_compat::ocel::{OcelObject, OcelEvent, EventObjectLink, OcelLog};
let log = OcelLog::new(
    [OcelObject::new("ord-1", "order")],
    [OcelEvent::new("e1", "place_order")],
    [EventObjectLink::new("e1", "ord-1")],
    [],
    [],
);
assert!(log.validate().is_ok());
Source

pub fn objects(&self) -> &[OcelObject]

The declared objects.

Source

pub fn events(&self) -> &[OcelEvent]

The declared events.

The event-to-object (E2O) links.

The object-to-object (O2O) links.

Source

pub fn object_changes(&self) -> &[ObjectChange]

The recorded object changes.

Source

pub fn validate(&self) -> Result<(), OcelRefusal>

Structurally validate the OCEL log.

This is a structure check, not mining. It verifies, in order:

use wasm4pm_compat::ocel::{OcelObject, OcelEvent, EventObjectLink, OcelLog, OcelRefusal};
// Dangling E2O link: references object "ghost" that was never declared.
let log = OcelLog::new(
    [OcelObject::new("ord-1", "order")],
    [OcelEvent::new("e1", "a")],
    [EventObjectLink::new("e1", "ghost")],
    [],
    [],
);
assert_eq!(log.validate(), Err(OcelRefusal::DanglingEventObjectLink));

Trait Implementations§

Source§

impl Clone for OcelLog

Source§

fn clone(&self) -> OcelLog

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OcelLog

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for OcelLog

Source§

fn default() -> OcelLog

Returns the “default value” for a type. Read more
Source§

impl<'a> IntoIterator for &'a OcelLog

Source§

fn into_iter(self) -> Self::IntoIter

Iterate over the OcelEvents of this log.

The idiomatic OCEL iteration surface. Objects, E2O links, and O2O links are accessible via OcelLog::objects, OcelLog::event_object_links, and OcelLog::object_object_links respectively.

use wasm4pm_compat::ocel::{OcelLog, OcelObject, OcelEvent, EventObjectLink};
let log = OcelLog::new(
    [OcelObject::new("o1", "order")],
    [OcelEvent::new("e1", "place"), OcelEvent::new("e2", "ship")],
    [EventObjectLink::new("e1", "o1"), EventObjectLink::new("e2", "o1")],
    [],
    [],
);
let activities: Vec<&str> = (&log).into_iter().map(|e| e.activity()).collect();
assert_eq!(activities, ["place", "ship"]);
Source§

type Item = &'a OcelEvent

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, OcelEvent>

Which kind of iterator are we turning this into?
Source§

impl IntoIterator for OcelLog

Source§

fn into_iter(self) -> Self::IntoIter

Consume the log and iterate over its OcelEvents by value.

use wasm4pm_compat::ocel::{OcelLog, OcelObject, OcelEvent, EventObjectLink};
let log = OcelLog::new(
    [OcelObject::new("o1", "order")],
    [OcelEvent::new("e1", "place")],
    [EventObjectLink::new("e1", "o1")],
    [],
    [],
);
let v: Vec<OcelEvent> = log.into_iter().collect();
assert_eq!(v.len(), 1);
Source§

type Item = OcelEvent

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<OcelEvent>

Which kind of iterator are we turning this into?
Source§

impl PartialEq for OcelLog

Source§

fn eq(&self, other: &OcelLog) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for OcelLog

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> EvidenceKind for T

Source§

default fn kind_label(&self) -> &'static str

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.