Module org.apache.lucene.core

Package org.apache.lucene.index

Class ExitableDirectoryReader.ExitableIntersectVisitor

java.lang.Object

org.apache.lucene.index.ExitableDirectoryReader.ExitableIntersectVisitor

All Implemented Interfaces:

PointValues.IntersectVisitor

Enclosing class:

ExitableDirectoryReader

private static class ExitableDirectoryReader.ExitableIntersectVisitor
extends Object
implements PointValues.IntersectVisitor

Field Summary

Fields

Modifier and Type	Field	Description
private int	calls
private PointValues.IntersectVisitor	in
private static final int	MAX_CALLS_BEFORE_QUERY_TIMEOUT_CHECK
private final QueryTimeout	queryTimeout

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExitableIntersectVisitor(QueryTimeout queryTimeout)

Method Summary

Modifier and Type	Method	Description
private void	checkAndThrow()
private void	checkAndThrowWithSampling()	Throws ExitableDirectoryReader.ExitingReaderException if QueryTimeout.shouldExit() returns true, or if Thread.interrupted() returns true.
PointValues.Relation	compare(byte[] minPackedValue, byte[] maxPackedValue)	Called for non-leaf cells to test how the cell relates to the query, to determine how to further recurse down the tree.
void	grow(int count)	Notifies the caller that this many documents are about to be visited
private void	setIntersectVisitor(PointValues.IntersectVisitor in)
void	visit(int docID)	Called for all documents in a leaf cell that's fully contained by the query.
void	visit(int docID, byte[] packedValue)	Called for all documents in a leaf cell that crosses the query.

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.index.PointValues.IntersectVisitor

visit, visit, visit

Field Details

MAX_CALLS_BEFORE_QUERY_TIMEOUT_CHECK

private static final int MAX_CALLS_BEFORE_QUERY_TIMEOUT_CHECK

See Also:

• Constant Field Values

in

private PointValues.IntersectVisitor in

queryTimeout

private final QueryTimeout queryTimeout

calls

private int calls

Constructor Details

ExitableIntersectVisitor

private ExitableIntersectVisitor(QueryTimeout queryTimeout)

Method Details

setIntersectVisitor

private void setIntersectVisitor(PointValues.IntersectVisitor in)

checkAndThrowWithSampling

private void checkAndThrowWithSampling()

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

checkAndThrow

private void checkAndThrow()

visit

public void visit(int docID)
           throws IOException

Description copied from interface: PointValues.IntersectVisitor

Called for all documents in a leaf cell that's fully contained by the query. The consumer should blindly accept the docID.

Specified by:

visit in interface PointValues.IntersectVisitor

Throws:

IOException

visit

public void visit(int docID,
 byte[] packedValue)
           throws IOException

Description copied from interface: PointValues.IntersectVisitor

Called for all documents in a leaf cell that crosses the query. The consumer should scrutinize the packedValue to decide whether to accept it. In the 1D case, values are visited in increasing order, and in the case of ties, in increasing docID order.

Specified by:

visit in interface PointValues.IntersectVisitor

Throws:

IOException

compare

public PointValues.Relation compare(byte[] minPackedValue,
 byte[] maxPackedValue)

Description copied from interface: PointValues.IntersectVisitor

Called for non-leaf cells to test how the cell relates to the query, to determine how to further recurse down the tree.

Specified by:

compare in interface PointValues.IntersectVisitor

grow

public void grow(int count)

Description copied from interface: PointValues.IntersectVisitor

Notifies the caller that this many documents are about to be visited

Specified by:

grow in interface PointValues.IntersectVisitor