org.apache.lucene.util.bkd

Class BKDReader

java.lang.Object

org.apache.lucene.util.bkd.BKDReader

All Implemented Interfaces:

Accountable

public class BKDReader
extends Object
implements Accountable

Handles intersection of an multi-dimensional shape in byte[] space with a block KD-tree previously written with BKDWriter.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BKDReader.IntersectState Used to track all state for a single call to intersect(org.apache.lucene.index.PointValues.IntersectVisitor).

Field Summary

Fields

Modifier and Type	Field and Description
protected int	packedBytesLength

Constructor Summary

Constructors

Modifier	Constructor and Description
	BKDReader(IndexInput in) Caller must pre-seek the provided IndexInput to the index location that BKDWriter.finish(org.apache.lucene.store.IndexOutput) returned
protected	BKDReader(IndexInput in, int numDims, int maxPointsInLeafNode, int bytesPerDim, long[] leafBlockFPs, byte[] splitPackedValues, byte[] minPackedValue, byte[] maxPackedValue, long pointCount, int docCount) Called by consumers that have their own on-disk format for the index (e.g.

Method Summary

Modifier and Type	Method and Description
void	copySplitValue(int nodeID, byte[] splitPackedValue) Copies the split value for this node into the provided byte array
int	getBytesPerDimension()
int	getDocCount()
BKDReader.IntersectState	getIntersectState(PointValues.IntersectVisitor visitor) Create a new BKDReader.IntersectState
byte[]	getMaxPackedValue()
byte[]	getMinPackedValue()
int	getNumDimensions()
long	getPointCount()
void	intersect(PointValues.IntersectVisitor visitor)
boolean	isLeafNode(int nodeID)
long	ramBytesUsed() Return the memory usage of this object in bytes.
protected int	readDocIDs(IndexInput in, long blockFP, int[] docIDs)
void	verify(int maxDoc) Only used for debugging, to make sure all values in each leaf block fall within the range expected by the index
protected void	visitDocIDs(IndexInput in, long blockFP, PointValues.IntersectVisitor visitor)
protected void	visitDocValues(int[] commonPrefixLengths, byte[] scratchPackedValue, IndexInput in, int[] docIDs, int count, PointValues.IntersectVisitor visitor)
void	visitLeafBlockValues(int nodeID, BKDReader.IntersectState state) Visits all docIDs and packed values in a single leaf block

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.lucene.util.Accountable

getChildResources

Field Detail

packedBytesLength

protected final int packedBytesLength

Constructor Detail

BKDReader

public BKDReader(IndexInput in)
          throws IOException

Caller must pre-seek the provided IndexInput to the index location that BKDWriter.finish(org.apache.lucene.store.IndexOutput) returned

Throws:

IOException

BKDReader

protected BKDReader(IndexInput in,
                    int numDims,
                    int maxPointsInLeafNode,
                    int bytesPerDim,
                    long[] leafBlockFPs,
                    byte[] splitPackedValues,
                    byte[] minPackedValue,
                    byte[] maxPackedValue,
                    long pointCount,
                    int docCount)
             throws IOException

Called by consumers that have their own on-disk format for the index (e.g. SimpleText)

Throws:

IOException

Method Detail

verify

public void verify(int maxDoc)
            throws IOException

Only used for debugging, to make sure all values in each leaf block fall within the range expected by the index

Throws:

IOException

intersect

public void intersect(PointValues.IntersectVisitor visitor)
               throws IOException

Throws:

IOException

getIntersectState

public BKDReader.IntersectState getIntersectState(PointValues.IntersectVisitor visitor)

Create a new BKDReader.IntersectState

visitLeafBlockValues

public void visitLeafBlockValues(int nodeID,
                                 BKDReader.IntersectState state)
                          throws IOException

Visits all docIDs and packed values in a single leaf block

Throws:

IOException

visitDocIDs

protected void visitDocIDs(IndexInput in,
                           long blockFP,
                           PointValues.IntersectVisitor visitor)
                    throws IOException

Throws:

IOException

readDocIDs

protected int readDocIDs(IndexInput in,
                         long blockFP,
                         int[] docIDs)
                  throws IOException

Throws:

IOException

visitDocValues

protected void visitDocValues(int[] commonPrefixLengths,
                              byte[] scratchPackedValue,
                              IndexInput in,
                              int[] docIDs,
                              int count,
                              PointValues.IntersectVisitor visitor)
                       throws IOException

Throws:

IOException

copySplitValue

public void copySplitValue(int nodeID,
                           byte[] splitPackedValue)

Copies the split value for this node into the provided byte array

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

getMinPackedValue

public byte[] getMinPackedValue()

getMaxPackedValue

public byte[] getMaxPackedValue()

getNumDimensions

public int getNumDimensions()

getBytesPerDimension

public int getBytesPerDimension()

getPointCount

public long getPointCount()

getDocCount

public int getDocCount()

isLeafNode

public boolean isLeafNode(int nodeID)