Class Query
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- Direct Known Subclasses:
BlendedTermQuery,BooleanQuery,BoostQuery,ByteVectorSimilarityQuery,ConstantScoreQuery,DisjunctionMaxQuery,FieldExistsQuery,FloatVectorSimilarityQuery,IndexOrDocValuesQuery,IndexSortSortedNumericDocValuesRangeQuery,IndriQuery,KnnByteVectorQuery,KnnFloatVectorQuery,MatchAllDocsQuery,MatchNoDocsQuery,MultiPhraseQuery,MultiTermQuery,NGramPhraseQuery,PhraseQuery,PointInSetQuery,PointRangeQuery,RangeFieldQuery,SynonymQuery,TermQuery,XYDocValuesPointInGeometryQuery
public abstract class Query extends Object
The abstract base class for queries.Instantiable subclasses are:
TermQueryBooleanQueryWildcardQueryPhraseQueryPrefixQueryMultiPhraseQueryFuzzyQueryRegexpQueryTermRangeQueryPointRangeQueryConstantScoreQueryDisjunctionMaxQueryMatchAllDocsQuery
See also additional queries available in the Queries module.
-
-
Constructor Summary
Constructors Constructor Description Query()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected intclassHash()Provides a constant integer for a given class, derived from the name of the class.WeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)Expert: Constructs an appropriate Weight implementation for this query.abstract booleanequals(Object obj)Override and implement query instance equivalence properly in a subclass.abstract inthashCode()Override and implement query hash code properly in a subclass.Queryrewrite(IndexReader reader)Deprecated.Queryrewrite(IndexSearcher indexSearcher)Expert: called to re-write queries into primitive queries.protected booleansameClassAs(Object other)Utility method to check whetherotheris not null and is exactly of the same class as this object's class.StringtoString()Prints a query to a string.abstract StringtoString(String field)Prints a query to a string, withfieldassumed to be the default field and omitted.abstract voidvisit(QueryVisitor visitor)Recurse through the query tree, visiting any child queries.
-
-
-
Method Detail
-
toString
public abstract String toString(String field)
Prints a query to a string, withfieldassumed to be the default field and omitted.
-
toString
public final String toString()
Prints a query to a string.
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Parameters:
scoreMode- How the produced scorers will be consumed.boost- The boost that is propagated by the parent queries.- Throws:
IOException
-
rewrite
@Deprecated public Query rewrite(IndexReader reader) throws IOException
Deprecated.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
rewritemultiple times if necessary, until the rewritten query is the same as the original query.- Throws:
IOException- See Also:
IndexSearcher.rewrite(Query)
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws IOException
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
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.
- Throws:
IOException- See Also:
IndexSearcher.rewrite(Query)
-
visit
public abstract void visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries.- Parameters:
visitor- a QueryVisitor to be called by each query in the tree
-
equals
public abstract boolean equals(Object obj)
Override 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.
- Overrides:
equalsin classObject- See Also:
sameClassAs(Object),classHash()
-
hashCode
public abstract int hashCode()
Override and implement query hash code properly in a subclass. This is required so thatQueryCacheworks properly.- Overrides:
hashCodein classObject- See Also:
equals(Object)
-
sameClassAs
protected final boolean sameClassAs(Object other)
Utility method to check whetherotheris not null and is exactly of the same class as this object's class.When this method is used in an implementation of
equals(Object), consider usingclassHash()in the implementation ofhashCode()to differentiate different class.
-
classHash
protected final int classHash()
Provides a constant integer for a given class, derived from the name of the class. The rationale for not using justObject.hashCode()is that classes may be assigned different hash codes for each execution and we want hashes to be possibly consistent to facilitate debugging.
-
-