DocValuesRangeQuery (Apache Solr and Lucene - Javadoc and Source (6.4.0))

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.lucene.search.Query
- - org.apache.lucene.search.DocValuesRangeQuery

```
public final class DocValuesRangeQuery
extends Query
```
A range query that works on top of the doc values APIs. Such queries are usually slow since they do not use an inverted index. However, in the dense case where most documents match this query, it might be as fast or faster than a regular PointRangeQuery.
NOTE: be very careful using this query: it is typically much slower than using TermsQuery, but in certain specialized cases may be faster.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Weight`	`createWeight(IndexSearcher searcher, boolean needsScores)` Expert: Constructs an appropriate Weight implementation for this query.
`boolean`	`equals(Object other)` Override and implement query instance equivalence properly in a subclass.
`String`	`getField()`
`Object`	`getLowerVal()`
`Object`	`getUpperVal()`
`int`	`hashCode()` Override and implement query hash code properly in a subclass.
`boolean`	`isIncludeLower()`
`boolean`	`isIncludeUpper()`
`static Query`	`newBytesRefRange(String field, BytesRef lowerVal, BytesRef upperVal, boolean includeLower, boolean includeUpper)` Create a new numeric range query on a numeric doc-values field.
`static Query`	`newLongRange(String field, Long lowerVal, Long upperVal, boolean includeLower, boolean includeUpper)` Create a new numeric range query on a numeric doc-values field.
`Query`	`rewrite(IndexReader reader)` Expert: called to re-write queries into primitive queries.
`String`	`toString(String field)` Prints a query to a string, with `field` assumed to be the default field and omitted.

Methods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - newLongRange
```
public static Query newLongRange(String field,
                                 Long lowerVal,
                                 Long upperVal,
                                 boolean includeLower,
                                 boolean includeUpper)
```
    Create a new numeric range query on a numeric doc-values field. The field must has been indexed with either DocValuesType.NUMERIC or DocValuesType.SORTED_NUMERIC doc values.
  - newBytesRefRange
```
public static Query newBytesRefRange(String field,
                                     BytesRef lowerVal,
                                     BytesRef upperVal,
                                     boolean includeLower,
                                     boolean includeUpper)
```
    Create a new numeric range query on a numeric doc-values field. The field must has been indexed with DocValuesType.SORTED or DocValuesType.SORTED_SET doc values.
  - equals
```
public boolean equals(Object other)
```
    Description copied from class: Query
    
    Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache 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 class Query
    
    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 that QueryCache works properly.
    
    Specified by:
    
    hashCode in class Query
    
    See Also:
    
    Query.equals(Object)
  - getField
```
public String getField()
```
  - getLowerVal
```
public Object getLowerVal()
```
  - getUpperVal
```
public Object getUpperVal()
```
  - isIncludeLower
```
public boolean isIncludeLower()
```
  - isIncludeUpper
```
public boolean isIncludeUpper()
```
  - toString
```
public String toString(String field)
```
    Description copied from class: Query
    
    Prints a query to a string, with field assumed to be the default field and omitted.
    
    Specified by:
    
    toString in class Query
  - rewrite
```
public Query rewrite(IndexReader reader)
              throws 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.
    
    Overrides:
    
    rewrite in class Query
    
    Throws:
    
    IOException
  - createWeight
```
public Weight createWeight(IndexSearcher searcher,
                           boolean needsScores)
                    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 class Query
    
    needsScores - True if document scores (Scorer.score()) or match frequencies (Scorer.freq()) are needed.
    
    Throws:
    
    IOException

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Class DocValuesRangeQuery

Method Summary

Methods inherited from class org.apache.lucene.search.Query

Methods inherited from class java.lang.Object

Method Detail

newLongRange

newBytesRefRange

equals

hashCode

getField

getLowerVal

getUpperVal

isIncludeLower

isIncludeUpper

toString

rewrite

createWeight