org.apache.lucene.document

Class SetBasedFieldSelector

java.lang.Object

org.apache.lucene.document.SetBasedFieldSelector

All Implemented Interfaces:

java.io.Serializable, FieldSelector

public class SetBasedFieldSelector
extends java.lang.Object
implements FieldSelector

Declare what fields to load normally and what fields to load lazily

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetBasedFieldSelector(java.util.Set<java.lang.String> fieldsToLoad, java.util.Set<java.lang.String> lazyFieldsToLoad) Pass in the Set of Field names to load and the Set of Field names to load lazily.

Method Summary

Modifier and Type	Method and Description
FieldSelectorResult	accept(java.lang.String fieldName) Indicate whether to load the field with the given name or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SetBasedFieldSelector

public SetBasedFieldSelector(java.util.Set<java.lang.String> fieldsToLoad,
                             java.util.Set<java.lang.String> 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(java.lang.String fieldName)

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

Specified by:

accept in interface FieldSelector

Parameters:

fieldName - The Field name to check

Returns:

The FieldSelectorResult