org.apache.lucene.spatial.spatial4j.geo3d

Class GeoBBoxBase

java.lang.Object

org.apache.lucene.spatial.spatial4j.geo3d.GeoBBoxBase

All Implemented Interfaces:

GeoArea, GeoBBox, GeoMembershipShape, GeoShape, GeoSizeable, Membership

Direct Known Subclasses:

GeoDegenerateHorizontalLine, GeoDegenerateLatitudeZone, GeoDegenerateLongitudeSlice, GeoDegenerateVerticalLine, GeoLatitudeZone, GeoLongitudeSlice, GeoNorthLatitudeZone, GeoNorthRectangle, GeoRectangle, GeoSouthLatitudeZone, GeoSouthRectangle, GeoWideDegenerateHorizontalLine, GeoWideLongitudeSlice, GeoWideNorthRectangle, GeoWideRectangle, GeoWideSouthRectangle, GeoWorld

public abstract class GeoBBoxBase
extends Object
implements GeoBBox

All bounding box shapes can derive from this base class, which furnishes some common code

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	ALL_INSIDE
protected static int	NONE_INSIDE
protected static GeoPoint	NORTH_POLE
protected static int	SOME_INSIDE
protected static GeoPoint	SOUTH_POLE

Fields inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.GeoArea

CONTAINS, DISJOINT, OVERLAPS, WITHIN

Constructor Summary

Constructors

Constructor and Description
GeoBBoxBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	isShapeInsideBBox(GeoShape path)
abstract boolean	isWithin(Vector point) Check if a point is within this shape.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.GeoBBox

expand

Methods inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.GeoShape

equals, getBounds, getEdgePoints, intersects

Methods inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.Membership

isWithin

Methods inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.GeoSizeable

getCenter, getRadius

Methods inherited from interface org.apache.lucene.spatial.spatial4j.geo3d.GeoArea

getRelationship

Field Detail

NORTH_POLE

protected static final GeoPoint NORTH_POLE

SOUTH_POLE

protected static final GeoPoint SOUTH_POLE

ALL_INSIDE

protected static final int ALL_INSIDE

See Also:

Constant Field Values

SOME_INSIDE

protected static final int SOME_INSIDE

See Also:

Constant Field Values

NONE_INSIDE

protected static final int NONE_INSIDE

See Also:

Constant Field Values

Constructor Detail

GeoBBoxBase

public GeoBBoxBase()

Method Detail

isWithin

public abstract boolean isWithin(Vector point)

Description copied from interface: Membership

Check if a point is within this shape.

Specified by:

isWithin in interface Membership

Parameters:

point - is the point to check.

Returns:

true if the point is within this shape

isShapeInsideBBox

protected int isShapeInsideBBox(GeoShape path)