Package org.apache.lucene.util.bkd
Class BKDReader
java.lang.Object
org.apache.lucene.index.PointValues
org.apache.lucene.util.bkd.BKDReader
Handles reading a block KD-tree in byte[] space previously written with
BKDWriter.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.index.PointValues
PointValues.IntersectVisitor, PointValues.PointTree, PointValues.Relation -
Field Summary
Fields inherited from class org.apache.lucene.index.PointValues
MAX_DIMENSIONS, MAX_INDEX_DIMENSIONS, MAX_NUM_BYTES -
Constructor Summary
ConstructorsConstructorDescriptionBKDReader(IndexInput metaIn, IndexInput indexIn, IndexInput dataIn) Caller must pre-seek the providedIndexInputto the index location thatBKDWriter.finish(org.apache.lucene.store.IndexOutput, org.apache.lucene.store.IndexOutput, org.apache.lucene.store.IndexOutput)returned. -
Method Summary
Modifier and TypeMethodDescriptionintReturns the number of bytes per dimensionintReturns the total number of documents that have indexed at least one point.byte[]Returns maximum value for each dimension, packed, or null ifPointValues.size(org.apache.lucene.index.IndexReader, java.lang.String)is0byte[]Returns minimum value for each dimension, packed, or null ifPointValues.size(org.apache.lucene.index.IndexReader, java.lang.String)is0intReturns how many dimensions are represented in the valuesintReturns how many dimensions are used for the indexCreate a newPointValues.PointTreeto navigate the indexlongsize()Returns the total number of indexed points across all documents.Methods inherited from class org.apache.lucene.index.PointValues
estimateDocCount, estimatePointCount, getDocCount, getMaxPackedValue, getMinPackedValue, intersect, isEstimatedPointCountGreaterThanOrEqualTo, size
-
Constructor Details
-
BKDReader
Caller must pre-seek the providedIndexInputto the index location thatBKDWriter.finish(org.apache.lucene.store.IndexOutput, org.apache.lucene.store.IndexOutput, org.apache.lucene.store.IndexOutput)returned. BKD tree is always stored off-heap.- Throws:
IOException
-
-
Method Details
-
getPointTree
Description copied from class:PointValuesCreate a newPointValues.PointTreeto navigate the index- Specified by:
getPointTreein classPointValues- Throws:
IOException
-
getMinPackedValue
public byte[] getMinPackedValue()Description copied from class:PointValuesReturns minimum value for each dimension, packed, or null ifPointValues.size(org.apache.lucene.index.IndexReader, java.lang.String)is0- Specified by:
getMinPackedValuein classPointValues
-
getMaxPackedValue
public byte[] getMaxPackedValue()Description copied from class:PointValuesReturns maximum value for each dimension, packed, or null ifPointValues.size(org.apache.lucene.index.IndexReader, java.lang.String)is0- Specified by:
getMaxPackedValuein classPointValues
-
getNumDimensions
Description copied from class:PointValuesReturns how many dimensions are represented in the values- Specified by:
getNumDimensionsin classPointValues- Throws:
IOException
-
getNumIndexDimensions
Description copied from class:PointValuesReturns how many dimensions are used for the index- Specified by:
getNumIndexDimensionsin classPointValues- Throws:
IOException
-
getBytesPerDimension
Description copied from class:PointValuesReturns the number of bytes per dimension- Specified by:
getBytesPerDimensionin classPointValues- Throws:
IOException
-
size
public long size()Description copied from class:PointValuesReturns the total number of indexed points across all documents.- Specified by:
sizein classPointValues
-
getDocCount
public int getDocCount()Description copied from class:PointValuesReturns the total number of documents that have indexed at least one point.- Specified by:
getDocCountin classPointValues
-