org.processmining.analysis.decisionmining
Interface DecisionPointBuilder

All Known Implementing Classes:
DecisionPointBuilderPetriNet

public interface DecisionPointBuilder

Specifies the functionality that should be provided for any process model type in order to be involved in some form of decision point analysis.

Author:
arozinat (a.rozinat@tm.tue.nl)

Method Summary
 java.util.Set getAllPredecessors(DecisionPoint refPoint)
          Retrieves the belonging log events of all preceding tasks with respect to the given decision point.
 DecisionPoint getDecisionPointAt(int index)
          Retrieves the decision point at the given index.
 java.util.List<DecisionPoint> getDecisionPoints()
          Retrieves the list of decision points for this model.
 java.util.Set getDirectPredecessors(DecisionPoint refPoint)
          Retrieves the belonging log events of all directly preceding tasks with respect to the given decision point.
 int getNumberOfDecisionPoints()
          Determines the number of decision points contained in the model.
 

Method Detail

getNumberOfDecisionPoints

int getNumberOfDecisionPoints()
Determines the number of decision points contained in the model.

Returns:
the number of decision points in the model

getDecisionPointAt

DecisionPoint getDecisionPointAt(int index)
Retrieves the decision point at the given index.

Parameters:
index - the specified index value
Returns:
the decision point belonging to the given index if it exists, null otherwise

getDecisionPoints

java.util.List<DecisionPoint> getDecisionPoints()
Retrieves the list of decision points for this model. If no decision points have been determined yet, the list will be built before.

Returns:
a list containing all decision points belonging to this model

getDirectPredecessors

java.util.Set getDirectPredecessors(DecisionPoint refPoint)
Retrieves the belonging log events of all directly preceding tasks with respect to the given decision point. Note that invisible tasks are transparently traced, without being counted as directly adjacent.

Parameters:
refPoint - the decision point for which the preceding tasks are to be found
Returns:
a set of nodes belonging to the directly preceding tasks in the model

getAllPredecessors

java.util.Set getAllPredecessors(DecisionPoint refPoint)
Retrieves the belonging log events of all preceding tasks with respect to the given decision point. Note that invisible tasks do not have a log event associated and are not represented in that list.

Parameters:
refPoint - the decision point for which the preceding tasks are to be found
Returns:
a set of nodes belonging to the preceding tasks in the model