Source code for pm4py.objects.ocel.exporter.jsonocel.variants.classic

'''
    PM4Py – A Process Mining Library for Python
Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see this software project's root or
visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions
Contact: info@processintelligence.solutions
'''
import json
from enum import Enum
from typing import Optional, Dict, Any

import pandas as pd

from pm4py.objects.ocel import constants
from pm4py.objects.ocel.exporter.util import clean_dataframes
from pm4py.objects.ocel.obj import OCEL
from pm4py.objects.ocel.util import attributes_names
from pm4py.objects.ocel.util import related_objects
from pm4py.objects.ocel.util import filtering_utils
from pm4py.util import exec_utils, constants as pm4_constants, pandas_utils
from pm4py.objects.ocel.util import ocel_consistency




class Parameters(Enum):
    EVENT_ID = constants.PARAM_EVENT_ID
    OBJECT_ID = constants.PARAM_OBJECT_ID
    OBJECT_TYPE = constants.PARAM_OBJECT_TYPE
    ENCODING = "encoding"





def get_base_json_object(
    ocel: OCEL, parameters: Optional[Dict[Any, Any]] = None
):
    if parameters is None:
        parameters = {}

    event_id = exec_utils.get_param_value(
        Parameters.EVENT_ID, parameters, ocel.event_id_column
    )
    object_id = exec_utils.get_param_value(
        Parameters.OBJECT_ID, parameters, ocel.object_id_column
    )
    object_type = exec_utils.get_param_value(
        Parameters.OBJECT_TYPE, parameters, ocel.object_type_column
    )

    all_object_types = pandas_utils.format_unique(
        ocel.objects[object_type].unique()
    )
    all_attribute_names = attributes_names.get_attribute_names(
        ocel, parameters=parameters
    )
    global_event_items = (
        ocel.globals[constants.OCEL_GLOBAL_EVENT]
        if constants.OCEL_GLOBAL_EVENT in ocel.globals
        else constants.DEFAULT_GLOBAL_EVENT
    )
    global_object_items = (
        ocel.globals[constants.OCEL_GLOBAL_OBJECT]
        if constants.OCEL_GLOBAL_OBJECT in ocel.globals
        else constants.DEFAULT_GLOBAL_OBJECT
    )
    rel_objs = related_objects.related_objects_dct_overall(
        ocel, parameters=parameters
    )

    events_items, objects_items = clean_dataframes.get_dataframes_from_ocel(
        ocel, parameters=parameters
    )

    base_object = {}
    base_object[constants.OCEL_GLOBAL_EVENT] = global_event_items
    base_object[constants.OCEL_GLOBAL_OBJECT] = global_object_items
    base_object[constants.OCEL_GLOBAL_LOG] = {}
    base_object[constants.OCEL_GLOBAL_LOG][
        constants.OCEL_GLOBAL_LOG_OBJECT_TYPES
    ] = all_object_types
    base_object[constants.OCEL_GLOBAL_LOG][
        constants.OCEL_GLOBAL_LOG_ATTRIBUTE_NAMES
    ] = all_attribute_names
    base_object[constants.OCEL_GLOBAL_LOG][
        constants.OCEL_GLOBAL_LOG_VERSION
    ] = constants.CURRENT_VERSION
    base_object[constants.OCEL_GLOBAL_LOG][
        constants.OCEL_GLOBAL_LOG_ORDERING
    ] = constants.DEFAULT_ORDERING
    base_object[constants.OCEL_EVENTS_KEY] = {}
    base_object[constants.OCEL_OBJECTS_KEY] = {}

    events_items = events_items.to_dict("records")
    i = 0
    while i < len(events_items):
        event = events_items[i]
        eid = event[event_id]
        del event[event_id]
        event = {k: v for k, v in event.items() if pd.notnull(v)}
        vmap = {
            k: v
            for k, v in event.items()
            if not k.startswith(constants.OCEL_PREFIX)
        }
        event = {
            k: v
            for k, v in event.items()
            if k.startswith(constants.OCEL_PREFIX)
        }
        event[constants.OCEL_VMAP_KEY] = vmap
        event[constants.OCEL_OMAP_KEY] = list(rel_objs[eid])
        base_object[constants.OCEL_EVENTS_KEY][eid] = event
        i = i + 1
    del events_items

    objects_items = objects_items.to_dict("records")
    i = 0
    while i < len(objects_items):
        object = objects_items[i]
        oid = object[object_id]
        del object[object_id]
        ovmap = {
            k: v
            for k, v in object.items()
            if pd.notnull(v) and not k.startswith(constants.OCEL_PREFIX)
        }
        object = {
            object_type: object[object_type],
            constants.OCEL_OVMAP_KEY: ovmap,
        }
        base_object[constants.OCEL_OBJECTS_KEY][oid] = object
        i = i + 1
    del objects_items

    return base_object





def apply(
    ocel: OCEL, target_path: str, parameters: Optional[Dict[Any, Any]] = None
):
    """
    Exports an object-centric event log in a JSONOCEL file, using the classic JSON dump

    Parameters
    ------------------
    ocel
        Object-centric event log
    target_path
        Destination path
    parameters
        Parameters of the algorithm, including:
        - Parameters.EVENT_ID => the event ID column
        - Parameters.OBJECT_ID => the object ID column
        - Parameters.OBJECT_TYPE => the object type column
    """
    if parameters is None:
        parameters = {}

    encoding = exec_utils.get_param_value(
        Parameters.ENCODING, parameters, pm4_constants.DEFAULT_ENCODING
    )

    ocel = ocel_consistency.apply(ocel, parameters=parameters)
    ocel = filtering_utils.propagate_relations_filtering(
        ocel, parameters=parameters
    )

    base_object = get_base_json_object(ocel, parameters=parameters)

    F = open(target_path, "w", encoding=encoding)
    json.dump(base_object, F, indent=2)
    F.close()