|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.deckfour.xes.in.XParser
public abstract class XParser
This abstract class describes a parser for reading XES models from a given input stream.
Constructor Summary | |
---|---|
XParser()
|
Method Summary | |
---|---|
abstract java.lang.String |
author()
Returns the name of the author of this parser. |
abstract boolean |
canParse(java.io.File file)
Checks whether this parser can handle the given file. |
abstract java.lang.String |
description()
Returns a brief description of this parser. |
abstract 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.File file)
Parses the given file, and returns the XLog instances extracted. |
abstract java.util.List<XLog> |
parse(java.io.InputStream is)
Parses the given input stream, and returns the XLog instances extracted. |
java.lang.String |
toString()
toString() defaults to name(). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XParser()
Method Detail |
---|
public abstract java.lang.String name()
public abstract java.lang.String description()
public abstract java.lang.String author()
public abstract boolean canParse(java.io.File file)
file
- File to check against parser.
public abstract java.util.List<XLog> parse(java.io.InputStream is) throws java.lang.Exception
is
- Stream to read XLog instances from.
java.lang.Exception
public java.util.List<XLog> parse(java.io.File file) throws java.lang.Exception
IOException
.
file
- The file to be parsed.
java.lang.Exception
- Raised in case the parser fails, or the
given file cannot be processed.public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |