Location (nshmp-haz)

java.lang.Object
- gov.usgs.earthquake.nshmp.geo.Location

All Implemented Interfaces:

Comparable<Location>
```
public final class Location
extends Object
implements Comparable<Location>
```
A Location represents a point with reference to the earth's ellipsoid. It is expressed in terms of latitude, longitude, and depth. As in seismology, the convention adopted in here is for depth to be positive-down, always. Locations may be defined using longitude values in the range: [-180°, 360°]. Location instances are immutable.
Note that although static factory methods take arguments in the order: [lat, lon, depth], String representations of a location are in the order: [lon, lat, depth], consistent with KML, GeoJSON, and other digital coordinate formats that match standard plotting coordinate order: [x, y, z].
For computational convenience, latitude and longitude values are converted and stored internally in radians. Special get***Rad() methods are provided to access this native format.

Author:

Peter Powers

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Location loc)` Compare this `Location` to another and sort first by latitude, then by longitude.
`static Location`	`create(double lat, double lon)` Create a new `Location` with the supplied latitude and longitude and a depth of 0 km.
`static Location`	`create(double lat, double lon, double depth)` Create a new `Location` with the supplied latitude, longitude, and depth.
`double`	`depth()` Returns the depth of this `Location` in km.
`boolean`	`equals(Object obj)`
`static Location`	`fromString(String s)` Generate a new `Location` by parsing the supplied `String`.
`int`	`hashCode()`
`double`	`lat()` The latitude of this `Location` in decimal degrees.
`double`	`latRad()` The latitude of this `Location` in radians.
`double`	`lon()` The longitude of this `Location` in decimal degrees.
`double`	`lonRad()` The longitude of this `Location` in radians.
`static Converter<Location,String>`	`stringConverter()` Return a `Converter` that converts between `Location`s and `String`s.
`String`	`toString()` Return a KML compatible tuple: 'lon,lat,depth' (no spaces).

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

- Method Detail
  - create
```
public static Location create(double lat,
                              double lon)
```
    Create a new Location with the supplied latitude and longitude and a depth of 0 km.
    
    Parameters:
    
    lat - latitude in decimal degrees
    
    lon - longitude in decimal degrees
    
    Throws:
    
    IllegalArgumentException - if any supplied values are out of range
    
    See Also:
    
    Coordinates
  - create
```
public static Location create(double lat,
                              double lon,
                              double depth)
```
    Create a new Location with the supplied latitude, longitude, and depth.
    
    Parameters:
    
    lat - latitude in decimal degrees
    
    lon - longitude in decimal degrees
    
    depth - in km (positive down)
    
    Throws:
    
    IllegalArgumentException - if any supplied values are out of range
    
    See Also:
    
    Coordinates
  - fromString
```
public static Location fromString(String s)
```
    Generate a new Location by parsing the supplied String. Method is intended for use with the result of toString().
    
    Parameters:
    
    s - string to parse
    
    Throws:
    
    NumberFormatException - if s is unparseable
    
    IndexOutOfBoundsException - if s contains fewer than 3 comma-separated values; any additional values in the suppied string are ignored
    
    See Also:
    
    toString(), stringConverter()
  - depth
```
public double depth()
```
    Returns the depth of this Location in km.
  - lat
```
public double lat()
```
    The latitude of this Location in decimal degrees.
  - lon
```
public double lon()
```
    The longitude of this Location in decimal degrees.
  - latRad
```
public double latRad()
```
    The latitude of this Location in radians.
  - lonRad
```
public double lonRad()
```
    The longitude of this Location in radians.
  - toString
```
public String toString()
```
    Return a KML compatible tuple: 'lon,lat,depth' (no spaces).
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    fromString(String), stringConverter()
  - stringConverter
```
public static Converter<Location,String> stringConverter()
```
    Return a Converter that converts between Locations and Strings.
    Calls to converter.reverse().convert(String) will throw a NumberFormatException if the values in the supplied string are unparseable; or an IndexOutOfBoundsException if the supplied string contains fewer than 3 comma-separated values; any additional values in the suppied string are ignored.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Location loc)
```
    Compare this Location to another and sort first by latitude, then by longitude. When sorting a list of Locations, the resultant ordering is left-to-right, bottom-to-top.
    
    Specified by:
    
    compareTo in interface Comparable<Location>
    
    Parameters:
    
    loc - Location to compare this to
    
    Returns:
    
    a negative integer, zero, or a positive integer if this Location is less than, equal to, or greater than the specified Location.

Class Location

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

fromString

depth

lat

lon

latRad

lonRad

toString

stringConverter

equals

hashCode

compareTo