lucene-java-3.5.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/search/DrillDown.java

   1 package org.apache.lucene.facet.search;
   2
   3 import org.apache.lucene.index.Term;
   4 import org.apache.lucene.search.BooleanQuery;
   5 import org.apache.lucene.search.Query;
   6 import org.apache.lucene.search.TermQuery;
   7 import org.apache.lucene.search.BooleanClause.Occur;
   8
   9 import org.apache.lucene.facet.index.params.CategoryListParams;
  10 import org.apache.lucene.facet.index.params.FacetIndexingParams;
  11 import org.apache.lucene.facet.search.params.FacetSearchParams;
  12 import org.apache.lucene.facet.taxonomy.CategoryPath;
  13
  14 /**
  15  * Licensed to the Apache Software Foundation (ASF) under one or more
  16  * contributor license agreements.  See the NOTICE file distributed with
  17  * this work for additional information regarding copyright ownership.
  18  * The ASF licenses this file to You under the Apache License, Version 2.0
  19  * (the "License"); you may not use this file except in compliance with
  20  * the License.  You may obtain a copy of the License at
  21  *
  22  *     http://www.apache.org/licenses/LICENSE-2.0
  23  *
  24  * Unless required by applicable law or agreed to in writing, software
  25  * distributed under the License is distributed on an "AS IS" BASIS,
  26  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  27  * See the License for the specific language governing permissions and
  28  * limitations under the License.
  29  */
  30
  31 /**
  32  * Creation of drill down term or query.
  33  *
  34  * @lucene.experimental
  35  */
  36 public final class DrillDown {
  37
  38   /**
  39    * @see #term(FacetIndexingParams, CategoryPath)
  40    */
  41   public static final Term term(FacetSearchParams sParams, CategoryPath path) {
  42     return term(sParams.getFacetIndexingParams(), path);
  43   }
  44
  45   /**
  46    * Return a term for drilling down into a category.
  47    */
  48   public static final Term term(FacetIndexingParams iParams, CategoryPath path) {
  49     CategoryListParams clp = iParams.getCategoryListParams(path);
  50     char[] buffer = new char[path.charsNeededForFullPath()];
  51     iParams.drillDownTermText(path, buffer);
  52     return clp.getTerm().createTerm(String.valueOf(buffer));
  53   }
  54
  55   /**
  56    * Return a query for drilling down into all given categories (AND).
  57    * @see #term(FacetSearchParams, CategoryPath)
  58    * @see #query(FacetSearchParams, Query, CategoryPath...)
  59    */
  60   public static final Query query(FacetIndexingParams iParams, CategoryPath... paths) {
  61     if (paths==null || paths.length==0) {
  62       throw new IllegalArgumentException("Empty category path not allowed for drill down query!");
  63     }
  64     if (paths.length==1) {
  65       return new TermQuery(term(iParams, paths[0]));
  66     }
  67     BooleanQuery res = new BooleanQuery();
  68     for (CategoryPath cp : paths) {
  69       res.add(new TermQuery(term(iParams, cp)), Occur.MUST);
  70     }
  71     return res;
  72   }
  73
  74   /**
  75    * Return a query for drilling down into all given categories (AND).
  76    * @see #term(FacetSearchParams, CategoryPath)
  77    * @see #query(FacetSearchParams, Query, CategoryPath...)
  78    */
  79   public static final Query query(FacetSearchParams sParams, CategoryPath... paths) {
  80     return query(sParams.getFacetIndexingParams(), paths);
  81   }
  82
  83   /**
  84    * Turn a base query into a drilling-down query for all given category paths (AND).
  85    * @see #query(FacetIndexingParams, CategoryPath...)
  86    */
  87   public static final Query query(FacetIndexingParams iParams, Query baseQuery, CategoryPath... paths) {
  88     BooleanQuery res = new BooleanQuery();
  89     res.add(baseQuery, Occur.MUST);
  90     res.add(query(iParams, paths), Occur.MUST);
  91     return res;
  92   }
  93
  94   /**
  95    * Turn a base query into a drilling-down query for all given category paths (AND).
  96    * @see #query(FacetSearchParams, CategoryPath...)
  97    */
  98   public static final Query query(FacetSearchParams sParams, Query baseQuery, CategoryPath... paths) {
  99     return query(sParams.getFacetIndexingParams(), baseQuery, paths);
 100   }
 101
 102   /**
 103    * Turn a base query into a drilling-down query using the default {@link FacetSearchParams}
 104    * @see #query(FacetSearchParams, Query, CategoryPath...)
 105    */
 106   public static final Query query(Query baseQuery, CategoryPath... paths) {
 107     return query(new FacetSearchParams(), baseQuery, paths);
 108   }
 109
 110 }