|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.lucene.search.Query org.apache.lucene.facet.DrillDownQuery
public final class 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 with ConstantScoreQuery
and set the boost
to 0.0f
,
so that it does not affect the scores of the documents.
Constructor Summary | |
---|---|
DrillDownQuery(FacetsConfig config)
Creates a new DrillDownQuery without a base query,
to perform a pure browsing query (equivalent to using
MatchAllDocsQuery as base). |
|
DrillDownQuery(FacetsConfig config,
Query baseQuery)
Creates a new DrillDownQuery over the given base query. |
Method Summary | |
---|---|
void |
add(String dim,
Filter subFilter)
Expert: add a custom drill-down Filter, e.g. |
void |
add(String dim,
Query subQuery)
Expert: add a custom drill-down subQuery. |
void |
add(String dim,
String... path)
Adds one dimension of drill downs; if you pass the same dimension more than once it is OR'd with the previous cofnstraints on that dimension, and all dimensions are AND'd against each other and the base query. |
DrillDownQuery |
clone()
|
boolean |
equals(Object obj)
|
int |
hashCode()
|
Query |
rewrite(IndexReader r)
|
static Term |
term(String field,
String dim,
String... path)
Creates a drill-down term. |
String |
toString(String field)
|
Methods inherited from class org.apache.lucene.search.Query |
---|
createWeight, extractTerms, getBoost, setBoost, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DrillDownQuery(FacetsConfig config)
DrillDownQuery
without a base query,
to perform a pure browsing query (equivalent to using
MatchAllDocsQuery
as base).
public DrillDownQuery(FacetsConfig config, Query baseQuery)
DrillDownQuery
over the given base query. Can be
null
, in which case the result Query
from
rewrite(IndexReader)
will be a pure browsing query, filtering on
the added categories only.
Method Detail |
---|
public static Term term(String field, String dim, String... path)
public void add(String dim, String... path)
public void add(String dim, Query subQuery)
public void add(String dim, Filter subFilter)
public DrillDownQuery clone()
clone
in class Query
public int hashCode()
hashCode
in class Query
public boolean equals(Object obj)
equals
in class Query
public Query rewrite(IndexReader r) throws IOException
rewrite
in class Query
IOException
public String toString(String field)
toString
in class Query
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |