FileDocCategorySizeDatePackage
FieldSelectorResult.javaAPI DocApache Lucene 2.1.04169Wed Feb 14 10:46:42 GMT 2007org.apache.lucene.document

FieldSelectorResult

public final class FieldSelectorResult extends Object
Provides information about what should be done with this Field

Fields Summary
public static final FieldSelectorResult
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.

public static final FieldSelectorResult
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.

public static final FieldSelectorResult
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.

public static final FieldSelectorResult
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.

public static final FieldSelectorResult
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.

public static final FieldSelectorResult
SIZE
Expert: 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]
public static final FieldSelectorResult
SIZE_AND_BREAK
Expert: Like {@link #SIZE} but immediately break from the field loading loop, i.e. stop loading further fields, after the size is loaded
private int
id
Constructors Summary
private FieldSelectorResult(int id)


     
    this.id = id;
Methods Summary
public booleanequals(java.lang.Object o)

    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;

    final FieldSelectorResult that = (FieldSelectorResult) o;

    if (id != that.id) return false;

    return true;
public inthashCode()

    return id;