org.apache.lucene.search

Class DocValuesNumbersQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.DocValuesNumbersQuery

public class DocValuesNumbersQuery
extends Query

Like DocValuesTermsQuery, but this query only runs on a long NumericDocValuesField or a SortedNumericDocValuesField, matching all documents whose value in the specified field is contained in the provided set of long values.

NOTE: be very careful using this query: it is typically much slower than using TermsQuery, but in certain specialized cases may be faster.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	field
private LongHashSet	numbers

Constructor Summary

Constructors

Constructor and Description
DocValuesNumbersQuery(java.lang.String field, java.util.Collection<java.lang.Long> numbers)
DocValuesNumbersQuery(java.lang.String field, java.lang.Long... numbers)
DocValuesNumbersQuery(java.lang.String field, long[] numbers)

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(DocValuesNumbersQuery other)
java.lang.String	getField()
java.util.Set<java.lang.Long>	getNumbers()
int	hashCode() Override and implement query hash code properly in a subclass.
java.lang.String	toString(java.lang.String defaultField) 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

field

private final java.lang.String field

numbers

private final LongHashSet numbers

Constructor Detail

DocValuesNumbersQuery

public DocValuesNumbersQuery(java.lang.String field,
                             long[] numbers)

DocValuesNumbersQuery

public DocValuesNumbersQuery(java.lang.String field,
                             java.util.Collection<java.lang.Long> numbers)

DocValuesNumbersQuery

public DocValuesNumbersQuery(java.lang.String field,
                             java.lang.Long... numbers)

Method Detail

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(DocValuesNumbersQuery 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

getField

public java.lang.String getField()

getNumbers

public java.util.Set<java.lang.Long> getNumbers()

toString

public java.lang.String toString(java.lang.String defaultField)

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

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