- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.sandbox.search.MultiRangeQuery
-
- All Implemented Interfaces:
java.lang.Cloneable
public abstract class MultiRangeQuery extends Query implements java.lang.Cloneable
Abstract class for range queries involving multiple ranges against physical points such asIntPoints
All ranges are logically ORed together
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MultiRangeQuery.Builder
A builder for multirange queries.private static interface
MultiRangeQuery.Range
A range represents anything with a min/max value that can compute its relation with another range and can compute if a point is inside itstatic class
MultiRangeQuery.RangeClause
Representation of a single clause in a MultiRangeQueryprivate static class
MultiRangeQuery.RangeTree
An interval tree of Ranges for speeding up computationsprivate static interface
MultiRangeQuery.Relatable
Represents a range that can compute its relation with another range and can compute if a point is inside it
-
Field Summary
Fields Modifier and Type Field Description (package private) int
bytesPerDim
(package private) java.lang.String
field
(package private) int
numDims
(package private) java.util.List<MultiRangeQuery.RangeClause>
rangeClauses
-
Constructor Summary
Constructors Modifier Constructor Description protected
MultiRangeQuery(java.lang.String field, int numDims, int bytesPerDim, java.util.List<MultiRangeQuery.RangeClause> rangeClauses)
Expert: create a multidimensional range query with multiple connected ranges
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description (package private) static MultiRangeQuery.RangeTree
createTree(java.util.List<MultiRangeQuery.RangeClause> clauses, int numIndexDim, int bytesPerDim, ArrayUtil.ByteArrayComparator comparator)
Creates a tree from provided clausesprivate static MultiRangeQuery.RangeTree
createTree(MultiRangeQuery.Range[] components, int low, int high, int split, int numIndexDim, int bytesPerDim, ArrayUtil.ByteArrayComparator comparator)
Creates tree from sorted ranges (with range low and high inclusive)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 boolean
equalsTo(MultiRangeQuery other)
int
getBytesPerDim()
java.lang.String
getField()
int
getNumDims()
private static MultiRangeQuery.Range
getRange(MultiRangeQuery.RangeClause clause, int numIndexDim, int bytesPerDim, ArrayUtil.ByteArrayComparator comparator)
Builds a Range object from a range clauseint
hashCode()
Override and implement query hash code properly in a subclass.(package private) static java.util.List<MultiRangeQuery.RangeClause>
mergeOverlappingRanges(java.util.List<MultiRangeQuery.RangeClause> rangeClauses, int bytesPerDim)
Merges overlapping ranges and returns unconnected rangesQuery
rewrite(IndexSearcher indexSearcher)
Merges the overlapping ranges and returns unconnected ranges by callingmergeOverlappingRanges(java.util.List<org.apache.lucene.sandbox.search.MultiRangeQuery.RangeClause>, int)
protected abstract java.lang.String
toString(int dimension, byte[] value)
Returns a string of a single value in a human-readable format for debugging.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, rewrite, sameClassAs, toString
-
-
-
-
Field Detail
-
field
final java.lang.String field
-
numDims
final int numDims
-
bytesPerDim
final int bytesPerDim
-
rangeClauses
java.util.List<MultiRangeQuery.RangeClause> rangeClauses
-
-
Constructor Detail
-
MultiRangeQuery
protected MultiRangeQuery(java.lang.String field, int numDims, int bytesPerDim, java.util.List<MultiRangeQuery.RangeClause> rangeClauses)
Expert: create a multidimensional range query with multiple connected ranges- Parameters:
field
- field name. must not benull
.rangeClauses
- Range Clauses for this querynumDims
- number of dimensions.
-
-
Method Detail
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries.
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws java.io.IOException
Merges the overlapping ranges and returns unconnected ranges by callingmergeOverlappingRanges(java.util.List<org.apache.lucene.sandbox.search.MultiRangeQuery.RangeClause>, int)
- Overrides:
rewrite
in classQuery
- Throws:
java.io.IOException
- See Also:
IndexSearcher.rewrite(Query)
-
mergeOverlappingRanges
static java.util.List<MultiRangeQuery.RangeClause> mergeOverlappingRanges(java.util.List<MultiRangeQuery.RangeClause> rangeClauses, int bytesPerDim)
Merges overlapping ranges and returns unconnected ranges- Parameters:
rangeClauses
- some overlapping rangesbytesPerDim
- bytes per Dimension of the point value- Returns:
- unconnected ranges
-
createWeight
public final 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
-
getField
public java.lang.String getField()
-
getNumDims
public int getNumDims()
-
getBytesPerDim
public int getBytesPerDim()
-
hashCode
public final 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)
-
equals
public final 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 to those of the other instance. Utility methods are provided for certain repetitive code.
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
equalsTo
private boolean equalsTo(MultiRangeQuery other)
-
toString
public final 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.
-
toString
protected abstract java.lang.String toString(int dimension, byte[] value)
Returns a string of a single value in a human-readable format for debugging. This is used byQuery.toString()
.- Parameters:
dimension
- dimension of the particular valuevalue
- single value, never null- Returns:
- human readable value for debugging
-
createTree
static MultiRangeQuery.RangeTree createTree(java.util.List<MultiRangeQuery.RangeClause> clauses, int numIndexDim, int bytesPerDim, ArrayUtil.ByteArrayComparator comparator)
Creates a tree from provided clauses
-
createTree
private static MultiRangeQuery.RangeTree createTree(MultiRangeQuery.Range[] components, int low, int high, int split, int numIndexDim, int bytesPerDim, ArrayUtil.ByteArrayComparator comparator)
Creates tree from sorted ranges (with range low and high inclusive)
-
getRange
private static MultiRangeQuery.Range getRange(MultiRangeQuery.RangeClause clause, int numIndexDim, int bytesPerDim, ArrayUtil.ByteArrayComparator comparator)
Builds a Range object from a range clause
-
-