lucene-java-3.4.0/lucene/contrib/facet/src/java/org/apache/lucene/facet/search/results/IntermediateFacetResult.java

   1 package org.apache.lucene.facet.search.results;
   2
   3 import org.apache.lucene.facet.search.FacetResultsHandler;
   4 import org.apache.lucene.facet.search.params.FacetRequest;
   5
   6 /**
   7  * Licensed to the Apache Software Foundation (ASF) under one or more
   8  * contributor license agreements.  See the NOTICE file distributed with
   9  * this work for additional information regarding copyright ownership.
  10  * The ASF licenses this file to You under the Apache License, Version 2.0
  11  * (the "License"); you may not use this file except in compliance with
  12  * the License.  You may obtain a copy of the License at
  13  *
  14  *     http://www.apache.org/licenses/LICENSE-2.0
  15  *
  16  * Unless required by applicable law or agreed to in writing, software
  17  * distributed under the License is distributed on an "AS IS" BASIS,
  18  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  * See the License for the specific language governing permissions and
  20  * limitations under the License.
  21  */
  22
  23 /**
  24  * Intermediate {@link FacetResult} of faceted search.
  25  * <p>
  26  * This is an empty interface on purpose.
  27  * <p>
  28  * It allows {@link FacetResultsHandler} to return intermediate result objects
  29  * that only it knows how to interpret, and so the handler has maximal freedom
  30  * in defining what an intermediate result is, depending on its specific logic.
  31  *
  32  * @lucene.experimental
  33  */
  34 public interface IntermediateFacetResult {
  35
  36   /**
  37    * Facet request for which this temporary result was created.
  38    */
  39   FacetRequest getFacetRequest();
  40
  41 }