Module org.apache.lucene.queries
Class FunctionRangeQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.queries.function.FunctionRangeQuery
A Query wrapping a
ValueSource
that matches docs in which the values in the value source
match a configured range. The score is the float value. This can be a slow query if run by itself
since it must visit all docs; ideally it's combined with other queries. It's mostly a wrapper
around FunctionValues.getRangeScorer(LeafReaderContext, String, String, boolean, boolean)
.
A similar class is org.apache.lucene.search.DocValuesRangeQuery
in the sandbox module.
That one is constant scoring.
- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
private final boolean
private final String
private final String
private final ValueSource
-
Constructor Summary
ConstructorsConstructorDescriptionFunctionRangeQuery
(ValueSource valueSource, Number lowerVal, Number upperVal, boolean includeLower, boolean includeUpper) FunctionRangeQuery
(ValueSource valueSource, String lowerVal, String upperVal, boolean includeLower, boolean includeUpper) -
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 boolean
equalsTo
(FunctionRangeQuery other) int
hashCode()
Override and implement query hash code properly in a subclass.boolean
boolean
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
-
valueSource
-
lowerVal
-
upperVal
-
includeLower
private final boolean includeLower -
includeUpper
private final boolean includeUpper
-
-
Constructor Details
-
FunctionRangeQuery
public FunctionRangeQuery(ValueSource valueSource, Number lowerVal, Number upperVal, boolean includeLower, boolean includeUpper) -
FunctionRangeQuery
public FunctionRangeQuery(ValueSource valueSource, String lowerVal, String upperVal, boolean includeLower, boolean includeUpper)
-
-
Method Details
-
getValueSource
-
getLowerVal
-
getUpperVal
-
isIncludeLower
public boolean isIncludeLower() -
isIncludeUpper
public boolean isIncludeUpper() -
toString
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted. -
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.
-
equalsTo
-
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. -
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
- Parameters:
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-