Package org.apache.lucene.codecs.simpletext

Class SimpleTextBKDReader

java.lang.Object

org.apache.lucene.index.PointValues

org.apache.lucene.codecs.simpletext.SimpleTextBKDReader

final class SimpleTextBKDReader
extends PointValues

Forked from BKDReader and simplified/specialized for SimpleText's usage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	SimpleTextBKDReader.SimpleTextPointTree

Nested classes/interfaces inherited from class org.apache.lucene.index.PointValues

PointValues.IntersectVisitor, PointValues.PointTree, PointValues.Relation

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	bytesPerIndexEntry
(package private) BKDConfig	config
(package private) int	docCount
(package private) IndexInput	in
(package private) long[]	leafBlockFPs
private int	leafNodeOffset
(package private) byte[]	maxPackedValue
(package private) byte[]	minPackedValue
(package private) long	pointCount
private byte[]	splitPackedValues
(package private) int	version

Fields inherited from class org.apache.lucene.index.PointValues

MAX_DIMENSIONS, MAX_INDEX_DIMENSIONS, MAX_NUM_BYTES

Constructor Summary

Constructors

Constructor	Description
SimpleTextBKDReader(IndexInput in, int numDims, int numIndexDims, int maxPointsInLeafNode, int bytesPerDim, long[] leafBlockFPs, byte[] splitPackedValues, byte[] minPackedValue, byte[] maxPackedValue, long pointCount, int docCount)

Method Summary

Modifier and Type	Method	Description
int	getBytesPerDimension()	Returns the number of bytes per dimension
int	getDocCount()	Returns the total number of documents that have indexed at least one point.
byte[]	getMaxPackedValue()	Returns maximum value for each dimension, packed, or null if PointValues.size(org.apache.lucene.index.IndexReader, java.lang.String) is 0
byte[]	getMinPackedValue()	Returns minimum value for each dimension, packed, or null if PointValues.size(org.apache.lucene.index.IndexReader, java.lang.String) is 0
int	getNumDimensions()	Returns how many dimensions are represented in the values
int	getNumIndexDimensions()	Returns how many dimensions are used for the index
PointValues.PointTree	getPointTree()	Create a new PointValues.PointTree to navigate the index
long	size()	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, size

Methods inherited from class java.lang.Object

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

Field Detail

splitPackedValues

private final byte[] splitPackedValues

leafBlockFPs

final long[] leafBlockFPs

leafNodeOffset

private final int leafNodeOffset

config

final BKDConfig config

bytesPerIndexEntry

final int bytesPerIndexEntry

in

final IndexInput in

minPackedValue

final byte[] minPackedValue

maxPackedValue

final byte[] maxPackedValue

pointCount

final long pointCount

docCount

final int docCount

version

final int version

Constructor Detail

SimpleTextBKDReader

public SimpleTextBKDReader(IndexInput in,
                           int numDims,
                           int numIndexDims,
                           int maxPointsInLeafNode,
                           int bytesPerDim,
                           long[] leafBlockFPs,
                           byte[] splitPackedValues,
                           byte[] minPackedValue,
                           byte[] maxPackedValue,
                           long pointCount,
                           int docCount)

Method Detail

getPointTree

public PointValues.PointTree getPointTree()

Description copied from class: PointValues

Create a new PointValues.PointTree to navigate the index

Specified by:

getPointTree in class PointValues

getMinPackedValue

public byte[] getMinPackedValue()

Description copied from class: PointValues

Returns minimum value for each dimension, packed, or null if PointValues.size(org.apache.lucene.index.IndexReader, java.lang.String) is 0

Specified by:

getMinPackedValue in class PointValues

getMaxPackedValue

public byte[] getMaxPackedValue()

Description copied from class: PointValues

Returns maximum value for each dimension, packed, or null if PointValues.size(org.apache.lucene.index.IndexReader, java.lang.String) is 0

Specified by:

getMaxPackedValue in class PointValues

getNumDimensions

public int getNumDimensions()
                     throws java.io.IOException

Description copied from class: PointValues

Returns how many dimensions are represented in the values

Specified by:

getNumDimensions in class PointValues

Throws:

java.io.IOException

getNumIndexDimensions

public int getNumIndexDimensions()
                          throws java.io.IOException

Description copied from class: PointValues

Returns how many dimensions are used for the index

Specified by:

getNumIndexDimensions in class PointValues

Throws:

java.io.IOException

getBytesPerDimension

public int getBytesPerDimension()
                         throws java.io.IOException

Description copied from class: PointValues

Returns the number of bytes per dimension

Specified by:

getBytesPerDimension in class PointValues

Throws:

java.io.IOException

size

public long size()

Description copied from class: PointValues

Returns the total number of indexed points across all documents.

Specified by:

size in class PointValues

getDocCount

public int getDocCount()

Description copied from class: PointValues

Returns the total number of documents that have indexed at least one point.

Specified by:

getDocCount in class PointValues