edu.ie3.util.geo

Class CoordinateDistance

java.lang.Object

edu.ie3.util.geo.CoordinateDistance

All Implemented Interfaces:

java.lang.Comparable<CoordinateDistance>

public class CoordinateDistance
extends java.lang.Object
implements java.lang.Comparable<CoordinateDistance>

Wraps two coordinates with the distance between the first one and the second one, can be compared by distance to another CoordinateDistance

Constructor Summary

Constructors

Constructor and Description
CoordinateDistance(org.locationtech.jts.geom.Point coordinateA, org.locationtech.jts.geom.Point coordinateB) Calculates the distance from the first to the second coordinate using GeoUtils.calcHaversine(double, double, double, double)

Method Summary

Modifier and Type	Method and Description
int	compareTo(CoordinateDistance that) Compares two coordinate distances on the length of the distance alone, thus having a natural ordering that is inconsistent with equals
boolean	equals(java.lang.Object o)
org.locationtech.jts.geom.Point	getCoordinateA()
org.locationtech.jts.geom.Point	getCoordinateB()
tech.units.indriya.ComparableQuantity<javax.measure.quantity.Length>	getDistance()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CoordinateDistance

public CoordinateDistance(org.locationtech.jts.geom.Point coordinateA,
                          org.locationtech.jts.geom.Point coordinateB)

Calculates the distance from the first to the second coordinate using GeoUtils.calcHaversine(double, double, double, double)

Parameters:

coordinateA - The first coordinate

coordinateB - The second coordinate

Method Detail

getCoordinateA

public org.locationtech.jts.geom.Point getCoordinateA()

Returns:

The first coordinate

getCoordinateB

public org.locationtech.jts.geom.Point getCoordinateB()

Returns:

The second coordinate

getDistance

public tech.units.indriya.ComparableQuantity<javax.measure.quantity.Length> getDistance()

Returns:

The distance from the first coordinate to the second coordinate in km

compareTo

public int compareTo(CoordinateDistance that)

Compares two coordinate distances on the length of the distance alone, thus having a natural ordering that is inconsistent with equals

Specified by:

compareTo in interface java.lang.Comparable<CoordinateDistance>

Parameters:

that - the distance to compare

Returns:

a number lower than 0 if this has a lower distance than that, 0 if they are the same, a number higher than 0 if that has a lower distance

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object