org.geolatte.geom

Class Box<P extends Position>

java.lang.Object

org.geolatte.geom.Box<P>

public class Box<P extends Position>
extends Object

An multi-dimensional axis-aligned bounding box.

A Box determines a sub characterised by a lower-left and an upper-right coordinate.

An Box is empty if the set of enclosed points are emptym, and has Double.NaN for its lowerleft/upperright coordinates.

Author:

Karel Maesen, Geovise BVBA, 2011

Constructor Summary

Constructors

Constructor and Description
Box(CoordinateReferenceSystem<P> crs) Creates an empty Box
Box(P lowerLeft, P upperRight, CoordinateReferenceSystem<P> crs) Creates an instance from specified lower-left and upper-right Points.

Method Summary

Modifier and Type	Method and Description
<Q extends Position> Box<Q>	as(Class<Q> castToType)
boolean	contains(Box other) Checks whether this Box contains the specifies Box.
boolean	contains(P p) Checks whether this Box contains the specifies Position.
boolean	equals(Object o)
int	getCoordinateDimension()
CoordinateReferenceSystem<P>	getCoordinateReferenceSystem() Returns the CoordinateReferenceSystem for this Box
int	hashCode()
Box<P>	intersect(Box<P> other) Intersects the specified Box with this Box and returns the result.
boolean	intersects(Box<P> other) Checks whether this Box intersects the specifies Box.
boolean	isEmpty() Checks whether this Box is empty.
P	lowerLeft() Returns the lower-left point of this Box.
static <P extends Position> Box<P>	mkEmpty(CoordinateReferenceSystem<P> crs)
String	toString()
Box<P>	union(Box<P> other) Creates an Box that is the set-theoretic union of this Box with the specified Box
P	upperRight() Returns the upper-right point of this Box.
boolean	within(Box<P> other) Checks whether this Box is contained within the specified Box

Methods inherited from class java.lang.Object

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

Constructor Detail

Box

public Box(CoordinateReferenceSystem<P> crs)

Creates an empty Box

Box

public Box(P lowerLeft,
           P upperRight,
           CoordinateReferenceSystem<P> crs)

Creates an instance from specified lower-left and upper-right Points.

Parameters:

lowerLeft - the Point designating the lower-left coordinates

upperRight - the Point designating the upper-right coordinates of the envelope.

Method Detail

getCoordinateReferenceSystem

public CoordinateReferenceSystem<P> getCoordinateReferenceSystem()

Returns the CoordinateReferenceSystem for this Box

Returns:

lowerLeft

public P lowerLeft()

Returns the lower-left point of this Box.

Returns:

the lower-left point

upperRight

public P upperRight()

Returns the upper-right point of this Box.

Returns:

the upper-right point

toString

public String toString()

Overrides:

toString in class Object

union

public Box<P> union(Box<P> other)

Creates an Box that is the set-theoretic union of this Box with the specified Box

Parameters:

other - other Box

Returns:

an Box that encompasses both operands.

Throws:

IllegalArgumentException - when the operand Boxs don't have the same coordinate reference system.

intersect

public Box<P> intersect(Box<P> other)

Intersects the specified Box with this Box and returns the result.

Parameters:

other - the Box to intersect with this instance

Returns:

the set-theoretic intersection of this Box and the specified Box.

Throws:

IllegalArgumentException - when the specified Box doesn't have the same coordinate reference system as this instance.

mkEmpty

public static <P extends Position> Box<P> mkEmpty(CoordinateReferenceSystem<P> crs)

getCoordinateDimension

public int getCoordinateDimension()

isEmpty

public boolean isEmpty()

Checks whether this Box is empty.

Returns:

true iff this instance is empty (the empty set).

within

public boolean within(Box<P> other)

Checks whether this Box is contained within the specified Box

Parameters:

other - the other Box

Returns:

true iff this instance is contained within the specified Box

Throws:

IllegalArgumentException - when the specified Box doesn't have the same coordinate reference system as this instance.

contains

public boolean contains(Box other)

Checks whether this Box contains the specifies Box.

Parameters:

other - the other Box

Returns:

true iff this instance contains the specified Box

Throws:

IllegalArgumentException - when the specified Box doesn't have the same coordinate reference system as this instance.

contains

public boolean contains(P p)

Checks whether this Box contains the specifies Position.

Parameters:

p - the Position

Returns:

true iff this instance contains the specified Position

Throws:

IllegalArgumentException - when the specified Point doesn't have the same coordinate reference system as this instance.

intersects

public boolean intersects(Box<P> other)

Checks whether this Box intersects the specifies Box.

Two instances intersect when their set-theoretic intersection is non-empty.

Parameters:

other - the other Box

Returns:

true iff this instance intersects with the other Box

Throws:

IllegalArgumentException - when the specified Box doesn't have the same coordinate reference system as this instance.

as

public <Q extends Position> Box<Q> as(Class<Q> castToType)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object