Package uk.ac.rdg.resc.edal.geometry

Class BoundingBoxImpl

java.lang.Object

uk.ac.rdg.resc.edal.geometry.AbstractPolygon

uk.ac.rdg.resc.edal.geometry.BoundingBoxImpl

All Implemented Interfaces:

Serializable, Domain<HorizontalPosition>, BoundingBox, Polygon

public final class BoundingBoxImpl
extends AbstractPolygon
implements BoundingBox

Immutable implementation of a BoundingBox.

Author:

Guy Griffiths, Jon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BoundingBoxImpl(double minx, double miny, double maxx, double maxy)	Creates a BoundingBox from the minimum and maximum axis values, with the default CRS
BoundingBoxImpl(double minx, double miny, double maxx, double maxy, org.opengis.referencing.crs.CoordinateReferenceSystem crs)	Creates a BoundingBox from the minimum and maximum axis values
BoundingBoxImpl(org.opengis.metadata.extent.GeographicBoundingBox gbb)	Creates a BoundingBox from an existing GeographicBoundingBox
BoundingBoxImpl(org.opengis.referencing.crs.CoordinateReferenceSystem crs)	Creates a BoundingBox from a CoordinateReferenceSystem, where the bounds are the limits of validity of the CRS
BoundingBoxImpl(Extent<Double> xExtent, Extent<Double> yExtent, org.opengis.referencing.crs.CoordinateReferenceSystem crs)	Creates a BoundingBox from the x- and y- extents

Method Summary

Modifier and Type	Method	Description
boolean	contains(double x, double y)	Provides a more efficient contains() method than the one in AbstractPolygon
boolean	equals(Object obj)
BoundingBox	getBoundingBox()
org.opengis.referencing.crs.CoordinateReferenceSystem	getCoordinateReferenceSystem()	Returns the two-dimensional horizontal coordinate reference system to which the vertices are referenced.
double	getHeight()	Gets the height of the bounding box, i.e.
HorizontalPosition	getLowerCorner()	Gets the position (getMinX(), getMinY())
double	getMaxX()	Gets the maximum ordinate along the first axis, equivalent to getMaximum(0).
double	getMaxY()	Gets the maximum ordinate along the second axis, equivalent to getMaximum(1).
double	getMinX()	Gets the minimum ordinate along the first axis, equivalent to getMinimum(0).
double	getMinY()	Gets the minimum ordinate along the second axis, equivalent to getMinimum(1).
HorizontalPosition	getUpperCorner()	Gets the position (getMaxX(), getMaxY())
List<HorizontalPosition>	getVertices()	Returns a list of vertices in anticlockwise order starting at minx, miny
double	getWidth()	Gets the width of the bounding box, i.e.
static BoundingBoxImpl	global()
int	hashCode()
String	toString()

Methods inherited from class uk.ac.rdg.resc.edal.geometry.AbstractPolygon

contains, getBoundaryPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.rdg.resc.edal.domain.Domain

contains

Constructor Detail

BoundingBoxImpl

public BoundingBoxImpl(double minx,
                       double miny,
                       double maxx,
                       double maxy)

Creates a BoundingBox from the minimum and maximum axis values, with the default CRS

BoundingBoxImpl

public BoundingBoxImpl(double minx,
                       double miny,
                       double maxx,
                       double maxy,
                       org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Creates a BoundingBox from the minimum and maximum axis values

BoundingBoxImpl

public BoundingBoxImpl(Extent<Double> xExtent,
                       Extent<Double> yExtent,
                       org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Creates a BoundingBox from the x- and y- extents

BoundingBoxImpl

public BoundingBoxImpl(org.opengis.metadata.extent.GeographicBoundingBox gbb)

Creates a BoundingBox from an existing GeographicBoundingBox

Parameters:

gbb - The GeographicBoundingBox defining this BoundingBox

BoundingBoxImpl

public BoundingBoxImpl(org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Creates a BoundingBox from a CoordinateReferenceSystem, where the bounds are the limits of validity of the CRS

Parameters:

crs -

Method Detail

global

public static BoundingBoxImpl global()

getCoordinateReferenceSystem

public org.opengis.referencing.crs.CoordinateReferenceSystem getCoordinateReferenceSystem()

Description copied from interface: Polygon

Returns the two-dimensional horizontal coordinate reference system to which the vertices are referenced.

Specified by:

getCoordinateReferenceSystem in interface Polygon

Returns:

the two-dimensional horizontal coordinate reference system to which the vertices are referenced.

getMinX

public double getMinX()

Description copied from interface: BoundingBox

Gets the minimum ordinate along the first axis, equivalent to getMinimum(0).

Specified by:

getMinX in interface BoundingBox

getMaxX

public double getMaxX()

Description copied from interface: BoundingBox

Gets the maximum ordinate along the first axis, equivalent to getMaximum(0).

Specified by:

getMaxX in interface BoundingBox

getMinY

public double getMinY()

Description copied from interface: BoundingBox

Gets the minimum ordinate along the second axis, equivalent to getMinimum(1).

Specified by:

getMinY in interface BoundingBox

getMaxY

public double getMaxY()

Description copied from interface: BoundingBox

Gets the maximum ordinate along the second axis, equivalent to getMaximum(1).

Specified by:

getMaxY in interface BoundingBox

getWidth

public double getWidth()

Description copied from interface: BoundingBox

Gets the width of the bounding box, i.e. getMaxX() - getMinX().

Specified by:

getWidth in interface BoundingBox

getHeight

public double getHeight()

Description copied from interface: BoundingBox

Gets the height of the bounding box, i.e. getMaxY() - getMinY().

Specified by:

getHeight in interface BoundingBox

getLowerCorner

public HorizontalPosition getLowerCorner()

Description copied from interface: BoundingBox

Gets the position (getMinX(), getMinY())

Specified by:

getLowerCorner in interface BoundingBox

getUpperCorner

public HorizontalPosition getUpperCorner()

Description copied from interface: BoundingBox

Gets the position (getMaxX(), getMaxY())

Specified by:

getUpperCorner in interface BoundingBox

toString

public String toString()

Overrides:

toString in class Object

getVertices

public List<HorizontalPosition> getVertices()

Returns a list of vertices in anticlockwise order starting at minx, miny

Specified by:

getVertices in interface Polygon

Returns:

the list of vertices that define this polygon in the horizontal plane.

contains

public boolean contains(double x,
                        double y)

Provides a more efficient contains() method than the one in AbstractPolygon

Overrides:

contains in class AbstractPolygon

getBoundingBox

public BoundingBox getBoundingBox()

Specified by:

getBoundingBox in interface Polygon

Overrides:

getBoundingBox in class AbstractPolygon

Returns:

The MBR of this Polygon

hashCode

public int hashCode()

Specified by:

hashCode in interface BoundingBox

Overrides:

hashCode in class AbstractPolygon

equals

public boolean equals(Object obj)

Specified by:

equals in interface BoundingBox

Overrides:

equals in class AbstractPolygon