de.uni.freiburg.iig.telematik.sewol.parser.xes.DataUsageExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of SEWOL Show documentation

SEWOL provides support for the handling of workflow traces. Specifically it allows to specify the shape and content of process traces in terms of entries representing the execution of a specific workflow activity. SEWOL also allows to write these traces on disk as a log file with the help of a special file writer for process logs. Currently it supports plain text, Petrify, MXML and XES log file types. In order to specify security-related context information, SEWOL provides access control models such as access control lists (ACL) and role-based access control models (RBAC). All types of models can be conveniently edited with the help of appropriate dialogs.

The newest version!

package de.uni.freiburg.iig.telematik.sewol.parser.xes;

import java.net.URI;
import java.util.HashMap;
import java.util.Map;

import org.deckfour.xes.extension.XExtension;
import org.deckfour.xes.factory.XFactory;
import org.deckfour.xes.factory.XFactoryRegistry;
import org.deckfour.xes.info.XGlobalAttributeNameMap;
import org.deckfour.xes.model.XAttribute;
import org.deckfour.xes.model.XAttributeLiteral;
import org.deckfour.xes.model.XEvent;

/**
 * This extension adds the data attribute with usage specification to events.
 *
 * @version 1.0
 * @author Adrian Lange
 */
public class DataUsageExtension extends XExtension {

        private static final long serialVersionUID = 8737134413446055085L;

        /**
         * Unique URI of this extension.
         */
        public static final URI EXTENSION_URI = URI.create("http://xes.process-security.de/extensions/dataUsage.xesext");

        /**
         * Extension name.
         */
        public static final String EXTENSION_NAME = "AttributeDataUsage";

        /**
         * Extension prefix.
         */
        public static final String EXTENSION_PREFIX = "dataUsage";

        /**
         * Key for the data attribute.
         */
        public static final String KEY_DATA = EXTENSION_PREFIX + ":usage";

        /**
         * Map of extension descriptions fpor different languages.
         */
        public static final Map EXTENSION_DESCRIPTIONS = new HashMap<>(2);

        /**
         * Data attribute prototype.
         */
        public static XAttributeLiteral ATTR_DATA;

        /**
         * Singleton instance of this extension.
         */
        private static DataUsageExtension SINGLETON = null;

        static {
                EXTENSION_DESCRIPTIONS.put(XGlobalAttributeNameMap.MAPPING_ENGLISH, "Data usage (comma separated list of read, create, write, and delete)");
                EXTENSION_DESCRIPTIONS.put(XGlobalAttributeNameMap.MAPPING_GERMAN, "Datenzugriff (durch Kommata getrennte Liste aus read, create, write und delete)");
        }

        /**
         * Provides access to the singleton instance of this extension.
         *
         * @return The AttributeDataUsage extension singleton.
         */
        public static synchronized DataUsageExtension instance() {
                if (SINGLETON == null) {
                        SINGLETON = new DataUsageExtension();
                        XFactory factory = XFactoryRegistry.instance().currentDefault();
                        ATTR_DATA = factory.createAttributeLiteral(KEY_DATA, "", SINGLETON);
                        SINGLETON.eventAttributes.add((XAttribute) ATTR_DATA.clone());
                        // register mapping aliases
                        for (Map.Entry mapping : EXTENSION_DESCRIPTIONS.entrySet()) {
                                XGlobalAttributeNameMap.instance().registerMapping(mapping.getKey(), KEY_DATA, mapping.getValue());
                        }
                }
                return SINGLETON;
        }

        private DataUsageExtension() {
                super(EXTENSION_NAME, EXTENSION_PREFIX, EXTENSION_URI);
        }

        /**
         * Extracts the data attribute string from an event.
         *
         * @param event Event to be queried.
         * @return Data string for the given event (may be null if
         * not defined)
         */
        public String extractData(XEvent event) {
                XAttribute attribute = event.getAttributes().get(KEY_DATA);
                if (attribute == null) {
                        return null;
                } else {
                        return ((XAttributeLiteral) attribute).getValue();
                }
        }

        /**
         * Assigns the data attribute value for a given event.
         *
         * @param event Event to be modified.
         * @param data Data string to be assigned.
         */
        public void assignData(XEvent event, String data) {
                if (data != null && data.trim().length() > 0) {
                        XAttributeLiteral attr = (XAttributeLiteral) ATTR_DATA.clone();
                        attr.setValue(data.trim());
                        event.getAttributes().put(KEY_DATA, attr);
                }
        }
}