mcs/tools/monkeydoc/Lucene.Net/Lucene.Net/Document/FieldSelector.cs

   1 /*
   2  * Licensed to the Apache Software Foundation (ASF) under one or more
   3  * contributor license agreements.  See the NOTICE file distributed with
   4  * this work for additional information regarding copyright ownership.
   5  * The ASF licenses this file to You under the Apache License, Version 2.0
   6  * (the "License"); you may not use this file except in compliance with
   7  * the License.  You may obtain a copy of the License at
   8  *
   9  * http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 using System;
  19
  20 namespace Mono.Lucene.Net.Documents
  21 {
  22         /// <summary> Similar to a {@link java.io.FileFilter}, the FieldSelector allows one to make decisions about
  23         /// what Fields get loaded on a {@link Document} by {@link Mono.Lucene.Net.Index.IndexReader#Document(int,Mono.Lucene.Net.Documents.FieldSelector)}
  24         ///
  25         ///
  26         /// </summary>
  27         public interface FieldSelector
  28         {
  29
  30                 /// <summary> </summary>
  31                 /// <param name="fieldName">the field to accept or reject
  32                 /// </param>
  33                 /// <returns> an instance of {@link FieldSelectorResult}
  34                 /// if the {@link Field} named <code>fieldName</code> should be loaded.
  35                 /// </returns>
  36                 FieldSelectorResult Accept(System.String fieldName);
  37         }
  38 }