Package org.deckfour.xes.in

Class XesXmlParser

  • Direct Known Subclasses:
    XesXmlGZIPParser
    public class XesXmlParser
extends XParser
    Parser for the XES XML serialization.
    Author:
    Christian W. Guenther (christian@deckfour.org)

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      protected class  XesXmlParser.XesXmlHandler
      SAX handler class for XES in XML representation.

    • Constructor Summary

      Constructors 
      Constructor Description
      XesXmlParser()
      Creates a new parser instance, using the currently-set standard factory for building the model.
      XesXmlParser​(XFactory factory)
      Creates a new parser instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String author()
      Returns the name of the author of this parser.
      boolean canParse​(java.io.File file)
      Checks whether this parser can handle the given file.
      java.lang.String description()
      Returns a brief description of this parser.
      java.lang.String name()
      Returns the name of this parser or, more specifically, the name of the format it can process.
      java.util.List<XLog> parse​(java.io.InputStream is)
      Parses a log from the given input stream, which is supposed to deliver an XES log in XML representation.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • XES_URI

        protected static final java.net.URI XES_URI
        Unique URI for the format definition.

      • factory

        protected XFactory factory
        XES model factory used to build model.

    • Constructor Detail

      • XesXmlParser

        public XesXmlParser​(XFactory factory)
        Creates a new parser instance.
        Parameters:
        factory - The XES model factory instance used to build the model from the serialization.

      • XesXmlParser

        public XesXmlParser()
        Creates a new parser instance, using the currently-set standard factory for building the model.

    • Method Detail

      • author

        public java.lang.String author()
        Description copied from class: XParser
        Returns the name of the author of this parser.
        Specified by:
        author in class XParser

      • canParse

        public boolean canParse​(java.io.File file)
        Description copied from class: XParser
        Checks whether this parser can handle the given file.
        Specified by:
        canParse in class XParser
        Parameters:
        file - File to check against parser.
        Returns:
        Whether this parser can handle the given file.

      • description

        public java.lang.String description()
        Description copied from class: XParser
        Returns a brief description of this parser.
        Specified by:
        description in class XParser

      • name

        public java.lang.String name()
        Description copied from class: XParser
        Returns the name of this parser or, more specifically, the name of the format it can process.
        Specified by:
        name in class XParser

      • parse

        public java.util.List<XLog> parse​(java.io.InputStream is)
                           throws java.lang.Exception
        Parses a log from the given input stream, which is supposed to deliver an XES log in XML representation.
        Specified by:
        parse in class XParser
        Parameters:
        is - Input stream, which is supposed to deliver an XES log in XML representation.
        Returns:
        The parsed log.
        Throws:
        java.lang.Exception