The FieldSelector allows one to make decisions about what Fields get loaded on a Document
by IndexReader#document(int32_t, FieldSelector)
.
More...
#include <FieldSelector.h>
The FieldSelector allows one to make decisions about what Fields get loaded on a Document
by IndexReader#document(int32_t, FieldSelector)
.
◆ FieldSelectorResult
Provides information about what should be done with this Field.
Enumerator |
---|
SELECTOR_NULL | Null value.
|
SELECTOR_LOAD | Load this Field every time the Document is loaded, reading in the data as it is encountered. Document#getField(String) and Document#getFieldable(String) should not return null. Document#add(Fieldable) should be called by the Reader.
|
SELECTOR_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.
|
SELECTOR_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.
|
SELECTOR_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.
|
SELECTOR_SIZE | 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].
|
SELECTOR_SIZE_AND_BREAK | Like SIZE but immediately break from the field loading loop, i.e., stop loading further fields, after the size is loaded.
|
◆ FieldSelector()
Lucene::FieldSelector::FieldSelector |
( |
| ) |
|
|
protected |
◆ ~FieldSelector()
virtual Lucene::FieldSelector::~FieldSelector |
( |
| ) |
|
|
virtual |
◆ _getClassName()
static String Lucene::FieldSelector::_getClassName |
( |
| ) |
|
|
inlinestatic |
◆ accept()
◆ getClassName()
virtual String Lucene::FieldSelector::getClassName |
( |
| ) |
|
|
inlinevirtual |
◆ shared_from_this()
boost::shared_ptr< FieldSelector > Lucene::FieldSelector::shared_from_this |
( |
| ) |
|
|
inline |
The documentation for this class was generated from the following file: