Apache Lucene.Net 2.1 Class Library API

FieldSelectorResult Fields

The fields of the FieldSelectorResult class are listed below. For a complete list of FieldSelectorResult class members, see the FieldSelectorResult Members topic.

Public Static Fields

LAZY_LOAD Lazily load this {@link Field}. This means the {@link Field} is valid, but it may not actually contain its data until invoked. {@link Document#GetField(String)} SHOULD NOT BE USED. {@link Document#GetFieldable(String)} is safe to use and should return a valid instance of a {@link Fieldable}. {@link Document#Add(Fieldable)} should be called by the Reader.
LOAD Load this {@link Field} every time the {@link Document} is loaded, reading in the data as it is encounterd. {@link Document#GetField(String)} and {@link Document#GetFieldable(String)} should not return null. {@link Document#Add(Fieldable)} should be called by the Reader.
LOAD_AND_BREAK Load this field as in the {@link #LOAD} case, but immediately return from {@link Field} loading for the {@link Document}. Thus, the Document may not have its complete set of Fields. {@link Document#GetField(String)} and {@link Document#GetFieldable(String)} should both be valid for this {@link Field} {@link Document#Add(Fieldable)} should be called by the Reader.
LOAD_FOR_MERGE Behaves much like {@link #LOAD} but does not uncompress any compressed data. This is used for internal purposes. {@link Document#GetField(String)} and {@link Document#GetFieldable(String)} should not return null. {@link Document#Add(Fieldable)} should be called by the Reader.
NO_LOAD Do not load the {@link Field}. {@link Document#GetField(String)} and {@link Document#GetFieldable(String)} should return null. {@link Document#Add(Fieldable)} is not called. {@link Document#Add(Fieldable)} should not be called by the Reader.
SIZEExpert: Load the size of this {@link Field} rather than its value. Size is measured as number of bytes required to store the field == bytes for a binary or any compressed value, and 2*chars for a String value. The size is stored as a binary value, represented as an int in a byte[], with the higher order byte first in [0]
SIZE_AND_BREAKExpert: Like {@link #SIZE} but immediately break from the field loading loop, i.e. stop loading further fields, after the size is loaded

See Also

FieldSelectorResult Class | Lucene.Net.Documents Namespace