Package org.apache.lucene.spatial.query
Class SpatialArgs
java.lang.Object
org.apache.lucene.spatial.query.SpatialArgs
Principally holds the query
Shape
and the SpatialOperation
. It's used as an
argument to some methods on SpatialStrategy
.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
-
Constructor Summary
ConstructorDescriptionSpatialArgs
(SpatialOperation operation, org.locationtech.spatial4j.shape.Shape shape) -
Method Summary
Modifier and TypeMethodDescriptionstatic double
calcDistanceFromErrPct
(org.locationtech.spatial4j.shape.Shape shape, double distErrPct, org.locationtech.spatial4j.context.SpatialContext ctx) Computes the distance given a shape and thedistErrPct
.The acceptable error of the shape.A measure of acceptable error of the shape as a fraction.org.locationtech.spatial4j.shape.Shape
getShape()
double
resolveDistErr
(org.locationtech.spatial4j.context.SpatialContext ctx, double defaultDistErrPct) Gets the error distance that specifies how precise the query shape is.void
setDistErr
(Double distErr) void
setDistErrPct
(Double distErrPct) void
setOperation
(SpatialOperation operation) void
setShape
(org.locationtech.spatial4j.shape.Shape shape) toString()
void
validate()
Check if the arguments make sense -- throw an exception if not
-
Field Details
-
DEFAULT_DISTERRPCT
public static final double DEFAULT_DISTERRPCT- See Also:
-
-
Constructor Details
-
SpatialArgs
-
-
Method Details
-
calcDistanceFromErrPct
public static double calcDistanceFromErrPct(org.locationtech.spatial4j.shape.Shape shape, double distErrPct, org.locationtech.spatial4j.context.SpatialContext ctx) Computes the distance given a shape and thedistErrPct
. The algorithm is the fraction of the distance from the center of the query shape to its closest bounding box corner.- Parameters:
shape
- Mandatory.distErrPct
- 0 to 0.5ctx
- Mandatory- Returns:
- A distance (in degrees).
-
resolveDistErr
public double resolveDistErr(org.locationtech.spatial4j.context.SpatialContext ctx, double defaultDistErrPct) Gets the error distance that specifies how precise the query shape is. This looks atgetDistErr()
,getDistErrPct()
, anddefaultDistErrPct
.- Parameters:
defaultDistErrPct
- 0 to 0.5- Returns:
>= 0
-
validate
Check if the arguments make sense -- throw an exception if not- Throws:
IllegalArgumentException
-
toString
-
getOperation
-
setOperation
-
getShape
public org.locationtech.spatial4j.shape.Shape getShape() -
setShape
public void setShape(org.locationtech.spatial4j.shape.Shape shape) -
getDistErrPct
A measure of acceptable error of the shape as a fraction. This effectively inflates the size of the shape but should not shrink it.- Returns:
- 0 to 0.5
- See Also:
-
setDistErrPct
-
getDistErr
The acceptable error of the shape. This effectively inflates the size of the shape but should not shrink it.- Returns:
>= 0
-
setDistErr
-