lucene-java-3.5.0/lucene/src/java/org/apache/lucene/search/SearcherWarmer.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.search.NRTManager; // javadocs
  23 import org.apache.lucene.search.IndexSearcher; // javadocs
  24
  25 /** Pass an implementation of this to {@link NRTManager} or
  26  *  {@link SearcherManager} to warm a new {@link
  27  *  IndexSearcher} before it's put into production.
  28  *
  29  * @lucene.experimental */
  30
  31 public interface SearcherWarmer {
  32   // TODO: can we somehow merge this w/ IW's
  33   // IndexReaderWarmer.... should IW switch to this?
  34   public void warm(IndexSearcher s) throws IOException;
  35 }