ai.nextbillion.kits.geojson

Class BoundingBox

java.lang.Object

ai.nextbillion.kits.geojson.BoundingBox

All Implemented Interfaces:

java.io.Serializable

public class BoundingBox
extends java.lang.Object
implements java.io.Serializable

A GeoJson object MAY have a member named "bbox" to include information on the coordinate range for its Geometries, Features, or FeatureCollections.

This class simplifies the build process for creating a bounding box and working with them when deserialized. specific parameter naming helps define which coordinates belong where when a bounding box instance is being created. Note that since GeoJson objects only have the option of including a bounding box JSON element, the bbox value returned by a GeoJson object might be null.

At a minimum, a bounding box will have two Points or four coordinates which define the box. A 3rd dimensional bounding box can be produced if elevation or altitude is defined.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
double	east() Convenience method for getting the bounding box most easterly point (longitude) as a double coordinate.
boolean	equals(java.lang.Object obj)
static BoundingBox	fromCoordinates(double west, double south, double east, double north) Deprecated. As of 3.1.0, use fromLngLats(double, double, double, double) instead.
static BoundingBox	fromCoordinates(double west, double south, double southwestAltitude, double east, double north, double northEastAltitude) Deprecated. As of 3.1.0, use fromLngLats(double, double, double, double) instead.
static BoundingBox	fromJson(java.lang.String json) Create a new instance of this class by passing in a formatted valid JSON String.
static BoundingBox	fromLngLats(double west, double south, double east, double north) Define a new instance of this class by passing in four coordinates in the same order they would appear in the serialized GeoJson form.
static BoundingBox	fromLngLats(double west, double south, double southwestAltitude, double east, double north, double northEastAltitude) Define a new instance of this class by passing in four coordinates in the same order they would appear in the serialized GeoJson form.
static BoundingBox	fromPoints(Point southwest, Point northeast) Define a new instance of this class by passing in two Points, representing both the southwest and northwest corners of the bounding box.
int	hashCode()
double	north() Convenience method for getting the bounding box most westerly point (longitude) as a double coordinate.
Point	northeast() Provides the Point which represents the northeast corner of this bounding box when the map is facing due north.
double	south() Convenience method for getting the bounding box most southerly point (latitude) as a double coordinate.
Point	southwest() Provides the Point which represents the southwest corner of this bounding box when the map is facing due north.
java.lang.String	toJson() This takes the currently defined values found inside this instance and converts it to a GeoJson string.
java.lang.String	toString()
static com.google.gson.TypeAdapter<BoundingBox>	typeAdapter(com.google.gson.Gson gson) Gson TYPE adapter for parsing Gson to this class.
double	west() Convenience method for getting the bounding box most westerly point (longitude) as a double coordinate.

Methods inherited from class java.lang.Object

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

Method Detail

fromJson

public static BoundingBox fromJson(java.lang.String json)

Create a new instance of this class by passing in a formatted valid JSON String.

Parameters:

json - a formatted valid JSON string defining a Bounding Box

Returns:

a new instance of this class defined by the values passed inside this static factory method

fromPoints

public static BoundingBox fromPoints(@NonNull
                                     Point southwest,
                                     @NonNull
                                     Point northeast)

Define a new instance of this class by passing in two Points, representing both the southwest and northwest corners of the bounding box.

Parameters:

southwest - represents the bottom left corner of the bounding box when the camera is pointing due north

northeast - represents the top right corner of the bounding box when the camera is pointing due north

Returns:

a new instance of this class defined by the provided points

fromCoordinates

@Deprecated
public static BoundingBox fromCoordinates(double west,
                                                      double south,
                                                      double east,
                                                      double north)

Deprecated. As of 3.1.0, use fromLngLats(double, double, double, double) instead.

Define a new instance of this class by passing in four coordinates in the same order they would appear in the serialized GeoJson form. Limits are placed on the minimum and maximum coordinate values which can exist and comply with the GeoJson spec.

Parameters:

west - the left side of the bounding box when the map is facing due north

south - the bottom side of the bounding box when the map is facing due north

east - the right side of the bounding box when the map is facing due north

north - the top side of the bounding box when the map is facing due north

Returns:

a new instance of this class defined by the provided coordinates

fromCoordinates

@Deprecated
public static BoundingBox fromCoordinates(double west,
                                                      double south,
                                                      double southwestAltitude,
                                                      double east,
                                                      double north,
                                                      double northEastAltitude)

Deprecated. As of 3.1.0, use fromLngLats(double, double, double, double) instead.

Define a new instance of this class by passing in four coordinates in the same order they would appear in the serialized GeoJson form. Limits are placed on the minimum and maximum coordinate values which can exist and comply with the GeoJson spec.

Parameters:

west - the left side of the bounding box when the map is facing due north

south - the bottom side of the bounding box when the map is facing due north

southwestAltitude - the southwest corner altitude or elevation when the map is facing due north

east - the right side of the bounding box when the map is facing due north

north - the top side of the bounding box when the map is facing due north

northEastAltitude - the northeast corner altitude or elevation when the map is facing due north

Returns:

a new instance of this class defined by the provided coordinates

fromLngLats

public static BoundingBox fromLngLats(double west,
                                      double south,
                                      double east,
                                      double north)

Define a new instance of this class by passing in four coordinates in the same order they would appear in the serialized GeoJson form. Limits are placed on the minimum and maximum coordinate values which can exist and comply with the GeoJson spec.

Parameters:

west - the left side of the bounding box when the map is facing due north

south - the bottom side of the bounding box when the map is facing due north

east - the right side of the bounding box when the map is facing due north

north - the top side of the bounding box when the map is facing due north

Returns:

a new instance of this class defined by the provided coordinates

fromLngLats

public static BoundingBox fromLngLats(double west,
                                      double south,
                                      double southwestAltitude,
                                      double east,
                                      double north,
                                      double northEastAltitude)

Define a new instance of this class by passing in four coordinates in the same order they would appear in the serialized GeoJson form. Limits are placed on the minimum and maximum coordinate values which can exist and comply with the GeoJson spec.

Parameters:

west - the left side of the bounding box when the map is facing due north

south - the bottom side of the bounding box when the map is facing due north

southwestAltitude - the southwest corner altitude or elevation when the map is facing due north

east - the right side of the bounding box when the map is facing due north

north - the top side of the bounding box when the map is facing due north

northEastAltitude - the northeast corner altitude or elevation when the map is facing due north

Returns:

a new instance of this class defined by the provided coordinates

southwest

@NonNull
public Point southwest()

Provides the Point which represents the southwest corner of this bounding box when the map is facing due north.

Returns:

a Point which defines this bounding boxes southwest corner

northeast

@NonNull
public Point northeast()

Provides the Point which represents the northeast corner of this bounding box when the map is facing due north.

Returns:

a Point which defines this bounding boxes northeast corner

west

public final double west()

Convenience method for getting the bounding box most westerly point (longitude) as a double coordinate.

Returns:

the most westerly coordinate inside this bounding box

south

public final double south()

Convenience method for getting the bounding box most southerly point (latitude) as a double coordinate.

Returns:

the most southerly coordinate inside this bounding box

east

public final double east()

Convenience method for getting the bounding box most easterly point (longitude) as a double coordinate.

Returns:

the most easterly coordinate inside this bounding box

north

public final double north()

Convenience method for getting the bounding box most westerly point (longitude) as a double coordinate.

Returns:

the most westerly coordinate inside this bounding box

typeAdapter

public static com.google.gson.TypeAdapter<BoundingBox> typeAdapter(com.google.gson.Gson gson)

Gson TYPE adapter for parsing Gson to this class.

Parameters:

gson - the built Gson object

Returns:

the TYPE adapter for this class

toJson

public final java.lang.String toJson()

This takes the currently defined values found inside this instance and converts it to a GeoJson string.

Returns:

a JSON string which represents this Bounding box

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object