org.apache.lucene.queries.function

Class FunctionRangeQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.queries.function.FunctionRangeQuery

public class FunctionRangeQuery
extends Query

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(Weight, 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:

(constant scoring)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	FunctionRangeQuery.FunctionRangeWeight

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	includeLower
private boolean	includeUpper
private java.lang.String	lowerVal
private java.lang.String	upperVal
private ValueSource	valueSource

Constructor Summary

Constructors

Constructor and Description
FunctionRangeQuery(ValueSource valueSource, java.lang.Number lowerVal, java.lang.Number upperVal, boolean includeLower, boolean includeUpper)
FunctionRangeQuery(ValueSource valueSource, java.lang.String lowerVal, java.lang.String upperVal, boolean includeLower, boolean includeUpper)

Method Summary

Modifier and Type	Method and Description
Weight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(java.lang.Object other) Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(FunctionRangeQuery other)
java.lang.String	getLowerVal()
java.lang.String	getUpperVal()
ValueSource	getValueSource()
int	hashCode() Override and implement query hash code properly in a subclass.
boolean	isIncludeLower()
boolean	isIncludeUpper()
java.lang.String	toString(java.lang.String field) Prints a query to a string, with field 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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

valueSource

private final ValueSource valueSource

lowerVal

private final java.lang.String lowerVal

upperVal

private final java.lang.String upperVal

includeLower

private final boolean includeLower

includeUpper

private final boolean includeUpper

Constructor Detail

FunctionRangeQuery

public FunctionRangeQuery(ValueSource valueSource,
                          java.lang.Number lowerVal,
                          java.lang.Number upperVal,
                          boolean includeLower,
                          boolean includeUpper)

FunctionRangeQuery

public FunctionRangeQuery(ValueSource valueSource,
                          java.lang.String lowerVal,
                          java.lang.String upperVal,
                          boolean includeLower,
                          boolean includeUpper)

Method Detail

getValueSource

public ValueSource getValueSource()

getLowerVal

public java.lang.String getLowerVal()

getUpperVal

public java.lang.String getUpperVal()

isIncludeLower

public boolean isIncludeLower()

isIncludeUpper

public boolean isIncludeUpper()

toString

public java.lang.String toString(java.lang.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

equals

public boolean equals(java.lang.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()

equalsTo

private boolean equalsTo(FunctionRangeQuery other)

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)

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries

Overrides:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree

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 class Query

scoreMode - How the produced scorers will be consumed.

boost - The boost that is propagated by the parent queries.

Throws:

java.io.IOException