lucene-java-3.4.0/lucene/src/java/org/apache/lucene/search/TermCollectingRewrite.java

   1 package org.apache.lucene.search;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 import java.io.IOException;
  21
  22 import org.apache.lucene.index.IndexReader;
  23 import org.apache.lucene.index.Term;
  24
  25 abstract class TermCollectingRewrite<Q extends Query> extends MultiTermQuery.RewriteMethod {
  26
  27   /** Return a suitable top-level Query for holding all expanded terms. */
  28   protected abstract Q getTopLevelQuery() throws IOException;
  29
  30   /** Add a MultiTermQuery term to the top-level query */
  31   protected abstract void addClause(Q topLevel, Term term, float boost) throws IOException;
  32
  33   protected final void collectTerms(IndexReader reader, MultiTermQuery query, TermCollector collector) throws IOException {
  34     final FilteredTermEnum enumerator = query.getEnum(reader);
  35     try {
  36       do {
  37         final Term t = enumerator.term();
  38         if (t == null || !collector.collect(t, enumerator.difference()))
  39           break;
  40       } while (enumerator.next());
  41     } finally {
  42       enumerator.close();
  43     }
  44   }
  45
  46   protected interface TermCollector {
  47     /** return false to stop collecting */
  48     boolean collect(Term t, float boost) throws IOException;
  49   }
  50 }