Package org.apache.lucene.facet
Class DrillDownQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.facet.DrillDownQuery
A
Query for drill-down over facet categories. You should call add(String, String...) for every group of categories you want to drill-down over.
NOTE: if you choose to create your own Query by calling term(java.lang.String, java.lang.String, java.lang.String...), it is
recommended to wrap it in a BoostQuery with a boost of 0.0f, so that it does not
affect the scores of the documents.
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Constructor Summary
ConstructorsConstructorDescriptionDrillDownQuery(FacetsConfig config) Creates a newDrillDownQuerywithout a base query, to perform a pure browsing query (equivalent to usingMatchAllDocsQueryas base).DrillDownQuery(FacetsConfig config, Query baseQuery) Creates a newDrillDownQueryover the given base query. -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds one dimension of drill downs; if you pass the same dimension more than once it is OR'd with the previous constraints on that dimension, and all dimensions are AND'd against each other and the base query.voidExpert: add a custom drill-down subQuery.clone()booleanReturns the internal baseQuery of the DrillDownQueryQuery[]Returns the dimension queries added either viaadd(String, Query)oradd(String, String...)inthashCode()rewrite(IndexSearcher indexSearcher) static TermCreates a drill-down term.voidvisit(QueryVisitor visitor) Methods inherited from class org.apache.lucene.search.Query
classHash, createWeight, sameClassAs, toString
-
Constructor Details
-
DrillDownQuery
Creates a newDrillDownQuerywithout a base query, to perform a pure browsing query (equivalent to usingMatchAllDocsQueryas base). -
DrillDownQuery
Creates a newDrillDownQueryover the given base query. Can benull, in which case the resultQueryfromQuery.rewrite(IndexSearcher)will be a pure browsing query, filtering on the added categories only.
-
-
Method Details
-
term
Creates a drill-down term. -
add
Adds one dimension of drill downs; if you pass the same dimension more than once it is OR'd with the previous constraints on that dimension, and all dimensions are AND'd against each other and the base query. -
add
Expert: add a custom drill-down subQuery. Use this when you have a separate way to drill-down on the dimension than the indexed facet ordinals. -
clone
-
hashCode
public int hashCode() -
equals
-
rewrite
- Overrides:
rewritein classQuery- Throws:
IOException
-
toString
-
visit
-
getBaseQuery
Returns the internal baseQuery of the DrillDownQuery- Returns:
- The baseQuery used on initialization of DrillDownQuery
-
getDrillDownQueries
Returns the dimension queries added either viaadd(String, Query)oradd(String, String...)- Returns:
- The array of dimQueries
-