schema
schema ¤
Column-name constants and schema definitions for the ts-shape event log.
The canonical event-log uses OCEL 2.0 column names (ocel:*) with a few
ts-shape-prefixed columns for fields that have no OCEL counterpart but are
useful for downstream consumers (interval starts, durations, severity, etc.).
XES column names (concept:name, time:timestamp, case:concept:name,
lifecycle:transition, org:resource) are produced only by the flat
exporter; they do not appear in the canonical schema.
register_object_type ¤
register_object_type(name: str) -> None
Register a custom OCEL object type so adapters can emit it.
is_known_object_type ¤
is_known_object_type(name: str) -> bool
Check whether an OCEL object type is built in or has been registered.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Object type name to look up. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if |
empty_events ¤
empty_events() -> pd.DataFrame
Return an empty events table with the canonical columns and dtypes.
Returns:
| Type | Description |
|---|---|
DataFrame
|
A zero-row DataFrame with the expected events schema. |
empty_objects ¤
empty_objects() -> pd.DataFrame
Return an empty objects table with the canonical columns and dtypes.
Returns:
| Type | Description |
|---|---|
DataFrame
|
A zero-row DataFrame with the expected objects schema. |
empty_relations ¤
empty_relations() -> pd.DataFrame
Return an empty event-to-object relations table with the canonical columns and dtypes.
Returns:
| Type | Description |
|---|---|
DataFrame
|
A zero-row DataFrame with the expected event-to-object relations schema. |
empty_o2o ¤
empty_o2o() -> pd.DataFrame
Return an empty object-to-object relations table with the canonical columns and dtypes.
Returns:
| Type | Description |
|---|---|
DataFrame
|
A zero-row DataFrame with the expected object-to-object relations schema. |
empty_object_changes ¤
empty_object_changes() -> pd.DataFrame
Return an empty object changes table with the canonical columns and dtypes.
Returns:
| Type | Description |
|---|---|
DataFrame
|
A zero-row DataFrame with the expected object changes schema. |
validate ¤
validate(eventlog: EventLog) -> None
Raise ValueError if the event log violates the canonical schema.