org.processmining.importing.tpn
Class TpnImport

java.lang.Object
  extended by org.processmining.importing.tpn.TpnImport
All Implemented Interfaces:
Plugin, ImportPlugin, LogReaderConnectionImportPlugin

public class TpnImport
extends java.lang.Object
implements LogReaderConnectionImportPlugin

Parses a TPN file and produces a petri net.

This implementation parses bounds and transition labels, but does not use them. Undeclared places will be created automatically without warning if they occur in the in set or out set of a transition. The parser is case insensitive.

The parser is built with JavaCC, a free Java parser generator (like yacc). See https://javacc.dev.java.net/ for documentation.

The grammar file for the TPN parser is TpnParser.jj. The TpnParser class can be rebuilt with the command javacc TpnParser.jj.

Version:
1.0
Author:
Peter van den Brand

Constructor Summary
TpnImport()
           
 
Method Summary
 javax.swing.filechooser.FileFilter getFileFilter()
           
 java.lang.String getHtmlDescription()
          Gets a description of this plugin in HTML.
 java.lang.String getName()
          Gets the name of this plugin.
 PetriNetResult importFile(java.io.InputStream input)
          Interface for plugins that import from file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TpnImport

public TpnImport()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: Plugin
Gets the name of this plugin. Implementing classes should use this method to return their own name.

Specified by:
getName in interface Plugin
Returns:
the name of this plugin

getFileFilter

public javax.swing.filechooser.FileFilter getFileFilter()
Specified by:
getFileFilter in interface ImportPlugin

importFile

public PetriNetResult importFile(java.io.InputStream input)
                          throws java.io.IOException
Description copied from interface: ImportPlugin
Interface for plugins that import from file.

Specified by:
importFile in interface ImportPlugin
Specified by:
importFile in interface LogReaderConnectionImportPlugin
Parameters:
input - The framework will always provide a ProMInputStream as the input parameter. To retrieve the filename use: ((ProMInputStream) input).getFilename();
Returns:
MiningResult A JComponent that is visualized in a frame. If null is returned then the framework thinks the call to this method was aborted.
Throws:
java.io.IOException - If an IO exception occurs.

getHtmlDescription

public java.lang.String getHtmlDescription()
Description copied from interface: Plugin
Gets a description of this plugin in HTML. The string returned by this method should only contain the contents of the body of the html page, so the html, head and body tags should not be used. This HTML page is displayed in the help system or as context sensitive help. The HTML body can be stored in an external file in the /lib/documentation/ sub folder and in this case it can be obtained by calling PluginDocumentationLoader.load(this)

Specified by:
getHtmlDescription in interface Plugin
Returns:
a description of this plugin in HTML