org.apache.lucene.document

Class FieldSelectorResult

public final class FieldSelectorResult extends Object implements Serializable

Provides information about what should be done with this Field

Field Summary
static FieldSelectorResult	LAZY_LOAD Lazily load this Field.
static FieldSelectorResult	LOAD Load this Field every time the Document is loaded, reading in the data as it is encounterd. getField and getFieldable should not return null.
static FieldSelectorResult	LOAD_AND_BREAK Load this field as in the LOAD case, but immediately return from Field loading for the Document.
static FieldSelectorResult	LOAD_FOR_MERGE Behaves much like LOAD but does not uncompress any compressed data.
static FieldSelectorResult	NO_LOAD Do not load the Field. getField and getFieldable should return null. add is not called.
static FieldSelectorResult	SIZE Expert: Load the size of this Field rather than its value.
static 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

Method Summary
boolean	equals(Object o)
int	hashCode()

Field Detail

LAZY_LOAD

public static final transient FieldSelectorResult LAZY_LOAD

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

add should be called by the Reader.

LOAD

public static final transient FieldSelectorResult LOAD

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

add should be called by the Reader.

LOAD_AND_BREAK

public static final transient 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. getField and getFieldable should both be valid for this Field

add should be called by the Reader.

LOAD_FOR_MERGE

public static final transient FieldSelectorResult LOAD_FOR_MERGE

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

add should be called by the Reader.

NO_LOAD

public static final transient FieldSelectorResult NO_LOAD

Do not load the Field. getField and getFieldable should return null. add is not called.

add should not be called by the Reader.

SIZE

public static final transient 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]