Class IndexSortSortedNumericDocValuesRangeQuery
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 ClassesModifier and TypeClassDescriptionprivate static class
A doc ID set iterator that wraps a delegate iterator and only returns doc IDs in the range [firstDocInclusive, lastDoc).private static class
Provides aDocIdSetIterator
along with an accurate count of documents provided by the iterator (or-1
if an accurate count is unknown).private static class
private static interface
Compares the given document's value with a stored reference value. -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionIndexSortSortedNumericDocValuesRangeQuery
(String field, long lowerValue, long upperValue, Query fallbackQuery) Creates a newIndexSortSortedNumericDocValuesRangeQuery
. -
Method Summary
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.private static IndexSortSortedNumericDocValuesRangeQuery.ValueAndDoc
findNextValue
(PointValues.PointTree pointTree, byte[] value, boolean allowEqual, ArrayUtil.ByteArrayComparator comparator, boolean lastDoc) Move to the minimum leaf node that has at least one value that is greater than (or equal to ifallowEqual
)value
, and return the next greater value on this block.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.getDocIdSetIteratorOrNullFromBkd
(LeafReaderContext context, DocIdSetIterator delegate) private static SortField.Type
getSortFieldType
(SortField sortField) int
hashCode()
Override and implement query hash code properly in a subclass.private static int
lastDoc
(PointValues.PointTree pointTree, byte[] value, ArrayUtil.ByteArrayComparator comparator) Compute the last doc ID that matches the given value and is stored on a leaf node that compares greater than the current leaf node that the providedPointValues.PointTree
is positioned on.private static IndexSortSortedNumericDocValuesRangeQuery.ValueComparator
loadComparator
(SortField sortField, SortField.Type type, long topValue, LeafReaderContext context) private boolean
matchAll
(PointValues points, byte[] queryLowerPoint, byte[] queryUpperPoint) private boolean
matchNone
(PointValues points, byte[] queryLowerPoint, byte[] queryUpperPoint) private static int
nextDoc
(PointValues.PointTree pointTree, byte[] value, boolean allowEqual, ArrayUtil.ByteArrayComparator comparator, boolean lastDoc) Find the next value that is greater than (or equal to ifallowEqual
) and return either its first doc ID or last doc ID depending onlastDoc
.rewrite
(IndexSearcher indexSearcher) Expert: called to re-write queries into primitive queries.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, rewrite, sameClassAs, toString
-
Field Details
-
field
-
lowerValue
private final long lowerValue -
upperValue
private final long upperValue -
fallbackQuery
-
-
Constructor Details
-
IndexSortSortedNumericDocValuesRangeQuery
public IndexSortSortedNumericDocValuesRangeQuery(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 Details
-
getFallbackQuery
-
equals
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 to those of the other instance. Utility methods are provided for certain repetitive code.
-
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. -
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries. -
toString
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted. -
rewrite
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.The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.
However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.
- Overrides:
rewrite
in classQuery
- Throws:
IOException
- See Also:
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws 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:
IOException
-
findNextValue
private static IndexSortSortedNumericDocValuesRangeQuery.ValueAndDoc findNextValue(PointValues.PointTree pointTree, byte[] value, boolean allowEqual, ArrayUtil.ByteArrayComparator comparator, boolean lastDoc) throws IOException Move to the minimum leaf node that has at least one value that is greater than (or equal to ifallowEqual
)value
, and return the next greater value on this block. Upon returning, thepointTree
must be on the leaf node where the value was found.- Throws:
IOException
-
nextDoc
private static int nextDoc(PointValues.PointTree pointTree, byte[] value, boolean allowEqual, ArrayUtil.ByteArrayComparator comparator, boolean lastDoc) throws IOException Find the next value that is greater than (or equal to ifallowEqual
) and return either its first doc ID or last doc ID depending onlastDoc
. This method returns -1 if there is no greater value in the dataset.- Throws:
IOException
-
lastDoc
private static int lastDoc(PointValues.PointTree pointTree, byte[] value, ArrayUtil.ByteArrayComparator comparator) throws IOException Compute the last doc ID that matches the given value and is stored on a leaf node that compares greater than the current leaf node that the providedPointValues.PointTree
is positioned on. This returns -1 if no other leaf node contains the providedvalue
.- Throws:
IOException
-
matchNone
private boolean matchNone(PointValues points, byte[] queryLowerPoint, byte[] queryUpperPoint) throws IOException - Throws:
IOException
-
matchAll
private boolean matchAll(PointValues points, byte[] queryLowerPoint, byte[] queryUpperPoint) throws IOException - Throws:
IOException
-
getDocIdSetIteratorOrNullFromBkd
private IndexSortSortedNumericDocValuesRangeQuery.IteratorAndCount getDocIdSetIteratorOrNullFromBkd(LeafReaderContext context, DocIdSetIterator delegate) throws IOException - Throws:
IOException
-
getDocIdSetIteratorOrNull
private IndexSortSortedNumericDocValuesRangeQuery.IteratorAndCount getDocIdSetIteratorOrNull(LeafReaderContext context) throws IOException - Throws:
IOException
-
getDocIdSetIterator
private IndexSortSortedNumericDocValuesRangeQuery.IteratorAndCount getDocIdSetIterator(SortField sortField, SortField.Type sortFieldType, LeafReaderContext context, DocIdSetIterator delegate) throws 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:
IOException
-
loadComparator
private static IndexSortSortedNumericDocValuesRangeQuery.ValueComparator loadComparator(SortField sortField, SortField.Type type, long topValue, LeafReaderContext context) throws IOException - Throws:
IOException
-
getSortFieldType
-