org.apache.lucene.document

Class SetBasedFieldSelector

public class SetBasedFieldSelector extends Object implements FieldSelector

Declare what fields to load normally and what fields to load lazily
Constructor Summary
SetBasedFieldSelector(Set fieldsToLoad, Set lazyFieldsToLoad)
Pass in the Set of Field names to load and the Set of Field names to load lazily.
Method Summary
FieldSelectorResultaccept(String fieldName)
Indicate whether to load the field with the given name or not.

Constructor Detail

SetBasedFieldSelector

public SetBasedFieldSelector(Set fieldsToLoad, Set lazyFieldsToLoad)
Pass in the Set of Field names to load and the Set of Field names to load lazily. If both are null, the Document will not have any Field on it.

Parameters: fieldsToLoad A Set of String field names to load. May be empty, but not null lazyFieldsToLoad A Set of String field names to load lazily. May be empty, but not null

Method Detail

accept

public FieldSelectorResult accept(String fieldName)
Indicate whether to load the field with the given name or not. If the Field is not in either of the initializing Sets, then NO_LOAD is returned. If a Field name is in both fieldsToLoad and lazyFieldsToLoad, lazy has precedence.

Parameters: fieldName The Field name to check

Returns: The FieldSelectorResult

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.