Module org.apache.lucene.spatial3d

Package org.apache.lucene.spatial3d.geom

Class GeoBaseCompositeMembershipShape<T extends GeoMembershipShape>

java.lang.Object

org.apache.lucene.spatial3d.geom.BasePlanetObject

org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape<T>

org.apache.lucene.spatial3d.geom.GeoBaseCompositeMembershipShape<T>

Type Parameters:

T - is the type of GeoMembershipShapes of the composite.

All Implemented Interfaces:

Bounded, GeoBounds, GeoMembershipShape, GeoOutsideDistance, GeoShape, Membership, PlanetObject, SerializableObject

Direct Known Subclasses:

GeoBaseCompositeAreaShape, GeoCompositeMembershipShape

abstract class GeoBaseCompositeMembershipShape<T extends GeoMembershipShape>
extends GeoBaseCompositeShape<T>
implements GeoMembershipShape

Base class to create a composite of GeoMembershipShapes

Field Summary

Fields inherited from class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape

shapes

Fields inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject

planetModel

Constructor Summary

Constructors

Constructor	Description
GeoBaseCompositeMembershipShape(PlanetModel planetModel)	Constructor.
GeoBaseCompositeMembershipShape(PlanetModel planetModel, InputStream inputStream, Class<T> clazz)	Constructor for deserialization.

Method Summary

Modifier and Type	Method	Description
double	computeOutsideDistance(DistanceStyle distanceStyle, double x, double y, double z)	Compute this shape's distance to the GeoPoint.
double	computeOutsideDistance(DistanceStyle distanceStyle, GeoPoint point)	Compute this shape's distance to the GeoPoint.

Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseCompositeShape

addShape, equals, getBounds, getEdgePoints, getShape, getShapes, hashCode, intersects, isWithin, isWithin, size, write

Methods inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject

getPlanetModel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.spatial3d.geom.Bounded

getBounds

Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoShape

getEdgePoints, intersects

Methods inherited from interface org.apache.lucene.spatial3d.geom.Membership

isWithin, isWithin

Methods inherited from interface org.apache.lucene.spatial3d.geom.PlanetObject

getPlanetModel

Methods inherited from interface org.apache.lucene.spatial3d.geom.SerializableObject

write

Constructor Details

GeoBaseCompositeMembershipShape

GeoBaseCompositeMembershipShape(PlanetModel planetModel)

Constructor.

GeoBaseCompositeMembershipShape

GeoBaseCompositeMembershipShape(PlanetModel planetModel,
 InputStream inputStream,
 Class<T> clazz)
                         throws IOException

Constructor for deserialization.

Parameters:

planetModel - is the planet model.

inputStream - is the input stream.

clazz - is the class of the generic.

Throws:

IOException

Method Details

computeOutsideDistance

public double computeOutsideDistance(DistanceStyle distanceStyle,
 GeoPoint point)

Description copied from interface: GeoOutsideDistance

Compute this shape's distance to the GeoPoint. A return value of 0.0 should be returned for points inside of the shape.

Specified by:

computeOutsideDistance in interface GeoOutsideDistance

Parameters:

distanceStyle - is the distance style.

point - is the point to compute the distance to.

Returns:

the distance.

computeOutsideDistance

public double computeOutsideDistance(DistanceStyle distanceStyle,
 double x,
 double y,
 double z)

Description copied from interface: GeoOutsideDistance

Compute this shape's distance to the GeoPoint. A return value of 0.0 should be returned for points inside of the shape.

Specified by:

computeOutsideDistance in interface GeoOutsideDistance

Parameters:

distanceStyle - is the distance style.

x - is the point's unit x coordinate (using U.S. convention).

y - is the point's unit y coordinate (using U.S. convention).

z - is the point's unit z coordinate (using U.S. convention).

Returns:

the distance.