java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.SynonymQuery
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 ClassesModifier and TypeClassDescriptionstatic class
A builder forSynonymQuery
.private static class
private static class
private static class
(package private) class
private static class
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
SynonymQuery
(SynonymQuery.TermAndBoost[] terms, String field) Creates a new SynonymQuery, matching any of the supplied terms. -
Method Summary
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.getTerms()
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.rewrite
(IndexReader reader) Expert: called to re-write queries into primitive queries.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 queriesMethods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString
-
Field Details
-
terms
-
field
-
-
Constructor Details
-
SynonymQuery
Creates a new SynonymQuery, matching any of the supplied terms.The terms must all have the same field.
-
-
Method Details
-
getTerms
-
toString
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. -
equals
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 that other instance. Utility methods are provided for certain repetitive code.
-
rewrite
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:
IOException
- See Also:
-
visit
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 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:
IOException
-
mergeImpacts
Merge impacts for multiple synonyms.
-