public class TermsQuery extends Query implements Accountable
ConstantScoreQuery
over a BooleanQuery
containing only
BooleanClause.Occur.SHOULD
clauses.
For instance in the following example, both @{code q1} and q2
would yield the same scores:
Query q1 = new TermsQuery(new Term("field", "foo"), new Term("field", "bar")); BooleanQuery bq = new BooleanQuery(); bq.add(new TermQuery(new Term("field", "foo")), Occur.SHOULD); bq.add(new TermQuery(new Term("field", "bar")), Occur.SHOULD); Query q2 = new ConstantScoreQuery(bq);
When there are few terms, this query executes like a regular disjunction.
However, when there are many terms, instead of merging iterators on the fly,
it will populate a bit set with matching docs and return a Scorer
over this bit set.
NOTE: This query produces scores that are equal to its boost
Modifier and Type | Class and Description |
---|---|
private static class |
TermsQuery.TermAndState |
private static class |
TermsQuery.WeightOrDocIdSet |
Modifier and Type | Field and Description |
---|---|
private static long |
BASE_RAM_BYTES_USED |
(package private) static int |
BOOLEAN_REWRITE_TERM_COUNT_THRESHOLD |
private boolean |
singleField |
private PrefixCodedTerms |
termData |
private int |
termDataHashCode |
Constructor and Description |
---|
TermsQuery(java.util.Collection<Term> terms)
Creates a new
TermsQuery from the given collection. |
TermsQuery(java.lang.String field,
BytesRef... terms)
Creates a new
TermsQuery from the given BytesRef array for
a single field. |
TermsQuery(java.lang.String field,
java.util.Collection<BytesRef> terms)
Creates a new
TermsQuery from the given collection for
a single field. |
TermsQuery(Term... terms)
Creates a new
TermsQuery from the given array. |
Modifier and Type | Method and Description |
---|---|
Weight |
createWeight(IndexSearcher searcher,
boolean needsScores)
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(TermsQuery other) |
java.util.Collection<Accountable> |
getChildResources()
Returns nested resources of this class.
|
PrefixCodedTerms |
getTermData()
Returns the terms wrapped in a PrefixCodedTerms.
|
int |
hashCode()
Override and implement query hash code properly in a subclass.
|
long |
ramBytesUsed()
Return the memory usage of this object in bytes.
|
Query |
rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.
|
java.lang.String |
toString(java.lang.String defaultField)
Prints a query to a string, with
field assumed to be the
default field and omitted. |
classHash, sameClassAs, toString
private static final long BASE_RAM_BYTES_USED
static final int BOOLEAN_REWRITE_TERM_COUNT_THRESHOLD
private final boolean singleField
private final PrefixCodedTerms termData
private final int termDataHashCode
public TermsQuery(java.util.Collection<Term> terms)
TermsQuery
from the given collection. It
can contain duplicate terms and multiple fields.public TermsQuery(java.lang.String field, java.util.Collection<BytesRef> terms)
TermsQuery
from the given collection for
a single field. It can contain duplicate terms.public TermsQuery(java.lang.String field, BytesRef... terms)
TermsQuery
from the given BytesRef
array for
a single field.public TermsQuery(Term... terms)
TermsQuery
from the given array. The array can
contain duplicate terms and multiple fields.public Query rewrite(IndexReader reader) throws java.io.IOException
Query
public boolean equals(java.lang.Object other)
Query
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.equals
in class Query
Query.sameClassAs(Object)
,
Query.classHash()
private boolean equalsTo(TermsQuery other)
public int hashCode()
Query
QueryCache
works properly.hashCode
in class Query
Query.equals(Object)
public PrefixCodedTerms getTermData()
public java.lang.String toString(java.lang.String defaultField)
Query
field
assumed to be the
default field and omitted.public long ramBytesUsed()
Accountable
ramBytesUsed
in interface Accountable
public java.util.Collection<Accountable> getChildResources()
Accountable
getChildResources
in interface Accountable
Accountables
public Weight createWeight(IndexSearcher searcher, boolean needsScores) throws java.io.IOException
Query
Only implemented by primitive queries, which re-write to themselves.
createWeight
in class Query
needsScores
- True if document scores (Scorer.score()
) or match
frequencies (Scorer.freq()
) are needed.java.io.IOException