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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Query
private final FacetsConfig
private final List
<BooleanQuery.Builder> private final IntHashSet
-
Constructor Summary
ConstructorsConstructorDescriptionDrillDownQuery
(FacetsConfig config) Creates a newDrillDownQuery
without a base query, to perform a pure browsing query (equivalent to usingMatchAllDocsQuery
as base).DrillDownQuery
(FacetsConfig config, Query baseQuery) Creates a newDrillDownQuery
over the given base query.DrillDownQuery
(FacetsConfig config, Query baseQuery, List<BooleanQuery.Builder> dimQueries, Map<String, Integer> drillDownDims) Used by clone() and DrillSidewaysDrillDownQuery
(FacetsConfig config, Query filter, DrillDownQuery other) Used by DrillSideways -
Method Summary
Modifier and TypeMethodDescriptionvoid
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.void
Expert: add a custom drill-down subQuery.clone()
boolean
Override and implement query instance equivalence properly in a subclass.private boolean
equalsTo
(DrillDownQuery other) Returns the internal baseQuery of the DrillDownQueryprivate BooleanQuery
getDims()
Query[]
Returns the dimension queries added either viaadd(String, Query)
oradd(String, String...)
int
hashCode()
Override and implement query hash code properly in a subclass.rewrite
(IndexSearcher indexSearcher) Expert: called to re-write queries into primitive queries.static Term
Creates a drill-down term.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, createWeight, sameClassAs, toString
-
Field Details
-
config
-
baseQuery
-
dimQueries
-
drillDownDims
-
builtDimQueries
-
dirtyDimQueryIndex
-
-
Constructor Details
-
DrillDownQuery
DrillDownQuery(FacetsConfig config, Query baseQuery, List<BooleanQuery.Builder> dimQueries, Map<String, Integer> drillDownDims) Used by clone() and DrillSideways -
DrillDownQuery
DrillDownQuery(FacetsConfig config, Query filter, DrillDownQuery other) Used by DrillSideways -
DrillDownQuery
Creates a newDrillDownQuery
without a base query, to perform a pure browsing query (equivalent to usingMatchAllDocsQuery
as base). -
DrillDownQuery
Creates a newDrillDownQuery
over the given base query. Can benull
, in which case the resultQuery
fromQuery.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()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 to those of the other instance. Utility methods are provided for certain repetitive code.
-
equalsTo
-
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.The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.
- Overrides:
rewrite
in classQuery
- Throws:
IOException
- See Also:
-
toString
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted. -
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries. -
getBooleanQuery
-
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
-
getDims
-