- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.misc.search.HumanReadableQuery
-
public final class HumanReadableQuery extends Query
A simple query wrapper for debug purposes. Behaves like the given query, but when printing to a string, it will prepend the description parameter to the query output.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
description
private Query
in
-
Constructor Summary
Constructors Constructor Description HumanReadableQuery(Query in, java.lang.String description)
Create a new HumanReadableQuery
-
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)
Override and implement query instance equivalence properly in a subclass.java.lang.String
getDescription()
Query
getWrappedQuery()
int
hashCode()
Override and implement query hash code properly in a subclass.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
-
in
private final Query in
-
description
private final java.lang.String description
-
-
Constructor Detail
-
HumanReadableQuery
public HumanReadableQuery(Query in, java.lang.String description)
Create a new HumanReadableQuery- Parameters:
in
- the query to wrapdescription
- a human-readable description, used in toString()
-
-
Method Detail
-
getWrappedQuery
public Query getWrappedQuery()
- Returns:
- the wrapped Query
-
getDescription
public java.lang.String getDescription()
- Returns:
- the query description
-
rewrite
public Query rewrite(IndexSearcher indexSearcher)
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
- See Also:
IndexSearcher.rewrite(Query)
-
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.
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries.
-
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()
-
createWeight
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
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.
-
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)
-
-