org.apache.lucene.queries

Class TermsQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.queries.TermsQuery

All Implemented Interfaces:

Cloneable, Accountable

public class TermsQuery
extends Query
implements Accountable

Specialization for a disjunction over many terms that behaves like a ConstantScoreQuery over a BooleanQuery containing only BooleanClause.Occur.SHOULD clauses. This query creates a bit set and sets bits that matches any of the wrapped terms. While this might help performance when there are many terms, it would be slower than a BooleanQuery when there are few terms to match.

Constructor Summary

Constructors

Constructor and Description
TermsQuery(List<Term> terms) Creates a new TermsQuery from the given list.
TermsQuery(String field, BytesRef... terms) Creates a new TermsQuery from the given BytesRef array for a single field.
TermsQuery(String field, List<BytesRef> terms) Creates a new TermsQuery from the given BytesRef list for a single field.
TermsQuery(Term... terms) Creates a new TermsQuery from the given array.

Method Summary

Methods

Modifier and Type	Method and Description
Weight	createWeight(IndexSearcher searcher, boolean needsScores)
boolean	equals(Object obj)
Collection<Accountable>	getChildResources()
int	hashCode()
long	ramBytesUsed()
String	toString(String defaultField)

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

clone, extractTerms, getBoost, rewrite, setBoost, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TermsQuery

public TermsQuery(List<Term> terms)

Creates a new TermsQuery from the given list. The list can contain duplicate terms and multiple fields.

TermsQuery

public TermsQuery(String field,
          List<BytesRef> terms)

Creates a new TermsQuery from the given BytesRef list for a single field.

TermsQuery

public TermsQuery(String field,
          BytesRef... terms)

Creates a new TermsQuery from the given BytesRef array for a single field.

TermsQuery

public TermsQuery(Term... terms)

Creates a new TermsQuery from the given array. The array can contain duplicate terms and multiple fields.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query

toString

public String toString(String defaultField)

Specified by:

toString in class Query

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface Accountable

getChildResources

public Collection<Accountable> getChildResources()

Specified by:

getChildResources in interface Accountable

createWeight

public Weight createWeight(IndexSearcher searcher,
                  boolean needsScores)
                    throws IOException

Overrides:

createWeight in class Query

Throws:

IOException