Package org.apache.lucene.search
Class MultiPhraseQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.MultiPhraseQuery
-
public class MultiPhraseQuery extends Query
A generalized version ofPhraseQuery
, with the possibility of adding more than one term at the same position that are treated as a disjunction (OR). To use this class to search for the phrase "Microsoft app*" first create a Builder and useMultiPhraseQuery.Builder.add(Term)
on the term "microsoft" (assuming lowercase analysis), then find all terms that have "app" as prefix usingLeafReader.terms(String)
, seeking to "app" then iterating and collecting terms until there is no longer that prefix, and finally useMultiPhraseQuery.Builder.add(Term[])
to add them.MultiPhraseQuery.Builder.build()
returns the fully constructed (and immutable) MultiPhraseQuery.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MultiPhraseQuery.Builder
A builder for multi-phrase queries(package private) static class
MultiPhraseQuery.PostingsAndPosition
static class
MultiPhraseQuery.UnionFullPostingsEnum
Slower version of UnionPostingsEnum that delegates offsets and positions, for use by MatchesIteratorstatic class
MultiPhraseQuery.UnionPostingsEnum
Takes the logical union of multiple PostingsEnum iterators.
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
field
private int[]
positions
private int
slop
private Term[][]
termArrays
-
Constructor Summary
Constructors Modifier Constructor Description private
MultiPhraseQuery(java.lang.String field, Term[][] termArrays, int[] positions, int slop)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Weight
createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
Expert: Constructs an appropriate Weight implementation for this query.boolean
equals(java.lang.Object other)
Returns true ifo
is equal to this.private boolean
equalsTo(MultiPhraseQuery other)
int[]
getPositions()
Returns the relative positions of terms in this phrase.int
getSlop()
Sets the phrase slop for this query.Term[][]
getTermArrays()
Returns the arrays of arrays of terms in the multi-phrase.int
hashCode()
Returns a hash code value for this object.Query
rewrite(IndexReader reader)
Expert: called to re-write queries into primitive queries.private boolean
termArraysEquals(Term[][] termArrays1, Term[][] termArrays2)
private int
termArraysHashCode()
java.lang.String
toString(java.lang.String f)
Prints a user-readable version of this query.void
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries-
Methods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString
-
-
-
-
Field Detail
-
field
private final java.lang.String field
-
termArrays
private final Term[][] termArrays
-
positions
private final int[] positions
-
slop
private final int slop
-
-
Constructor Detail
-
MultiPhraseQuery
private MultiPhraseQuery(java.lang.String field, Term[][] termArrays, int[] positions, int slop)
-
-
Method Detail
-
getSlop
public int getSlop()
Sets the phrase slop for this query.- See Also:
PhraseQuery.getSlop()
-
getTermArrays
public Term[][] getTermArrays()
Returns the arrays of arrays of terms in the multi-phrase. Do not modify!
-
getPositions
public int[] getPositions()
Returns the relative positions of terms in this phrase. Do not modify!
-
rewrite
public Query rewrite(IndexReader reader) throws java.io.IOException
Description copied from class:Query
Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.Callers are expected to call
rewrite
multiple times if necessary, until the rewritten query is the same as the original query.- Overrides:
rewrite
in classQuery
- Throws:
java.io.IOException
- See Also:
IndexSearcher.rewrite(Query)
-
visit
public void visit(QueryVisitor visitor)
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 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 classQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
java.io.IOException
-
toString
public final java.lang.String toString(java.lang.String f)
Prints a user-readable version of this query.
-
equals
public boolean equals(java.lang.Object other)
Returns true ifo
is equal to this.- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
equalsTo
private boolean equalsTo(MultiPhraseQuery other)
-
hashCode
public int hashCode()
Returns a hash code value for this object.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
termArraysHashCode
private int termArraysHashCode()
-
-