Class FieldSelectorResult

public static final FieldSelectorResult LAZY_LOAD

Lazily load this Field. This means the Field is valid, but it may not actually contain its data until invoked. Document.getField(String) SHOULD NOT BE USED. Document.getFieldable(String) is safe to use and should return a valid instance of a Fieldable.

Document.add(Fieldable) should be called by the Reader.

public static final FieldSelectorResult LOAD

Load this Field every time the Document is loaded, reading in the data as it is encounterd. Document.getField(String) and Document.getFieldable(String) should not return null.

Document.add(Fieldable) should be called by the Reader.

public static final FieldSelectorResult LOAD_AND_BREAK

Load this field as in the LOAD case, but immediately return from Field loading for the Document. Thus, the Document may not have its complete set of Fields. Document.getField(String) and Document.getFieldable(String) should both be valid for this Field

Document.add(Fieldable) should be called by the Reader.

public static final FieldSelectorResult LOAD_FOR_MERGE

Behaves much like LOAD but does not uncompress any compressed data. This is used for internal purposes. Document.getField(String) and Document.getFieldable(String) should not return null.

Document.add(Fieldable) should be called by the Reader.

public static final FieldSelectorResult NO_LOAD

Do not load the Field. Document.getField(String) and Document.getFieldable(String) should return null. Document.add(Fieldable) is not called.

Document.add(Fieldable) should not be called by the Reader.

public static final FieldSelectorResult SIZE

Expert: Load the size of this 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]

public static final FieldSelectorResult SIZE_AND_BREAK

Expert: Like SIZE but immediately break from the field loading loop, i.e. stop loading further fields, after the size is loaded