Package org.apache.lucene.index

Class ExitableDirectoryReader.ExitablePointValues

java.lang.Object

org.apache.lucene.index.PointValues

org.apache.lucene.index.ExitableDirectoryReader.ExitablePointValues

Enclosing class:

ExitableDirectoryReader

private static class ExitableDirectoryReader.ExitablePointValues
extends PointValues

Wrapper class for another PointValues implementation that is used by ExitableFields.

Nested Class Summary

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

PointValues.IntersectVisitor, PointValues.Relation

Field Summary

Fields

Modifier and Type	Field	Description
private PointValues	in
private QueryTimeout	queryTimeout

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

MAX_DIMENSIONS, MAX_INDEX_DIMENSIONS, MAX_NUM_BYTES

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExitablePointValues(PointValues in, QueryTimeout queryTimeout)

Method Summary

Modifier and Type	Method	Description
private void	checkAndThrow()	Throws ExitableDirectoryReader.ExitingReaderException if QueryTimeout.shouldExit() returns true, or if Thread.interrupted() returns true.
long	estimatePointCount(PointValues.IntersectVisitor visitor)	Estimate the number of points that would be visited by PointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor) with the given PointValues.IntersectVisitor.
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
void	intersect(PointValues.IntersectVisitor visitor)	Finds all documents and points matching the provided visitor.
long	size()	Returns the total number of indexed points across all documents.

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

estimateDocCount, getDocCount, getMaxPackedValue, getMinPackedValue, size

Methods inherited from class java.lang.Object

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

Field Detail

in

private final PointValues in

queryTimeout

private final QueryTimeout queryTimeout

Constructor Detail

ExitablePointValues

private ExitablePointValues(PointValues in,
                            QueryTimeout queryTimeout)

Method Detail

checkAndThrow

private void checkAndThrow()

Throws ExitableDirectoryReader.ExitingReaderException if QueryTimeout.shouldExit() returns true, or if Thread.interrupted() returns true.

intersect

public void intersect(PointValues.IntersectVisitor visitor)
               throws java.io.IOException

Description copied from class: PointValues

Finds all documents and points matching the provided visitor. This method does not enforce live documents, so it's up to the caller to test whether each document is deleted, if necessary.

Specified by:

intersect in class PointValues

Throws:

java.io.IOException

estimatePointCount

public long estimatePointCount(PointValues.IntersectVisitor visitor)

Description copied from class: PointValues

Estimate the number of points that would be visited by PointValues.intersect(org.apache.lucene.index.PointValues.IntersectVisitor) with the given PointValues.IntersectVisitor. This should run many times faster than PointValues.intersect(IntersectVisitor).

Specified by:

estimatePointCount in class PointValues

getMinPackedValue

public byte[] getMinPackedValue()
                         throws java.io.IOException

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

Throws:

java.io.IOException

getMaxPackedValue

public byte[] getMaxPackedValue()
                         throws java.io.IOException

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

Throws:

java.io.IOException

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