org.processmining.models.workshop

Class WorkshopModel

java.lang.Object

org.processmining.models.workshop.WorkshopModel

All Implemented Interfaces:

org.processmining.framework.util.HTMLToString

public class WorkshopModel
extends java.lang.Object
implements org.processmining.framework.util.HTMLToString

The workshop model. Allows to keep track of direct succession relation with cardinalities.

Author:

hverbeek

Nested Class Summary

Nested classes/interfaces inherited from interface org.processmining.framework.util.HTMLToString

org.processmining.framework.util.HTMLToString.HTMLCellRenderer

Constructor Summary

Constructors

Constructor and Description
WorkshopModel(java.io.InputStream input) Creates a workshop model from the given CSV stream.
WorkshopModel(org.deckfour.xes.classification.XEventClasses eventClasses) Creates an empty workshop model for the given collection of event classes.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDirectSuccession(org.deckfour.xes.classification.XEventClass fromEventClass, org.deckfour.xes.classification.XEventClass toEventClass, int cardinality) Adds as many direct successions from the given source event class to the given target event class as the given cardinality dictates.
void	exportToFile(java.io.File file) Exports a workshop model to a given CSV file.
int	getDirectSuccession(org.deckfour.xes.classification.XEventClass fromEventClass, org.deckfour.xes.classification.XEventClass toEventClass) Gets the cardinality of the direct succession from a given source event class to a given target event class.
java.util.Set<org.deckfour.xes.classification.XEventClass>	getEventClasses() Returns the event classes in the workshop model.
int	getMaxCardinality() Gets the maximal cardinality found in the model.
int	getMinCardinality() Gets the minimal (non-zero) cardinality found in the model.
java.lang.String	toHTMLString(boolean includeHTMLTags) Creates an HTML formatted string from the workshop model.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkshopModel

public WorkshopModel(java.io.InputStream input)
              throws java.io.IOException

Creates a workshop model from the given CSV stream.

Parameters:

input - The given CSV stream. The first row contains the target event classes. The first column contains the source event classes. Other fields contain cardinalities from the source event class to the target event class. If no direct succession relation is there fro the former to the latter, this field should contain 0.

Throws:

java.io.IOException

WorkshopModel

public WorkshopModel(org.deckfour.xes.classification.XEventClasses eventClasses)

Creates an empty workshop model for the given collection of event classes.

Parameters:

eventClasses - The given collection of event classes.

Method Detail

addDirectSuccession

public void addDirectSuccession(org.deckfour.xes.classification.XEventClass fromEventClass,
                       org.deckfour.xes.classification.XEventClass toEventClass,
                       int cardinality)

Adds as many direct successions from the given source event class to the given target event class as the given cardinality dictates.

Parameters:

fromEventClass - The given source event class.

toEventClass - The given target event class.

cardinality - The given cardinality.

getDirectSuccession

public int getDirectSuccession(org.deckfour.xes.classification.XEventClass fromEventClass,
                      org.deckfour.xes.classification.XEventClass toEventClass)

Gets the cardinality of the direct succession from a given source event class to a given target event class.

Parameters:

fromEventClass - The given source event class.

toEventClass - The given target event class.

Returns:

The cardinality of the direct succession relation from the source event class to the target event class. 0 if no direct succession exists.

getEventClasses

public java.util.Set<org.deckfour.xes.classification.XEventClass> getEventClasses()

Returns the event classes in the workshop model.

Returns:

exportToFile

public void exportToFile(java.io.File file)
                  throws java.io.IOException

Exports a workshop model to a given CSV file.

Parameters:

file - The given CSV file.

Throws:

java.io.IOException

toHTMLString

public java.lang.String toHTMLString(boolean includeHTMLTags)

Creates an HTML formatted string from the workshop model. Used for the basic visualization of the workshop model.

Specified by:

toHTMLString in interface org.processmining.framework.util.HTMLToString

Parameters:

includeHTMLTags - Whether to include the and tags.

getMinCardinality

public int getMinCardinality()

Gets the minimal (non-zero) cardinality found in the model.

Returns:

The minimal (non-zero) cardinality found in the model.

getMaxCardinality

public int getMaxCardinality()

Gets the maximal cardinality found in the model.

Returns:

The maximal cardinality found in the model.