All Classes
-
All Classes Interface Summary Class Summary Exception Summary Class Description AbstractPrefixTreeQuery Base class for Lucene Queries on SpatialPrefixTree fields.AbstractVisitingPrefixTreeQuery Traverses aSpatialPrefixTreeindexed field, using the template and visitor design patterns for subclasses to guide the traversal and collect matching documents.AbstractVisitingPrefixTreeQuery.VNode A visitor node/cell found via the query shape forAbstractVisitingPrefixTreeQuery.VisitorTemplate.BBoxOverlapRatioValueSource The algorithm is implemented as envelope on envelope (rect on rect) overlays rather than complex polygon on complex polygon overlays.BBoxSimilarityValueSource A base class for calculating a spatial relevance rank per document from a providedShapeValuesSourcereturning aRectangleper-document.BBoxStrategy A SpatialStrategy for indexing and searching Rectangles by storing its coordinates in numeric fields.BytesRefIteratorTokenStream A TokenStream used internally byPrefixTreeStrategy.CachingDoubleValueSource Caches the doubleVal of another value source in a HashMap so that it is computed only once.Cell Represents a grid cell.CellCanPrune Grid cells that share nothing with other cells when callingCell.getNextLevelCells(Shape)might implement this interface.CellIterator An Iterator of SpatialPrefixTree Cells.CellToBytesRefIterator CompositeSpatialStrategy A compositeSpatialStrategybased onRecursivePrefixTreeStrategy(RPT) andSerializedDVStrategy(SDV).CompositeVerifyQuery A Query that considers an "indexQuery" to have approximate results, and a follow-on ShapeValuesSource is called to verify each hit fromTwoPhaseIterator.matches().ContainsPrefixTreeQuery Finds docs where its indexed shapeCONTAINSthe query shape.DateRangePrefixTree A PrefixTree for date ranges in which the levels of the tree occur at natural periods of time (e.g.DistanceToShapeValueSource The distance from a provided Point to a Point retrieved from an ShapeValuesSource.DistanceValueSource A DoubleValuesSource that returns the distance for aPointVectorStrategy.Geo3dBinaryCodec Geo3d implementation ofBinaryCodecGeo3dCircleShape Specialization of aGeo3dShapewhich represents aCircle.Geo3dDistanceCalculator Geo3d implementation ofDistanceCalculatorGeo3dPointShape Specialization of aGeo3dShapewhich represents aPoint.Geo3dRectangleShape Specialization of aGeo3dShapewhich represents aRectangle.Geo3dShape<T extends GeoAreaShape> A Spatial4j Shape wrapping aGeoAreaShape("Geo3D") -- a 3D planar geometry based Spatial4j Shape implementation.Geo3dShapeFactory Geo3d implementation ofS2ShapeFactoryGeo3dSpatialContextFactory Geo3d implementation ofSpatialContextFactoryGeohashPrefixTree ASpatialPrefixTreebased on Geohashes.GeohashPrefixTree.Factory Factory for creatingGeohashPrefixTreeinstances with useful defaultsHeatmapFacetCounter Computes spatial facets in two dimensions as a grid of numbers.HeatmapFacetCounter.Heatmap Response structureIntersectsPrefixTreeQuery A Query matching documents that have anSpatialRelation.INTERSECTS(i.e.IntersectsRPTVerifyQuery A spatial Intersects predicate that distinguishes an approximated match from an exact match based on which cells are within the query shape.LegacyCell The base for the original two SPT's: Geohash and Quad.NumberRangePrefixTree A SpatialPrefixTree for single-dimensional numbers and number ranges of fixed precision values (not floating point).NumberRangePrefixTree.NRShape Base interface forShapes this prefix tree supports.NumberRangePrefixTree.UnitNRShape A unit value Shape implemented as a stack of numbers, one for each level in the prefix tree.NumberRangePrefixTreeStrategy A PrefixTree based on Number/Date ranges.NumberRangePrefixTreeStrategy.Facets Facet response informationNumberRangePrefixTreeStrategy.Facets.FacetParentVal Holds a block of detailLevel counts aggregated to their parent level.PackedQuadPrefixTree Uses a compact binary representation of 8 bytes to encode a spatial quad trie.PackedQuadPrefixTree.Factory Factory for creatingPackedQuadPrefixTreeinstances with useful defaults.PointPrefixTreeFieldCacheProvider Implementation ofShapeFieldCacheProviderdesigned forPrefixTreeStrategys that index points (AND ONLY POINTS!).PointVectorStrategy SimpleSpatialStrategywhich represents Points in two numeric fields.PrefixTreeFacetCounter Computes facets on cells forPrefixTreeStrategy.PrefixTreeFacetCounter.FacetVisitor A callback/visitor of facet counts.PrefixTreeStrategy An abstract SpatialStrategy based onSpatialPrefixTree.QuadPrefixTree ASpatialPrefixTreewhich uses a quad tree in which an indexed term will be generated for each cell, 'A', 'B', 'C', 'D'.QuadPrefixTree.Factory Factory for creatingQuadPrefixTreeinstances with useful defaultsReciprocalDoubleValuesSource Transforms a DoubleValuesSource using the formula v = k / (v + k)RecursivePrefixTreeStrategy APrefixTreeStrategywhich usesAbstractVisitingPrefixTreeQuery.S2PrefixTree Spatial prefix tree for S2 Geometry.S2PrefixTree.Factory Factory for creatingS2PrefixTreeinstances with useful defaultsS2ShapeFactory Shape factory for Spatial contexts that support S2 geometry.SerializedDVStrategy A SpatialStrategy based on serializing a Shape stored into BinaryDocValues.ShapeAreaValueSource The area of a Shape retrieved from an ShapeValuesSourceShapeFieldCache<T extends org.locationtech.spatial4j.shape.Shape> Bounded Cache of Shapes associated with docIds.ShapeFieldCacheDistanceValueSource A DoubleValuesSource that returns the spatial distance between an input point and a document's points inShapeFieldCacheProvider.ShapeFieldCacheProvider<T extends org.locationtech.spatial4j.shape.Shape> Provides access to aShapeFieldCachefor a givenLeafReader.ShapeValues Iterator overShapeobjects for an index segmentShapeValuesPredicate Compares a shape from a providedShapeValuesSourcewith a given Shape and sees if it matches a givenSpatialOperation(the predicate).ShapeValuesSource ProducesShapeValuesper-segmentSpatialArgs Principally holds the queryShapeand theSpatialOperation.SpatialArgsParser Parses a string that usually looks like "OPERATION(SHAPE)" into aSpatialArgsobject.SpatialOperation A predicate that compares a stored geometry to a supplied geometry.SpatialPrefixTree A spatial Prefix Tree, or Trie, which decomposes shapes into prefixed strings at variable lengths corresponding to variable precision.SpatialPrefixTreeFactory Abstract Factory for creatingSpatialPrefixTreeinstances with useful defaults and passed on configurations defined in a Map.SpatialStrategy The SpatialStrategy encapsulates an approach to indexing and searching based on shapes.TermQueryPrefixTreeStrategy A basic implementation ofPrefixTreeStrategyusing a largeTermInSetQueryof all the cells fromSpatialPrefixTree.getTreeCellIterator(org.locationtech.spatial4j.shape.Shape, int).UnsupportedSpatialOperation Exception thrown when theSpatialStrategycannot implement the requested operation.WithinPrefixTreeQuery Finds docs where its indexed shape isWITHINthe query shape.