com.isti.util.gis
Class LocationDistance.FoundLocationInfo

java.lang.Object
  extended by com.isti.util.gis.LocationDistance.FoundLocationInfo
All Implemented Interfaces:
java.lang.Comparable
Enclosing class:
LocationDistance

public static class LocationDistance.FoundLocationInfo
extends java.lang.Object
implements java.lang.Comparable

Class FoundLocationInfo references a 'LocationInfoBlk' and contains a distance value.


Field Summary
 double distanceValue
           
 LocationDistance.LocationInfoBlk locationInfoBlkObj
           
 
Constructor Summary
LocationDistance.FoundLocationInfo(LocationDistance.LocationInfoBlk locationInfoBlkObj, double distanceValue)
          Creates an object that references a 'LocationInfoBlk' and contains a distance value.
 
Method Summary
 int compareTo(java.lang.Object obj)
          Compares this object with the specified object for order.
 boolean equals(java.lang.Object obj)
          Returns true if the given object is a 'FoundLocationInfo' whose 'distanceValue' is equal to the 'distanceValue' in this object.
 int hashCode()
          Returns a hash-code value derived from the 'distanceValue' in this object.
 java.lang.String toString()
          Returns a string version of the location and distance information.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

locationInfoBlkObj

public final LocationDistance.LocationInfoBlk locationInfoBlkObj

distanceValue

public double distanceValue
Constructor Detail

LocationDistance.FoundLocationInfo

public LocationDistance.FoundLocationInfo(LocationDistance.LocationInfoBlk locationInfoBlkObj,
                                          double distanceValue)
Creates an object that references a 'LocationInfoBlk' and contains a distance value.

Parameters:
locationInfoBlkObj - the 'LocationInfoBlk' object to reference.
distanceValue - the distance value to use.
Method Detail

compareTo

public int compareTo(java.lang.Object obj)
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The 'distanceValue' field is used for comparison.

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
obj - the Object to be compared.
Returns:
A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Throws:
java.lang.ClassCastException - if the specified object's type prevents it from being compared to this Object.

equals

public boolean equals(java.lang.Object obj)
Returns true if the given object is a 'FoundLocationInfo' whose 'distanceValue' is equal to the 'distanceValue' in this object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the 'FoundLocationInfo' to compare to.
Returns:
true if the given object is a 'FoundLocationInfo' whose 'distanceValue' is equal to the 'distanceValue' in this object; false if not.

hashCode

public int hashCode()
Returns a hash-code value derived from the 'distanceValue' in this object.

Overrides:
hashCode in class java.lang.Object
Returns:
A hash-code value derived from the 'distanceValue' in this object.

toString

public java.lang.String toString()
Returns a string version of the location and distance information.

Overrides:
toString in class java.lang.Object
Returns:
A string version of the location and distance information.