org.processmining.analysis.log.scale
Interface ProcessInstanceScale

All Superinterfaces:
Plugin
All Known Implementing Classes:
ActivityScale, DurationScale, GroupedLogScale, NumberOfEventsScale

public interface ProcessInstanceScale
extends Plugin

This interface specifies a method by which process instances can be 'weighed', i.e. assigned an absolute value of some kind. These weights should infer a total order upon a set of process instances, based on e.g. their runtime, number of events, etc.

Weights are supposed to be interpreted like "the bigger the better", i.e. a process instance that has a higher "value" of some kind should also yield a respectively high weight.

Author:
Christian W. Guenther (christian@deckfour.org)

Method Summary
 double weigh(ProcessInstance anInstance)
          This method assigns a weight on some total scale to a provided process instance.
 
Methods inherited from interface org.processmining.framework.plugin.Plugin
getHtmlDescription, getName
 

Method Detail

weigh

double weigh(ProcessInstance anInstance)
This method assigns a weight on some total scale to a provided process instance. The returned value must always be the same for identical process instances (from the same ProcessInstanceScale implementation).

Parameters:
anInstance - The process instance to be weighed
Returns:
Weight assigned to this process instance by the respective scale implementation. This value should always be >= 0.0.

Weights are supposed to be interpreted like "the bigger the better", i.e. a process instance that has a higher "value" of some kind should also yield a respectively high weight.