lucene-java-3.4.0/lucene/src/java/org/apache/lucene/document/FieldSelector.java

   1 package org.apache.lucene.document;
   2
   3 import java.io.Serializable;
   4 /**
   5  * Copyright 2004 The Apache Software Foundation
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * 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 /**
  21  * Similar to a {@link java.io.FileFilter}, the FieldSelector allows one to make decisions about
  22  * what Fields get loaded on a {@link Document} by {@link org.apache.lucene.index.IndexReader#document(int,org.apache.lucene.document.FieldSelector)}
  23  *
  24  **/
  25 public interface FieldSelector extends Serializable {
  26
  27   /**
  28    *
  29    * @param fieldName the field to accept or reject
  30    * @return an instance of {@link FieldSelectorResult}
  31    * if the {@link Field} named <code>fieldName</code> should be loaded.
  32    */
  33   FieldSelectorResult accept(String fieldName);
  34 }