Package org.naviqore.utils.spatial

Record Class GeoCoordinate

java.lang.Object
java.lang.Record
org.naviqore.utils.spatial.GeoCoordinate
All Implemented Interfaces:
Comparable<GeoCoordinate>, Coordinate
public record GeoCoordinate(double latitude, double longitude) extends Record implements Coordinate, Comparable<GeoCoordinate>

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.naviqore.utils.spatial.Coordinate

    Coordinate.Axis

  • Constructor Summary

    Constructors
    Constructor
    Description
    GeoCoordinate(double latitude, double longitude)
    Creates an instance of a GeoCoordinate record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(GeoCoordinate other)
     
    double
    distanceTo(double firstComponent, double secondComponent)
    Calculates the distance to another point specified by its components.
    double
    distanceTo(Coordinate other)
    Calculates the distance to another Coordinates object using the Haversine formula.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    getFirstComponent()
    Examples for the first component are latitude or X coordinate.
    double
    getSecondComponent()
    Examples for the first component are longitude or Y coordinate.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    latitude()
    Returns the value of the latitude record component.
    double
    longitude()
    Returns the value of the longitude record component.
    @NotNull String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.naviqore.utils.spatial.Coordinate

    getComponent

  • Constructor Details

    • GeoCoordinate

      public GeoCoordinate(double latitude, double longitude)
      Creates an instance of a GeoCoordinate record class.
      Parameters:
      latitude - the value for the latitude record component
      longitude - the value for the longitude record component

  • Method Details

    • getFirstComponent

      public double getFirstComponent()
      Description copied from interface: Coordinate
      Examples for the first component are latitude or X coordinate.
      Specified by:
      getFirstComponent in interface Coordinate
      Returns:
      the first component of the 2D-coordinate

    • getSecondComponent

      public double getSecondComponent()
      Description copied from interface: Coordinate
      Examples for the first component are longitude or Y coordinate.
      Specified by:
      getSecondComponent in interface Coordinate
      Returns:
      the second component of the 2D-coordinate

    • distanceTo

      public double distanceTo(Coordinate other)
      Calculates the distance to another Coordinates object using the Haversine formula.
      Specified by:
      distanceTo in interface Coordinate
      Parameters:
      other - The other Coordinates object to calculate the distance to.
      Returns:
      The distance in meters.

    • distanceTo

      public double distanceTo(double firstComponent, double secondComponent)
      Description copied from interface: Coordinate
      Calculates the distance to another point specified by its components.
      Specified by:
      distanceTo in interface Coordinate

    • compareTo

      public int compareTo(GeoCoordinate other)
      Specified by:
      compareTo in interface Comparable<GeoCoordinate>

    • toString

      @NotNull public @NotNull String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • latitude

      public double latitude()
      Returns the value of the latitude record component.
      Returns:
      the value of the latitude record component

    • longitude

      public double longitude()
      Returns the value of the longitude record component.
      Returns:
      the value of the longitude record component