Class SynonymQuery
- 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 classSynonymQuery.BuilderA builder forSynonymQuery.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)Expert: Constructs an appropriate Weight implementation for this query.booleanequals(Object other)Override and implement query instance equivalence properly in a subclass.StringgetField()Returns the field name of thisSynonymQueryList<Term>getTerms()Returns the terms of thisSynonymQueryinthashCode()Override and implement query hash code properly in a subclass.Queryrewrite(IndexSearcher indexSearcher)Expert: called to re-write queries into primitive queries.StringtoString(String field)Prints a query to a string, withfieldassumed to be the default field and omitted.voidvisit(QueryVisitor visitor)Recurse through the query tree, visiting any child queries.-
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
-
-
-
Method Detail
-
getTerms
public List<Term> getTerms()
Returns the terms of thisSynonymQuery
-
getField
public String getField()
Returns the field name of thisSynonymQuery
-
toString
public String toString(String field)
Description copied from class:QueryPrints a query to a string, withfieldassumed to be the default field and omitted.
-
hashCode
public int hashCode()
Description copied from class:QueryOverride and implement query hash code properly in a subclass. This is required so thatQueryCacheworks properly.- Specified by:
hashCodein classQuery- See Also:
Query.equals(Object)
-
equals
public boolean equals(Object other)
Description copied from class:QueryOverride and implement query instance equivalence properly in a subclass. This is required so thatQueryCacheworks 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:
equalsin classQuery- See Also:
Query.sameClassAs(Object),Query.classHash()
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws IOException
Description copied from class:QueryExpert: 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
rewritemultiple 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:
rewritein classQuery- Throws:
IOException- See Also:
IndexSearcher.rewrite(Query)
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:QueryRecurse through the query tree, visiting any child queries.
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException
Description copied from class:QueryExpert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Overrides:
createWeightin classQueryscoreMode- How the produced scorers will be consumed.boost- The boost that is propagated by the parent queries.- Throws:
IOException
-
-