de.uni.freiburg.iig.telematik.sewol.parser.LogParser 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;

import java.io.File;
import java.io.IOException;
import java.util.List;
import de.invation.code.toval.parser.ParserException;
import de.invation.code.toval.parser.ParserException.ErrorCode;
import de.invation.code.toval.validate.Validate;
import de.uni.freiburg.iig.telematik.sewol.log.LogEntry;
import de.uni.freiburg.iig.telematik.sewol.log.LogTrace;
import de.uni.freiburg.iig.telematik.sewol.parser.mxml.MXMLLogParser;
import de.uni.freiburg.iig.telematik.sewol.parser.petrify.PetrifyParser;
import de.uni.freiburg.iig.telematik.sewol.parser.plain.PlainParser;
import de.uni.freiburg.iig.telematik.sewol.parser.xes.XESLogParser;

public class LogParser {

        public static List>> parse(File file) throws IOException, ParserException {
                return parse(file, ParsingMode.COMPLETE);
        }

        public static List>> parse(File file, ParsingMode parsingMode) throws IOException, ParserException {
                validateFile(file);
                LogParsingFormat format = guessFormat(file);
                if (format == null) {
                        throw new ParserException(ErrorCode.UNKNOWN_FILE_EXTENSION);
                }
                LogParserInterface parser = getParser(file, format);
                return parser.parse(file, parsingMode);
        }

        public static List>> parse(String fileName) throws IOException, ParserException {
                return parse(fileName, ParsingMode.COMPLETE);
        }

        public static List>> parse(String fileName, ParsingMode parsingMode) throws IOException, ParserException {
                Validate.notNull(fileName);
                return parse(prepareFile(fileName), parsingMode);
        }

        public static List>> parse(File file, LogParsingFormat format) throws IOException, ParserException {
                return parse(file, format, ParsingMode.COMPLETE);
        }

        public static List>> parse(String fileName, LogParsingFormat format, ParsingMode parsingMode) throws IOException, ParserException {
                Validate.notNull(fileName);
                return parse(prepareFile(fileName), format, parsingMode);
        }

        public static List>> parse(File file, LogParsingFormat format, ParsingMode parsingMode) throws IOException, ParserException {
                validateFile(file);
                Validate.notNull(format);
                LogParserInterface parser = getParser(file, format);
                return parser.parse(file, parsingMode);
        }

        public static List>> parse(String fileName, LogParsingFormat format) throws IOException, ParserException {
                Validate.notNull(fileName);
                return parse(prepareFile(fileName), format);
        }

        public static synchronized LogParserInterface getParser(File file, LogParsingFormat format) throws ParserException {
                switch (format) {
                        case XES:
                                return new XESLogParser();
                        case MXML:
                                return new MXMLLogParser();
                        case PETRIFY:
                                return new PetrifyParser();
                        case PLAIN_SPACE:
                                return new PlainParser("\\s");
                        case PLAIN_TAB:
                                return new PlainParser("\\t");
                        default:
                                break;
                }
                throw new ParserException(ErrorCode.UNSUPPORTED_FORMAT);
        }

        private static File prepareFile(String fileName) throws IOException {
                File file = new File(fileName);
                validateFile(file);
                return file;
        }

        private static void validateFile(File file) throws IOException {
                if (!file.exists()) {
                        throw new IOException("I/O Error on opening file: File does not exist!");
                }
                if (file.isDirectory()) {
                        throw new IOException("I/O Error on opening file: File is a directory!");
                }
                if (!file.canRead()) {
                        throw new IOException("I/O Error on opening file: Unable to read file!");
                }
        }

        public static LogParsingFormat guessFormat(File file) {
                for (LogParsingFormat format : LogParsingFormat.values()) {
                        if (file.getName().endsWith(format.fileFormat.getFileExtension())) {
                                return format;
                        }
                }
                return null;
        }
}