edu.cmu.hcii.calo.model.sorting.KeyFunctor< E > Class Reference

List of all members.

Detailed Description

Represents a functor (an object that is used as a function) that returns a sort key given an object of the type being sorted in a MutableSortedSet.

Author:
Brian Ellis


Public Member Functions

abstract double getKey (E item)
 Should be implemented to return a sort key (as a double) based on the given item's data.


Member Function Documentation

abstract double edu.cmu.hcii.calo.model.sorting.KeyFunctor< E >.getKey ( item  )  [pure virtual]

Should be implemented to return a sort key (as a double) based on the given item's data.

Note that unlike a compareTo method, this should not return a sort ordering, but rather a key by which this object will be sorted. Specifically, the set will be sorted in order from highest sort key to lowest.

Parameters:
item the item to generate a key for
Returns:
the key, as a double


The documentation for this class was generated from the following file:
Generated on Mon Aug 13 15:06:18 2007 for CALO by  doxygen 1.5.2