org.jbpt.petri.io.PNMLSerializer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbpt-petri Show documentation
Show all versions of jbpt-petri Show documentation
The jBPT code library is a compendium of technologies that support research on design, execution, and evaluation of business processes.
The newest version!
package org.jbpt.petri.io;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.HashMap;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
import org.jbpt.petri.Flow;
import org.jbpt.petri.NetSystem;
import org.jbpt.petri.Node;
import org.jbpt.petri.PetriNet;
import org.jbpt.petri.Place;
import org.jbpt.petri.Transition;
import org.jbpt.throwable.SerializationException;
import org.w3c.dom.DOMImplementation;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.DefaultHandler;
import org.xml.sax.helpers.XMLReaderFactory;
/**
* Class of Type DefaultHandler that overrides some methods to extract PNML-Data from given files.
*
* Main method: parse(String filename)
*
* @author [email protected], Matthias Weidlich, Artem Polyvyanyy, Tobias Hoppe
* @since 09.11.2011
*/
public class PNMLSerializer extends DefaultHandler
{
public static int DEFAULT = 0;
public static int LOLA = 1;
private boolean place, placeName, placeNameText, placeMarking, placeMarkingText;
private boolean arc;
private boolean transition, transitionName, transitionNameText;
private boolean toolspecific;
private NetSystem pn;
private HashMap nodes;
private String currentTransitionID;
private String currentPlaceID;
/**
* Clear the internal data structures of the parser
*/
public void clear() {
this.pn = new NetSystem();
this.nodes = new HashMap();
this.place = false;
this.placeName = false;
this.placeNameText = false;
this.placeMarking = false;
this.placeMarkingText = false;
this.arc = false;
this.toolspecific = false;
this.transition = false;
this.transitionName = false;
this.transitionNameText = false;
this.currentTransitionID = "";
this.currentPlaceID = "";
}
/**
* Parses a NetSystem out of the given PNML XML-File.
*
* @param pnmlContent A process description based on the PNML-Standard as byte array.
* @return The {@link NetSystem} parsed from the given PNML-content.
*/
public NetSystem parse(byte[] pnmlContent){
return parseContent(null, pnmlContent);
}
/**
* Parses a NetSystem out of a predefined PNML-file
*
* @param file File containing a process description based on the PNML-Standard.
* @return The {@link NetSystem} parsed from the given {@link File}.
*/
public NetSystem parse(String file){
return parseContent(file, null);
}
/**
* Parses a NetSystem from the given file name if it is not null.
* Otherwise, the byte array containing the PNML-content is parsed.
* @param file File containing a process description based on the PNML-Standard.
* @param pnmlContent A process description based on the PNML-Standard as byte array.
* @return The {@link NetSystem} parsed from the given {@link File} or PNML-content.
*/
private NetSystem parseContent(String file, byte[] pnmlContent) {
/*
* Clear internal data structures
*/
clear();
XMLReader xmlReader; //Reader to perform XML parsing
try
{
xmlReader = XMLReaderFactory.createXMLReader();
xmlReader.setFeature("http://xml.org/sax/features/validation", false);
xmlReader.setContentHandler(this);
xmlReader.setDTDHandler(this);
xmlReader.setErrorHandler(this);
try
{
if(file != null) {
FileInputStream fileStream = new FileInputStream(file);
InputSource is = new InputSource(fileStream);
xmlReader.parse(is);
} else if (pnmlContent != null) {
StringReader inStream = new StringReader(new String(pnmlContent));
InputSource is = new InputSource(inStream);
xmlReader.parse(is);
}
}
catch (IOException e) {
System.out.println("Error reading PNML-File.");
}
}
catch (SAXException e) {
System.out.println("SAX Exception: " + e.getMessage());
}
return pn;
}
@Override
public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
super.startElement(uri, localName, qName, attributes);
if(placeName) {
placeNameText = localName.equals("text");
}
else if(placeMarking) {
placeMarkingText = localName.equals("text");
}
else if(transitionName) {
transitionNameText = localName.equals("text");
}
else if(arc) {
}
else if(toolspecific) {
}
else if (place) {
if (localName.equals("name"))
placeName = true;
else if (localName.equals("initialMarking"))
placeMarking = true;
}
else if (transition) {
if (localName.equals("name"))
transitionName = true;
}
if (localName.equals("arc")) {
arc = true;
pn.addFlow(nodes.get(attributes.getValue(1)), nodes.get(attributes.getValue(2)));
}
else if (localName.equals("place")){
place = true;
Place p = new Place(attributes.getValue(0));
p.setId(attributes.getValue(0));
p.setName("");
nodes.put(p.getId(), p);
pn.addPlace(p);
this.currentPlaceID = p.getId();
}
else if (localName.equals("transition")){
transition = true;
Transition t = new Transition();
t.setId(attributes.getValue(0));
t.setName("");
nodes.put(t.getId(), t);
pn.addTransition(t);
this.currentTransitionID = t.getId();
}
else if (localName.equals("toolspecific")){
toolspecific = true;
}
}
@Override
public void characters(char[] ch, int start, int length) throws SAXException {
super.characters(ch, start, length);
if (placeNameText) {
char[] text = new char[length];
System.arraycopy(ch, start, text, 0, length);
String name = this.nodes.get(currentPlaceID).getName() + new String(text);
this.nodes.get(currentPlaceID).setName(name);
}
else if (placeMarkingText) {
char[] text = new char[length];
System.arraycopy(ch, start, text, 0, length);
this.pn.getMarking().put((Place) this.nodes.get(currentPlaceID),Integer.valueOf(new String(text)));
}
else if (transitionNameText) {
char[] text = new char[length];
System.arraycopy(ch, start, text, 0, length);
String name = this.nodes.get(currentTransitionID).getName() + new String(text);
this.nodes.get(currentTransitionID).setLabel(name);
}
}
@Override
public void endElement(String uri, String localName, String qName)
throws SAXException {
super.endElement(uri, localName, qName);
if (localName.equals("text")) {
if (transitionNameText) {
transitionNameText = false;
String name = normalizeTransitionLabel(this.nodes.get(currentTransitionID).getName());
this.nodes.get(currentTransitionID).setName(name);
}
else if (placeNameText)
placeNameText = false;
else if (placeMarkingText)
placeMarkingText = false;
}
else if (localName.equals("name")) {
if (transitionName)
transitionName = false;
else if (placeName)
placeName = false;
}
else if (localName.equals("initialMarking")) {
placeMarking = false;
}
else if (localName.equals("arc")) {
arc = false;
}
else if (localName.equals("place")){
place = false;
}
else if (localName.equals("transition")){
transition = false;
}
else if (localName.equals("toolspecific")){
toolspecific = false;
}
}
/**
* Called, if an error occurs while XML-Doc is parsed.
*/
public void error( SAXParseException e ) throws SAXException
{
throw new SAXException( saxMsg(e) );
}
/**
* Creates a detailled error notification!
*
* @param e Exception vom Typ SAXParseException
* @return Notification containing Line, Column and Error.
*/
private String saxMsg( SAXParseException e )
{
return "Line: " + e.getLineNumber() + ", Column: " + e.getColumnNumber() + ", Error: " + e.getMessage();
}
private String normalizeTransitionLabel(String label) {
String result = label.replace("\n", " ");
result = result.trim();
return result;
}
/**
* Creates a PNML XML string from the given {@link PetriNet}.
* @param net {@link PetriNet} to transform into PNML-String
* @return PNML string.
* @throws SerializationException
*/
public static String serializePetriNet(NetSystem net) throws SerializationException {
return serializePetriNet(net, DEFAULT);
}
/**
* Creates a PNML XML string from the given {@link PetriNet}.
* @param net {@link PetriNet} to transform into PNML-String
* @param tool integer indicating the tool
* @return PNML string
* @throws SerializationException
*/
public static String serializePetriNet(NetSystem net, int tool) throws SerializationException {
Document doc = PNMLSerializer.serialize(net, tool);
if (doc == null) {
return null;
}
DOMSource domSource = new DOMSource(doc);
StreamResult streamResult = new StreamResult(new StringWriter());
TransformerFactory tf = TransformerFactory.newInstance();
Transformer serializer;
try {
serializer = tf.newTransformer();
//serializer.setOutputProperty(OutputKeys.INDENT,"yes");
serializer.transform(domSource, streamResult);
} catch (TransformerException e) {
e.printStackTrace();
throw new SerializationException(e.getMessage());
}
return ((StringWriter) streamResult.getWriter()).getBuffer().toString();
}
/**
* Serializes the given PetriNet to PNML and returns the according Document object.
* @param net {@link PetriNet} to serialize
* @return PNML object.
* @throws SerializationException
*/
public static Document serialize(NetSystem net) throws SerializationException {
return serialize(net, DEFAULT);
}
/**
* Serializes the given PetriNet to PNML and returns the according Document object.
*
* @param the PetriNet
* @param tool integer indicating the tool
* @return Document object
*/
public static Document serialize(NetSystem net, int tool) throws SerializationException {
if (net == null) {
return null;
}
DocumentBuilderFactory docBFac = DocumentBuilderFactory.newInstance();
Document doc = null;
try {
DocumentBuilder docBuild = docBFac.newDocumentBuilder();
DOMImplementation impl = docBuild.getDOMImplementation();
doc = impl.createDocument("http://www.pnml.org/version-2009/grammar/pnml", "pnml", null);
} catch (ParserConfigurationException e) {
e.printStackTrace();
throw new SerializationException(e.getMessage());
}
Element root = doc.getDocumentElement();
Element netNode = doc.createElement("net");
root.appendChild(netNode);
if (!net.getId().equals(""))
netNode.setAttribute("id", net.getId());
else
netNode.setAttribute("id", "ptnet");
netNode.setAttribute("type", "http://www.pnml.org/version-2009/grammar/ptnet");
addElementWithText(doc, netNode, "name", net.getName());
Element page = doc.createElement("page");
page.setAttribute("id", "page0");
netNode.appendChild(page);
for (Place place:net.getPlaces()) {
addPlace(doc, page, net, place);
}
for (Transition trans:net.getTransitions()) {
addTransition(doc, page, trans);
}
for (Flow flow:net.getFlow()) {
addFlow(doc, page, flow);
}
if (tool == LOLA)
addFinalMarkings(doc, page, net);
return doc;
}
/**
* Just for convenience. Adds an element with the given tag to the parent and additionally creates
* a child element "text" with the given content.
* @param doc - Document
* @param parent - Element that should contain the newly created element with tag
* @param tag - tag of the element to create
* @param content - text content of the "text" child element of the newly created element
* @return the created element
*/
private static Element addElementWithText(Document doc, Element parent, String tag, String content) {
Element elem = doc.createElement(tag);
Element text = doc.createElement("text");
text.setTextContent(content);
elem.appendChild(text);
parent.appendChild(elem);
return elem;
}
private static void addPlace(Document doc, Element parent, NetSystem net, Place place) {
Element elem = doc.createElement("place");
elem.setAttribute("id", place.getId());
if (!place.getName().equals(""))
addElementWithText(doc, elem, "name", place.getName());
if (net.getTokens(place) > 0) {
addElementWithText(doc, elem, "initialMarking", String.valueOf(net.getTokens(place)));
}
parent.appendChild(elem);
}
private static void addTransition(Document doc, Element parent, Transition trans) {
Element elem = doc.createElement("transition");
elem.setAttribute("id", trans.getId());
if (!trans.getName().equals(""))
addElementWithText(doc, elem, "name", trans.getName());
parent.appendChild(elem);
}
private static void addFlow(Document doc, Element parent, Flow flow) {
Element elem = doc.createElement("arc");
elem.setAttribute("id", flow.getId());
elem.setAttribute("source", flow.getSource().getId());
elem.setAttribute("target", flow.getTarget().getId());
if (!flow.getName().equals(""))
addElementWithText(doc, elem, "name", flow.getName());
parent.appendChild(elem);
}
/**
* Adds some specific information for LoLA about the final markings.
* @param doc
* @param parent
* @param net
*/
private static void addFinalMarkings(Document doc, Element parent, NetSystem net) {
Element finalMarkings = doc.createElement("finalmarkings");
for (Place place:net.getSinkPlaces()) {
Element elem = addElementWithText(doc, finalMarkings, "place", "1");
elem.setAttribute("idref", place.getId());
Element marking = doc.createElement("marking");
marking.appendChild(elem);
finalMarkings.appendChild(marking);
}
parent.appendChild(finalMarkings);
}
}