| java.lang.Object | ||
| ↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
| ↳ | org.apache.lucene.document.FieldSelectorResult | |
Class Overview
Provides information about what should be done with this Field
Summary
| Enum Values | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| FieldSelectorResult | LAZY_LOAD | Lazily load this Field. |
|||||||||
| FieldSelectorResult | LOAD | Load this Field every time the Document is loaded, reading in the data as it is encountered. |
|||||||||
| FieldSelectorResult | LOAD_AND_BREAK | Load this field as in the LOAD case, but immediately return from Field loading for the Document. |
|||||||||
| FieldSelectorResult | NO_LOAD | Do not load the Field. |
|||||||||
| FieldSelectorResult | SIZE | Expert: Load the size of this Field rather than its value. |
|||||||||
| 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 |
|||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
Enum Values
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. getField(String) SHOULD NOT BE USED. getFieldable(String) is safe to use and should
return a valid instance of a Fieldable.
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 encountered.
getField(String) and getFieldable(String) should not return null.
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. getField(String) and getFieldable(String) should
both be valid for this Field
add(Fieldable) should be called by the Reader.
public static final FieldSelectorResult NO_LOAD
Do not load the Field. getField(String) and getFieldable(String) should return null.
add(Fieldable) is not called.
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