Module org.apache.lucene.core

Package org.apache.lucene.search

Class PointInSetQuery.MergePointVisitor

java.lang.Object

org.apache.lucene.search.PointInSetQuery.MergePointVisitor

All Implemented Interfaces:

PointValues.IntersectVisitor

Enclosing class:

PointInSetQuery

private class PointInSetQuery.MergePointVisitor
extends Object
implements PointValues.IntersectVisitor

Essentially does a merge sort, only collecting hits when the indexed point and query point are the same. This is an optimization, used in the 1D case.

Field Summary

Fields

Modifier and Type	Field	Description
private DocIdSetBuilder.BulkAdder	adder
private final ArrayUtil.ByteArrayComparator	comparator
private PrefixCodedTerms.TermIterator	iterator
private BytesRef	nextQueryPoint
private final DocIdSetBuilder	result
private final PrefixCodedTerms	sortedPackedPoints

Constructor Summary

Constructors

Constructor	Description
MergePointVisitor(PrefixCodedTerms sortedPackedPoints, DocIdSetBuilder result)

Method Summary

Modifier and Type	Method	Description
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 boolean	matches(byte[] packedValue)
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.
void	visit(DocIdSetIterator iterator)	Similar to PointValues.IntersectVisitor.visit(int), but a bulk visit and implementations may have their optimizations.
void	visit(DocIdSetIterator iterator, byte[] packedValue)	Similar to PointValues.IntersectVisitor.visit(int, byte[]) but in this case the packedValue can have more than one docID associated to it.

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

Field Details

result

private final DocIdSetBuilder result

iterator

private PrefixCodedTerms.TermIterator iterator

nextQueryPoint

private BytesRef nextQueryPoint

comparator

private final ArrayUtil.ByteArrayComparator comparator

sortedPackedPoints

private final PrefixCodedTerms sortedPackedPoints

adder

private DocIdSetBuilder.BulkAdder adder

Constructor Details

MergePointVisitor

public MergePointVisitor(PrefixCodedTerms sortedPackedPoints,
 DocIdSetBuilder result)
                  throws IOException

Throws:

IOException

Method Details

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

visit

public void visit(int docID)

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

visit

public void visit(DocIdSetIterator iterator)
           throws IOException

Description copied from interface: PointValues.IntersectVisitor

Similar to PointValues.IntersectVisitor.visit(int), but a bulk visit and implementations may have their optimizations.

Specified by:

visit in interface PointValues.IntersectVisitor

Throws:

IOException

visit

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

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

visit

public void visit(DocIdSetIterator iterator,
 byte[] packedValue)
           throws IOException

Description copied from interface: PointValues.IntersectVisitor

Similar to PointValues.IntersectVisitor.visit(int, byte[]) but in this case the packedValue can have more than one docID associated to it. The provided iterator should not escape the scope of this method so that implementations of PointValues are free to reuse it,

Specified by:

visit in interface PointValues.IntersectVisitor

Throws:

IOException

matches

private boolean matches(byte[] packedValue)

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