01: package org.apache.lucene.document;
02:
03: import java.io.Serializable;
04:
05: /**
06: * Copyright 2004 The Apache Software Foundation
07: *
08: * Licensed under the Apache License, Version 2.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: */
20:
21: /**
22: * 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 org.apache.lucene.index.IndexReader#document(int,org.apache.lucene.document.FieldSelector)}
24: *
25: **/
26: public interface FieldSelector extends Serializable {
27:
28: /**
29: *
30: * @param fieldName the field to accept or reject
31: * @return an instance of {@link FieldSelectorResult}
32: * if the {@link Field} named <code>fieldName</code> should be loaded.
33: */
34: FieldSelectorResult accept(String fieldName);
35: }
|