org.processmining.analysis.conformance
Class DiagnosticPlace

java.lang.Object
  extended by att.grappa.Element
      extended by att.grappa.Node
          extended by org.processmining.framework.models.ModelGraphVertex
              extended by org.processmining.framework.models.petrinet.PNNode
                  extended by org.processmining.framework.models.petrinet.Place
                      extended by org.processmining.framework.models.petrinet.algorithms.logReplay.ReplayedPlace
                          extended by org.processmining.analysis.conformance.DiagnosticPlace
All Implemented Interfaces:
att.grappa.GrappaConstants, java.lang.Cloneable, java.lang.Comparable

public class DiagnosticPlace
extends ReplayedPlace

The diagnostic place can be enhanced by diagnostic information to be stored during log replay and will be used to form a part of the diagnostic Petri net.

Author:
arozinat

Field Summary
 
Fields inherited from class org.processmining.framework.models.ModelGraphVertex
identifier, object2, value, visualObject
 
Fields inherited from class att.grappa.Node
defaultNamePrefix
 
Fields inherited from class att.grappa.Element
counter, highlight, linewidth, object, printAllAttributes, printDefaultAttributes, usePrintList, visible
 
Fields inherited from interface att.grappa.GrappaConstants
_NO_TYPE, ANONYMOUS_PREFIX, BBOX_ATTR, BBOX_HASH, BOX_SHAPE, BOX_TYPE, CLUSTERRANK_ATTR, COLOR_ATTR, COLOR_HASH, COLOR_TYPE, CUSTOM_ATTR, CUSTOM_HASH, CUSTOM_SHAPE, DELETION_MASK, DIAMOND_SHAPE, DIR_ATTR, DIR_HASH, DIR_TYPE, DISTORTION_ATTR, DISTORTION_HASH, DOUBLE_TYPE, DOUBLECIRCLE_SHAPE, DOUBLEOCTAGON_SHAPE, EDGE, EGG_SHAPE, FILLCOLOR_ATTR, FILLCOLOR_HASH, FONTCOLOR_ATTR, FONTCOLOR_HASH, FONTNAME_ATTR, FONTNAME_HASH, FONTSIZE_ATTR, FONTSIZE_HASH, FONTSTYLE_ATTR, FONTSTYLE_HASH, FONTSTYLE_TYPE, GRAPPA_BACKGROUND_COLOR_ATTR, GRAPPA_BACKGROUND_COLOR_HASH, GRAPPA_DELETION_STYLE_ATTR, GRAPPA_DELETION_STYLE_HASH, GRAPPA_FONTSIZE_ADJUSTMENT_ATTR, GRAPPA_FONTSIZE_ADJUSTMENT_HASH, GRAPPA_SELECTION_STYLE_ATTR, GRAPPA_SELECTION_STYLE_HASH, GRAPPA_SHAPE, HASHLIST_TYPE, HEIGHT_ATTR, HEIGHT_HASH, HEXAGON_SHAPE, HIGHLIGHT_MASK, HIGHLIGHT_OFF, HIGHLIGHT_ON, HIGHLIGHT_TOGGLE, HOUSE_SHAPE, IDENTXFRM, IMAGE_ATTR, IMAGE_HASH, INTEGER_TYPE, INVERTEDHOUSE_SHAPE, INVERTEDTRAPEZIUM_SHAPE, INVERTEDTRIANGLE_SHAPE, LABEL_ATTR, LABEL_HASH, LINE_SHAPE, LINE_TYPE, LOG10, LP_ATTR, LP_HASH, MARGIN_ATTR, MARGIN_HASH, MCIRCLE_SHAPE, MCLIMIT_ATTR, MCLIMIT_HASH, MDIAMOND_SHAPE, MINBOX_ATTR, MINBOX_HASH, MINLEN_ATTR, MINLEN_HASH, MINSIZE_ATTR, MINSIZE_HASH, MRECORD_SHAPE, MSQUARE_SHAPE, NBSP, NEW_LINE, NO_SHAPE, NODE, NODESEP_ATTR, NODESEP_HASH, OCTAGON_SHAPE, ORIENTATION_ATTR, ORIENTATION_HASH, OVAL_SHAPE, PACKAGE_PREFIX, PARALLELOGRAM_SHAPE, PATCH_ATTR, PATCH_HASH, PENTAGON_SHAPE, PERIPHERIES_ATTR, PERIPHERIES_HASH, PERIPHERY_GAP, PKG_LOWER, PKG_UPLOW, PKG_UPPER, PLAINTEXT_SHAPE, POINT_TYPE, PointsPerInch, POLYGON_SHAPE, POS_ATTR, POS_HASH, PRINTLIST_ATTR, PRINTLIST_HASH, RANKDIR_ATTR, RANKDIR_HASH, RANKSEP_ATTR, RANKSEP_HASH, RECORD_SHAPE, RECTS_ATTR, RECTS_HASH, ROTATION_ATTR, ROTATION_HASH, ROUNDEDBOX_SHAPE, SELECTION_MASK, SHAPE_ATTR, SHAPE_HASH, SHAPE_MASK, SHAPE_TYPE, SIDES_ATTR, SIDES_HASH, SIZE_ATTR, SIZE_HASH, SIZE_TYPE, SKEW_ATTR, SKEW_HASH, STRING_TYPE, STYLE_ATTR, STYLE_HASH, STYLE_TYPE, SUBGRAPH, SYSTEM, TAG_ATTR, TAG_HASH, TIP_ATTR, TIP_HASH, TRAPEZIUM_SHAPE, TRIANGLE_SHAPE, TRIPLEOCTAGON_SHAPE, TYPES_SHIFT, WEIGHT_ATTR, WEIGHT_HASH, WIDTH_ATTR, WIDTH_HASH
 
Constructor Summary
DiagnosticPlace(Place p, PetriNet net, java.util.ArrayList caseIDs)
          The constructor creates a normal place but additionally initializes the counter of missing and remaining tokens for every process instance specified.
 
Method Summary
 void addMissingTokens(int value, int similarInstances)
          Increment the corresponding missingTokens entry by the specified value.
 void addNumberInstancesNeitherMissingNorRemaining(int similarInstances)
          Add the given number of process instances to the number of instances where neither tokens were missing nor remaining during log replay.
 void addRemainingTokens(int value, int similarInstances)
          Increment the corresponding remainingTokens entry by the specified value.
 java.lang.Object clone()
          Makes a deep copy of the object.
 java.lang.String getDiagnosticToolTip(DiagnosticPetriNet net)
          Based on the current selection recorded at the DiagnosticPetriNet level, a tool tip containing information about the distribution of missing and remaining tokens with respect to the process instances.
 int getMissingTokens()
          Determine the amount of missing tokens.
 int getMissingTokensOnSemanticLevel()
          Determine the amount of all missing tokens at this Place.
 java.lang.String getOrdinaryToolTip()
          Only displays the name of the transition.
 int getRemainingTokens()
          Determine the amount of remaining tokens.
 int getRemainingTokensOnSemanticLevel()
          Determine the amount of all remaining tokens this Place.
 
Methods inherited from class org.processmining.framework.models.petrinet.algorithms.logReplay.ReplayedPlace
initDiagnosticDataStructures, recordTimeMeasurement, removeEnablingTransition, setEnablingTransition
 
Methods inherited from class org.processmining.framework.models.petrinet.Place
addToken, compareTo, equals, getNumber, getNumberOfTokens, getNumberOfTokens, getRandomAvailableToken, getRandomAvailableToken, hashCode, hasIdentifier, removeAllTokens, removeToken, removeToken, setNumber
 
Methods inherited from class org.processmining.framework.models.ModelGraphVertex
getIdentifier, getIncidentEdges, getInEdgesIterator, getNeighbors, getOutEdgesIterator, getPredecessors, getSuccessors, getValue, getVerticesOnlyPredecessor, getVerticesOnlySuccessor, getVerticesPredecessorAndSuccessor, setIdentifier, setValue, toString
 
Methods inherited from class att.grappa.Node
addEdge, attributeType, edgeElements, findInEdgeByKey, findOutEdgeByKey, getCenterPoint, getInEdges, getOutEdges, getType, inDegree, inEdgeElements, isNode, outDegree, outEdgeElements, printNode, removeEdge
 
Methods inherited from class att.grappa.Element
addTag, attrNotOfInterest, attrOfInterest, bdfs, buildShape, canonString, canonValue, clearBBox, delete, getAttribute, getAttributePairs, getAttributeValue, getDefaultAttribute, getDefaultAttribute, getGraph, getGrappaNexus, getId, getIdKey, getLocalAttribute, getLocalAttributeKeys, getLocalAttributePairs, getName, getSubgraph, getThisAttribute, getThisAttributeValue, hasAttributeForKey, hasDefaultTag, hasDefaultTags, hasLocalTag, hasLocalTags, hasTag, hasTags, isEdge, isOfInterest, isSubgraph, listAttrsOfInterest, printElement, removeTag, removeTags, setAttribute, setAttribute, setDefaultAttribute, setDefaultAttribute, setDefaultAttribute, setDefaultAttribute, setIdKey, setSubgraph, setUserAttributeType, typeString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DiagnosticPlace

public DiagnosticPlace(Place p,
                       PetriNet net,
                       java.util.ArrayList caseIDs)
The constructor creates a normal place but additionally initializes the counter of missing and remaining tokens for every process instance specified.

Parameters:
p - The place (to be passed to super class).
net - The Petri net it belongs to (to be passed to super class).
caseIDs - The list of diagnostic log traces that want to be able to store results of the conformance analysis in this diagnostic place.
Method Detail

addMissingTokens

public void addMissingTokens(int value,
                             int similarInstances)
Increment the corresponding missingTokens entry by the specified value.

Parameters:
value - the value to be added to the current value
the - number of similar instances for the current trace

addRemainingTokens

public void addRemainingTokens(int value,
                               int similarInstances)
Increment the corresponding remainingTokens entry by the specified value.

Parameters:
value - the value to be added to the current value
the - number of similar instances for the current trace

addNumberInstancesNeitherMissingNorRemaining

public void addNumberInstancesNeitherMissingNorRemaining(int similarInstances)
Add the given number of process instances to the number of instances where neither tokens were missing nor remaining during log replay.

Parameters:
similarInstances - number of process instances for this trace

getMissingTokens

public int getMissingTokens()
Determine the amount of missing tokens.

Returns:
the amount of missing tokens in this place

getMissingTokensOnSemanticLevel

public int getMissingTokensOnSemanticLevel()
Determine the amount of all missing tokens at this Place. Note that the number of similar instances subsumed by a logical log trace is not taken into account here, which among others is used for the visual feedback where solely the trace as a logical unit is of interest.

Returns:
The amount of missing tokens in this place

getRemainingTokens

public int getRemainingTokens()
Determine the amount of remaining tokens.

Returns:
the amount of remaining tokens in this place

getRemainingTokensOnSemanticLevel

public int getRemainingTokensOnSemanticLevel()
Determine the amount of all remaining tokens this Place. Note that the number of similar instances subsumed by the logical log trace is not taken into account here, which among others is used for the visual feedback where solely the trace as a logical unit is of interest.

Returns:
The amount of remaining tokens in this place

getDiagnosticToolTip

public java.lang.String getDiagnosticToolTip(DiagnosticPetriNet net)
Based on the current selection recorded at the DiagnosticPetriNet level, a tool tip containing information about the distribution of missing and remaining tokens with respect to the process instances.

Returns:
The string to be displayed

getOrdinaryToolTip

public java.lang.String getOrdinaryToolTip()
Only displays the name of the transition.

Returns:
the name of the transition as string

clone

public java.lang.Object clone()
Makes a deep copy of the object. Note that this method needs to be extended as soon as there are attributes added to the class which are not primitive or immutable.

Overrides:
clone in class Place
Returns:
Object the cloned object