org.apache.lucene.geo3d

Class GeoBaseShape

java.lang.Object

org.apache.lucene.geo3d.BasePlanetObject

org.apache.lucene.geo3d.GeoBaseShape

All Implemented Interfaces:

GeoShape, Membership

Direct Known Subclasses:

GeoBaseMembershipShape

public abstract class GeoBaseShape
extends BasePlanetObject
implements GeoShape

Base extended shape object.

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

Field Summary

Fields inherited from class org.apache.lucene.geo3d.BasePlanetObject

planetModel

Constructor Summary

Constructors

Constructor and Description
GeoBaseShape(PlanetModel planetModel) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Bounds	getBounds(Bounds bounds) Compute longitude/latitude bounds for the shape.

Methods inherited from class org.apache.lucene.geo3d.BasePlanetObject

equals, hashCode

Methods inherited from class java.lang.Object

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

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

getEdgePoints, intersects

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

isWithin, isWithin

Constructor Detail

GeoBaseShape

public GeoBaseShape(PlanetModel planetModel)

Constructor.

Parameters:

planetModel - is the planet model to use.

Method Detail

getBounds

public Bounds getBounds(Bounds bounds)

Description copied from interface: GeoShape

Compute longitude/latitude bounds for the shape.

Specified by:

getBounds in interface GeoShape

Parameters:

bounds - is the optional input bounds object. If this is null, a bounds object will be created. Otherwise, the input object will be modified.

Returns:

a Bounds object describing the shape's bounds. If the bounds cannot be computed, then return a Bounds object with noLongitudeBound, noTopLatitudeBound, and noBottomLatitudeBound.