org.deckfour.xes.in
Class XesXmlParser

java.lang.Object
  extended by org.deckfour.xes.in.XParser
      extended by org.deckfour.xes.in.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
protected  class XesXmlParser.XesXmlHandler
          SAX handler class for XES in XML representation.
 
Field Summary
protected  XFactory factory
          XES model factory used to build model.
protected static URI XES_URI
          Unique URI for the format definition.
protected  XsDateTimeConversion xsDateTimeConversion
           
 
Constructor Summary
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
 String author()
          Returns the name of the author of this parser.
 boolean canParse(File file)
          Checks whether this parser can handle the given file.
 String description()
          Returns a brief description of this parser.
 String name()
          Returns the name of this parser or, more specifically, the name of the format it can process.
 List<XLog> parse(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 org.deckfour.xes.in.XParser
parse, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

xsDateTimeConversion

protected XsDateTimeConversion xsDateTimeConversion

XES_URI

protected static final 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 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(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 String description()
Description copied from class: XParser
Returns a brief description of this parser.

Specified by:
description in class XParser

name

public 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 List<XLog> parse(InputStream is)
                 throws 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:
Exception