messif.objects.util
Class RankedAbstractObject

java.lang.Object
  extended by messif.objects.util.DistanceRankedObject<AbstractObject>
      extended by messif.objects.util.RankedAbstractObject
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<DistanceRankedObject<?>>, DistanceRanked, Clearable
Direct Known Subclasses:
RankedAbstractMetaObject

public class RankedAbstractObject
extends DistanceRankedObject<AbstractObject>
implements Clearable

Encapsulation of an object-distance pair. This class holds an AbstractObject and its distance. It is used as a return value for all the query operations.

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface messif.objects.util.DistanceRanked
comparator
 
Constructor Summary
RankedAbstractObject(AbstractObject object, float distance)
          Creates a new instance of RankedAbstractObject for an object and its measured distance.
RankedAbstractObject(LocalAbstractObject referenceObject, LocalAbstractObject object)
          Creates a new instance of RankedAbstractObject by measuring an object's distance from the reference object.
 
Method Summary
 void clearSurplusData()
          Clears the data stored in this object.
 
Methods inherited from class messif.objects.util.DistanceRankedObject
clone, compareTo, equals, getDistance, getObject, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RankedAbstractObject

public RankedAbstractObject(AbstractObject object,
                            float distance)
Creates a new instance of RankedAbstractObject for an object and its measured distance.

Parameters:
object - the ranked object
distance - the measured distance of the object

RankedAbstractObject

public RankedAbstractObject(LocalAbstractObject referenceObject,
                            LocalAbstractObject object)
Creates a new instance of RankedAbstractObject by measuring an object's distance from the reference object.

Parameters:
referenceObject - the reference object from which the distance is measured
object - the ranked object
Method Detail

clearSurplusData

public void clearSurplusData()
Description copied from interface: Clearable
Clears the data stored in this object.

Specified by:
clearSurplusData in interface Clearable