Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.lucene.document.FieldSelectorResult
public final class FieldSelectorResult
extends Object
Field Summary | |
static FieldSelectorResult | |
static FieldSelectorResult | |
static FieldSelectorResult |
|
static FieldSelectorResult |
|
static FieldSelectorResult | |
static FieldSelectorResult | |
static FieldSelectorResult |
|
public static final FieldSelectorResult LAZY_LOAD
Lazily load thisField
. This means theField
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 aFieldable
.Document.add(Fieldable)
should be called by the Reader.
public static final FieldSelectorResult LOAD
Load thisField
every time theDocument
is loaded, reading in the data as it is encounterd.Document.getField(String)
andDocument.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 theLOAD
case, but immediately return fromField
loading for theDocument
. Thus, the Document may not have its complete set of Fields.Document.getField(String)
andDocument.getFieldable(String)
should both be valid for thisField
Document.add(Fieldable)
should be called by the Reader.
public static final FieldSelectorResult LOAD_FOR_MERGE
Behaves much likeLOAD
but does not uncompress any compressed data. This is used for internal purposes.Document.getField(String)
andDocument.getFieldable(String)
should not return null.Document.add(Fieldable)
should be called by the Reader.
public static final FieldSelectorResult NO_LOAD
Do not load theField
.Document.getField(String)
andDocument.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 thisField
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: LikeSIZE
but immediately break from the field loading loop, i.e. stop loading further fields, after the size is loaded