io.committed.invest.core.dto.analytic

Class GeoBox

java.lang.Object

io.committed.invest.core.dto.analytic.GeoBox

public class GeoBox
extends Object

A geospatial bounding box.

Defined by n,s,e,w values lat/lon.

Use the getSafe* methods to ensure that values are in range.

Constructor Summary

Constructors

Constructor and Description
GeoBox(Double n, Double e, Double s, Double w)

Method Summary

Modifier and Type	Method and Description
boolean	contains(double lat, double lon) Does the box contain the point (inclusive)
double	getSafeE() Gets a valid value on ES, limited to 180 degrees longitude.
double	getSafeN() Gets a valid value on N, limited to 90 degrees latitude.
double	getSafeS() Gets a valid value on S, limited to -90 degrees latitude.
double	getSafeW() Gets a valid value on W, limited to -180 degrees longitude.
static GeoBox	globe() The entire globe.
GeoBox	intersection(GeoBox geobox) Calculate the intersection this box with another.
boolean	isValid() Checks if is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeoBox

public GeoBox(Double n,
              Double e,
              Double s,
              Double w)

Method Detail

getSafeN

public double getSafeN()

Gets a valid value on N, limited to 90 degrees latitude.

Returns:

northern top of the box

getSafeS

public double getSafeS()

Gets a valid value on S, limited to -90 degrees latitude.

Returns:

southern/bottom of the box

getSafeE

public double getSafeE()

Gets a valid value on ES, limited to 180 degrees longitude.

Returns:

east/right of the box

getSafeW

public double getSafeW()

Gets a valid value on W, limited to -180 degrees longitude.

Returns:

west/left of the box

contains

public boolean contains(double lat,
                        double lon)

Does the box contain the point (inclusive)

Parameters:

lat - the lat

lon - the lon

Returns:

true, if successful

isValid

public boolean isValid()

Checks if is valid.

This means that the raw (constructor provided) values are valid. Note that the output defined by getSafe* will always be safe/valid for use.

Returns:

true, if is valid

intersection

public GeoBox intersection(GeoBox geobox)

Calculate the intersection this box with another.

Parameters:

geobox - the geobox

Returns:

the geo box

globe

public static final GeoBox globe()

The entire globe.

Use for search everywhere.

Returns:

the geobox representing the globe