Class IndexSortSortedNumericDocValuesRangeQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.sandbox.search.IndexSortSortedNumericDocValuesRangeQuery
-
public class IndexSortSortedNumericDocValuesRangeQuery extends Query
A range query that can take advantage of the fact that the index is sorted to speed up execution. If the index is sorted on the same field as the query, it performs binary search on the field's numeric doc values to find the documents at the lower and upper ends of the range.This optimized execution strategy is only used if the following conditions hold:
- The index is sorted, and its primary sort is on the same field as the query.
- The query field has either
SortedNumericDocValues
orNumericDocValues
. - The sort field is of type
SortField.Type.LONG
orSortField.Type.INT
. - The segments must have at most one field value per document (otherwise we cannot easily determine the matching document IDs through a binary search).
fallbackQuery
.This fallback must be an equivalent range query -- it should produce the same documents and give constant scores. As an example, an
IndexSortSortedNumericDocValuesRangeQuery
might be constructed as follows:String field = "field"; long lowerValue = 0, long upperValue = 10; Query fallbackQuery = LongPoint.newRangeQuery(field, lowerValue, upperValue); Query rangeQuery = new IndexSortSortedNumericDocValuesRangeQuery( field, lowerValue, upperValue, fallbackQuery);
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
IndexSortSortedNumericDocValuesRangeQuery.BoundedDocIdSetIterator
A doc ID set iterator that wraps a delegate iterator and only returns doc IDs in the range [firstDocInclusive, lastDoc).private static interface
IndexSortSortedNumericDocValuesRangeQuery.ValueComparator
Compares the given document's value with a stored reference value.
-
Field Summary
Fields Modifier and Type Field Description private Query
fallbackQuery
private java.lang.String
field
private long
lowerValue
private long
upperValue
-
Constructor Summary
Constructors Constructor Description IndexSortSortedNumericDocValuesRangeQuery(java.lang.String field, long lowerValue, long upperValue, Query fallbackQuery)
Creates a newIndexSortSortedNumericDocValuesRangeQuery
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Weight
createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
Expert: Constructs an appropriate Weight implementation for this query.boolean
equals(java.lang.Object o)
Override and implement query instance equivalence properly in a subclass.private IndexSortSortedNumericDocValuesRangeQuery.BoundedDocIdSetIterator
getDocIdSetIterator(SortField sortField, SortField.Type sortFieldType, LeafReaderContext context, DocIdSetIterator delegate)
Computes the document IDs that lie within the range [lowerValue, upperValue] by performing binary search on the field's doc values.private IndexSortSortedNumericDocValuesRangeQuery.BoundedDocIdSetIterator
getDocIdSetIteratorOrNull(LeafReaderContext context)
Query
getFallbackQuery()
private static SortField.Type
getSortFieldType(SortField sortField)
int
hashCode()
Override and implement query hash code properly in a subclass.private static IndexSortSortedNumericDocValuesRangeQuery.ValueComparator
loadComparator(SortField sortField, SortField.Type type, long topValue, LeafReaderContext context)
Query
rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.java.lang.String
toString(java.lang.String field)
Prints a query to a string, withfield
assumed to be the default field and omitted.void
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries-
Methods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString
-
-
-
-
Field Detail
-
field
private final java.lang.String field
-
lowerValue
private final long lowerValue
-
upperValue
private final long upperValue
-
fallbackQuery
private final Query fallbackQuery
-
-
Constructor Detail
-
IndexSortSortedNumericDocValuesRangeQuery
public IndexSortSortedNumericDocValuesRangeQuery(java.lang.String field, long lowerValue, long upperValue, Query fallbackQuery)
Creates a newIndexSortSortedNumericDocValuesRangeQuery
.- Parameters:
field
- The field name.lowerValue
- The lower end of the range (inclusive).upperValue
- The upper end of the range (exclusive).fallbackQuery
- A query to fall back to if the optimization cannot be applied.
-
-
Method Detail
-
getFallbackQuery
public Query getFallbackQuery()
-
equals
public boolean equals(java.lang.Object o)
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
works properly.Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical that other instance. Utility methods are provided for certain repetitive code.
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
hashCode
public int hashCode()
Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries
-
toString
public java.lang.String toString(java.lang.String field)
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
rewrite
public Query rewrite(IndexReader reader) throws java.io.IOException
Description copied from class:Query
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.Callers are expected to call
rewrite
multiple times if necessary, until the rewritten query is the same as the original query.- Overrides:
rewrite
in classQuery
- Throws:
java.io.IOException
- See Also:
IndexSearcher.rewrite(Query)
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.IOException
Description copied from class:Query
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeight
in classQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
java.io.IOException
-
getDocIdSetIteratorOrNull
private IndexSortSortedNumericDocValuesRangeQuery.BoundedDocIdSetIterator getDocIdSetIteratorOrNull(LeafReaderContext context) throws java.io.IOException
- Throws:
java.io.IOException
-
getDocIdSetIterator
private IndexSortSortedNumericDocValuesRangeQuery.BoundedDocIdSetIterator getDocIdSetIterator(SortField sortField, SortField.Type sortFieldType, LeafReaderContext context, DocIdSetIterator delegate) throws java.io.IOException
Computes the document IDs that lie within the range [lowerValue, upperValue] by performing binary search on the field's doc values.Because doc values only allow forward iteration, we need to reload the field comparator every time the binary search accesses an earlier element.
We must also account for missing values when performing the binary search. For this reason, we load the
FieldComparator
instead of checking the docvalues directly. The returnedDocIdSetIterator
makes sure to wrap the original docvalues to skip over documents with no value.- Throws:
java.io.IOException
-
loadComparator
private static IndexSortSortedNumericDocValuesRangeQuery.ValueComparator loadComparator(SortField sortField, SortField.Type type, long topValue, LeafReaderContext context) throws java.io.IOException
- Throws:
java.io.IOException
-
getSortFieldType
private static SortField.Type getSortFieldType(SortField sortField)
-
-