- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.SynonymQuery
-
public final class SynonymQuery extends Query
A query that treats multiple terms as synonyms.For scoring purposes, this query tries to score the terms as if you had indexed them as one term: it will match any of the terms but only invoke the similarity a single time, scoring the sum of all term frequencies for the document.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SynonymQuery.Builder
A builder forSynonymQuery
.private static class
SynonymQuery.DisiWrapperFreq
private static class
SynonymQuery.FreqBoostTermScorer
private static class
SynonymQuery.SynonymScorer
(package private) class
SynonymQuery.SynonymWeight
private static class
SynonymQuery.TermAndBoost
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
field
private SynonymQuery.TermAndBoost[]
terms
-
Constructor Summary
Constructors Modifier Constructor Description private
SynonymQuery(SynonymQuery.TermAndBoost[] terms, java.lang.String field)
Creates a new SynonymQuery, matching any of the supplied terms.
-
Method Summary
All Methods Static 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)
Override and implement query instance equivalence properly in a subclass.java.lang.String
getField()
Returns the field name of thisSynonymQuery
java.util.List<Term>
getTerms()
Returns the terms of thisSynonymQuery
int
hashCode()
Override and implement query hash code properly in a subclass.(package private) static ImpactsSource
mergeImpacts(ImpactsEnum[] impactsEnums, float[] boosts)
Merge impacts for multiple synonyms.Query
rewrite(IndexSearcher indexSearcher)
Expert: called to re-write queries into primitive queries.java.lang.String
toString(java.lang.String field)
Prints a query to a string, withfield
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
-
-
-
-
Field Detail
-
terms
private final SynonymQuery.TermAndBoost[] terms
-
field
private final java.lang.String field
-
-
Constructor Detail
-
SynonymQuery
private SynonymQuery(SynonymQuery.TermAndBoost[] terms, java.lang.String field)
Creates a new SynonymQuery, matching any of the supplied terms.The terms must all have the same field.
-
-
Method Detail
-
getTerms
public java.util.List<Term> getTerms()
Returns the terms of thisSynonymQuery
-
getField
public java.lang.String getField()
Returns the field name of thisSynonymQuery
-
toString
public java.lang.String toString(java.lang.String field)
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
hashCode
public int hashCode()
Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
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 thatQueryCache
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 to those of the other instance. Utility methods are provided for certain repetitive code.
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) 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.The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.
However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.
- 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
-
mergeImpacts
static ImpactsSource mergeImpacts(ImpactsEnum[] impactsEnums, float[] boosts)
Merge impacts for multiple synonyms.
-
-