Package org.apache.lucene.spatial3d.geom
Class GeoBaseDistanceShape
java.lang.Object
org.apache.lucene.spatial3d.geom.BasePlanetObject
org.apache.lucene.spatial3d.geom.GeoBaseShape
org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
org.apache.lucene.spatial3d.geom.GeoBaseDistanceShape
- All Implemented Interfaces:
Bounded
,GeoArea
,GeoAreaShape
,GeoDistance
,GeoDistanceShape
,GeoMembershipShape
,GeoOutsideDistance
,GeoShape
,Membership
,PlanetObject
,SerializableObject
- Direct Known Subclasses:
GeoBaseCircle
,GeoBasePath
Distance shapes have capabilities of both geohashing and distance computation (which also
includes point membership determination).
-
Field Summary
Fields inherited from class org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
ALL_INSIDE, NONE_INSIDE, SOME_INSIDE
Fields inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
planetModel
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondouble
computeDeltaDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute the shape's delta distance given a point.double
computeDeltaDistance
(DistanceStyle distanceStyle, GeoPoint point) Compute the shape's delta distance given a point.double
computeDistance
(DistanceStyle distanceStyle, double x, double y, double z) Compute this shape's internal "distance" to the GeoPoint.double
computeDistance
(DistanceStyle distanceStyle, GeoPoint point) Compute this shape's internal "distance" to the GeoPoint.protected double
deltaDistance
(DistanceStyle distanceStyle, double x, double y, double z) Called by acomputeDeltaDistance
method if X/Y/Z is within this shape.protected abstract double
distance
(DistanceStyle distanceStyle, double x, double y, double z) Called by acomputeDistance
method if X/Y/Z is within this shape.protected abstract void
distanceBounds
(Bounds bounds, DistanceStyle distanceStyle, double distanceValue) Called by agetDistanceBounds
method if distanceValue is not Double.POSITIVE_INFINITY.void
getDistanceBounds
(Bounds bounds, DistanceStyle distanceStyle, double distanceValue) Compute a bound based on a provided distance measure.boolean
Check if a point is within this shape.Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseAreaShape
getRelationship, isGeoAreaShapeInsideShape, isShapeInsideGeoAreaShape
Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseMembershipShape
computeOutsideDistance, computeOutsideDistance, outsideDistance
Methods inherited from class org.apache.lucene.spatial3d.geom.GeoBaseShape
getBounds
Methods inherited from class org.apache.lucene.spatial3d.geom.BasePlanetObject
equals, getPlanetModel, hashCode, write
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.GeoArea
getRelationship
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoAreaShape
intersects
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoOutsideDistance
computeOutsideDistance, computeOutsideDistance
Methods inherited from interface org.apache.lucene.spatial3d.geom.GeoShape
getEdgePoints, intersects
Methods inherited from interface org.apache.lucene.spatial3d.geom.Membership
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
-
GeoBaseDistanceShape
Constructor.- Parameters:
planetModel
- is the planet model to use.
-
-
Method Details
-
isWithin
Description copied from interface:Membership
Check if a point is within this shape.- Specified by:
isWithin
in interfaceMembership
- Overrides:
isWithin
in classGeoBaseMembershipShape
- Parameters:
point
- is the point to check.- Returns:
- true if the point is within this shape
-
computeDistance
Description copied from interface:GeoDistance
Compute this shape's internal "distance" to the GeoPoint. Implementations should clarify how this is computed when it's non-obvious. A return value of Double.POSITIVE_INFINITY should be returned for points outside of the shape.- Specified by:
computeDistance
in interfaceGeoDistance
- Parameters:
distanceStyle
- is the distance style.point
- is the point to compute the distance to.- Returns:
- the distance.
-
computeDistance
Description copied from interface:GeoDistance
Compute this shape's internal "distance" to the GeoPoint. Implementations should clarify how this is computed when it's non-obvious. A return value of Double.POSITIVE_INFINITY should be returned for points outside of the shape.- Specified by:
computeDistance
in interfaceGeoDistance
- 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.
-
distance
Called by acomputeDistance
method if X/Y/Z is within this shape. -
computeDeltaDistance
Description copied from interface:GeoDistance
Compute the shape's delta distance given a point. This is defined as the distance that someone traveling the "length" of the shape would have to go out of their way to include the point. For some shapes, e.g. paths, this makes perfect sense. For other shapes, e.g. circles, the "length" of the shape is zero, and the delta is computed as the distance from the center to the point and back. A return value of Double.POSITIVE_INFINITY should be returned for points outside of the shape.- Specified by:
computeDeltaDistance
in interfaceGeoDistance
- Parameters:
distanceStyle
- is the distance style.point
- is the point to compute the distance to.- Returns:
- the distance.
-
computeDeltaDistance
Description copied from interface:GeoDistance
Compute the shape's delta distance given a point. This is defined as the distance that someone traveling the "length" of the shape would have to go out of their way to include the point. For some shapes, e.g. paths, this makes perfect sense. For other shapes, e.g. circles, the "length" of the shape is zero, and the delta is computed as the distance from the center to the point and back. A return value of Double.POSITIVE_INFINITY should be returned for points outside of the shape.- Specified by:
computeDeltaDistance
in interfaceGeoDistance
- 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.
-
deltaDistance
Called by acomputeDeltaDistance
method if X/Y/Z is within this shape. -
getDistanceBounds
Description copied from interface:GeoDistanceShape
Compute a bound based on a provided distance measure. This method takes an input distance and distance metric and provides bounds on the shape if reduced to match that distance. The method is allowed to return bounds that are larger than the distance would indicate, but never smaller.- Specified by:
getDistanceBounds
in interfaceGeoDistanceShape
- Parameters:
bounds
- is the bounds object to update.distanceStyle
- describes the type of distance metric provided.distanceValue
- is the distance metric to use. It is presumed that the distance metric was produced with the same distance style as is provided to this method.
-
distanceBounds
protected abstract void distanceBounds(Bounds bounds, DistanceStyle distanceStyle, double distanceValue) Called by agetDistanceBounds
method if distanceValue is not Double.POSITIVE_INFINITY.
-