org.processmining.framework.models.hlprocess
Interface HighLevelProbabilityDependency

All Known Implementing Classes:
HLProbabilityDependency

public interface HighLevelProbabilityDependency

Represents a probability dependency for an alternative branch as it can be determined, e.g., via some frequency analysis.
Not that in the case that there are dependent choices in the process (i.e., non-free-choice constructs) this kind of dependency may result in unexpected results. Therefore, the usage of some explicit frequency model should be considered.

Author:
arozinat, rmans
See Also:
HighLevelActivity#addFrequencyDependency, HighLevelActivity#getFrequencyDependencies

Method Summary
 boolean equals(java.lang.Object obj)
          Compares the specified object with this HighLevelProbabilityDependency for equality.
 double getProbability()
          Retrieves the probability that has been set for this dependency
 ModelGraphVertex getSourceNode()
          Retrieves the source node of the probability dependency that exists between two nodes
 ModelGraphVertex getTargetNode()
          Retrievs the target node of the probability dependency that exists between two nodes
 int hashCode()
          Returns the hascode for a HighLevelProbabilityDependency object.
 void setProbability(double probability)
          Sets the probability for this dependency (between two nodes)
 void setSourceNode(ModelGraphVertex source)
          Sets the source node for the probability dependency that exists between two nodes
 void setTargetNode(ModelGraphVertex target)
          Sets the target node for the probability dependency that exists between two nodes
 

Method Detail

setProbability

void setProbability(double probability)
Sets the probability for this dependency (between two nodes)

Parameters:
probability - double the probability for this dependency

getProbability

double getProbability()
Retrieves the probability that has been set for this dependency

Returns:
double the probability for this dependency

setSourceNode

void setSourceNode(ModelGraphVertex source)
Sets the source node for the probability dependency that exists between two nodes

Parameters:
source - ModelGraphVertex the source node

getSourceNode

ModelGraphVertex getSourceNode()
Retrieves the source node of the probability dependency that exists between two nodes

Returns:
ModelGraphVertex the source node

setTargetNode

void setTargetNode(ModelGraphVertex target)
Sets the target node for the probability dependency that exists between two nodes

Parameters:
target - ModelGraphVertex the target node

getTargetNode

ModelGraphVertex getTargetNode()
Retrievs the target node of the probability dependency that exists between two nodes

Returns:
ModelGraphVertex the target node

equals

boolean equals(java.lang.Object obj)
Compares the specified object with this HighLevelProbabilityDependency for equality. Returns true if the following aspects of the HighLevelProbabilityDependency that are compared are the same:

Overrides:
equals in class java.lang.Object
Parameters:
obj - Object object to be compared for equality with this HighLevelProbabilityDependency
Returns:
boolean true if the specified object is equal to this HighLevelProbabilityDependency with regard to the source and target node and the probability itself. False otherwise.

hashCode

int hashCode()
Returns the hascode for a HighLevelProbabilityDependency object. The hashcode value for a HighLevelProbabilityDependency object is calculated according to the recipe of Josha Bloch in Effective Java (Addison-Wesley 2001). For this recipe, we have to consider the following items:

Overrides:
hashCode in class java.lang.Object
Returns:
int the hashcode value for this highLevelDataDependency