GeoComparator

java.lang.Object

org.deltava.comparators.GeoComparator

All Implemented Interfaces:: Serializable, Comparator<GeoLocation>

public class GeoComparator extends Object implements Comparator<GeoLocation>, Serializable

A comparator to sort geographic locations by their distance from a fixed point.

Since:

1.0

Version:

8.6

Author:

Luke

See Also:

Constructor Summary

Constructors

Constructor

Description

GeoComparator(GeoLocation loc)

Creates a new GeoComparator, comparing distance from an arbitrary location.

GeoComparator(GeoLocation loc, boolean useFeet)

Creates a new GeoComparator, comparing distance from an arbitrary location.
Method Summary

Modifier and Type

Method

Description

int

compare(GeoLocation l1, GeoLocation l2)

GeoLocation

getLocation()

Returns the reference location.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Comparator
equals, reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Details
- GeoComparator
  
  public GeoComparator(GeoLocation loc)
  
  Creates a new GeoComparator, comparing distance from an arbitrary location.
  
  Parameters:
  
  loc - the location
- GeoComparator
  
  public GeoComparator(GeoLocation loc, boolean useFeet)
  
  Creates a new GeoComparator, comparing distance from an arbitrary location.
  
  Parameters:
  
  loc - the location
  
  useFeet - TRUE if the calculation should be measured in feet, otherwise FALSE for miles
Method Details
- getLocation
  
  public GeoLocation getLocation()
  
  Returns the reference location.
  
  Returns:
  
  a GeoLocation
- compare
  
  public int compare(GeoLocation l1, GeoLocation l2)
  
  Specified by:
  
  compare in interface Comparator<GeoLocation>