Class DrillDownQuery

java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.facet.DrillDownQuery

public final class DrillDownQuery extends Query
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 Details

  • Constructor Details

  • Method Details

    • term

      public static Term term(String field, String dim, String... path)
      Creates a drill-down term.
    • add

      public 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 constraints on that dimension, and all dimensions are AND'd against each other and the base query.
    • add

      public void add(String dim, Query subQuery)
      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

      public DrillDownQuery clone()
      Overrides:
      clone in class Object
    • hashCode

      public int hashCode()
      Description copied from class: Query
      Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.
      Specified by:
      hashCode in class Query
      See Also:
    • equals

      public boolean equals(Object other)
      Description copied from class: Query
      Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache 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 class Query
      See Also:
    • equalsTo

      private boolean equalsTo(DrillDownQuery other)
    • rewrite

      public Query rewrite(IndexSearcher indexSearcher) throws IOException
      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 class Query
      Throws:
      IOException
      See Also:
    • toString

      public String toString(String field)
      Description copied from class: Query
      Prints a query to a string, with field assumed to be the default field and omitted.
      Specified by:
      toString in class Query
    • visit

      public void visit(QueryVisitor visitor)
      Description copied from class: Query
      Recurse through the query tree, visiting any child queries.
      Specified by:
      visit in class Query
      Parameters:
      visitor - a QueryVisitor to be called by each query in the tree
    • getBooleanQuery

      private BooleanQuery getBooleanQuery()
    • getBaseQuery

      public Query getBaseQuery()
      Returns the internal baseQuery of the DrillDownQuery
      Returns:
      The baseQuery used on initialization of DrillDownQuery
    • getDrillDownQueries

      public Query[] getDrillDownQueries()
      Returns the dimension queries added either via add(String, Query) or add(String, String...)
      Returns:
      The array of dimQueries
    • getDims

      Map<String,Integer> getDims()