Lucene++ - a full-featured, c++ search engine
API Documentation
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>
Public Types | |
enum | FieldSelectorResult { SELECTOR_NULL, SELECTOR_LOAD, SELECTOR_LAZY_LOAD, SELECTOR_NO_LOAD, SELECTOR_LOAD_AND_BREAK, SELECTOR_SIZE, SELECTOR_SIZE_AND_BREAK } |
Provides information about what should be done with this Field. More... |
Public Member Functions | |
virtual | ~FieldSelector () |
virtual String | getClassName () |
boost::shared_ptr< FieldSelector > | shared_from_this () |
virtual FieldSelectorResult | accept (const String &fieldName)=0 |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. | |
virtual int32_t | hashCode () |
Return hash code for this object. | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. | |
virtual String | toString () |
Returns a string representation of the object. | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. | |
virtual void | unlock () |
Unlock this object. | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. | |
virtual void | notifyAll () |
Notify all threads waiting for signal. |
Static Public Member Functions | |
static String | _getClassName () |
Protected Member Functions | |
FieldSelector () | |
![]() | |
LuceneObject () |
Additional Inherited Members | |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
The FieldSelector allows one to make decisions about what Fields get loaded on a Document by IndexReader#document(int32_t, FieldSelector).
Provides information about what should be done with this Field.
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. |
|
protected |
|
virtual |
|
inlinestatic |
Reimplemented in Lucene::MapFieldSelector, Lucene::SetBasedFieldSelector, and Lucene::LoadFirstFieldSelector.
|
pure virtual |
Implemented in Lucene::MapFieldSelector, Lucene::SetBasedFieldSelector, and Lucene::LoadFirstFieldSelector.
|
inlinevirtual |
Reimplemented in Lucene::MapFieldSelector, Lucene::SetBasedFieldSelector, and Lucene::LoadFirstFieldSelector.
|
inline |
Reimplemented in Lucene::MapFieldSelector, Lucene::SetBasedFieldSelector, and Lucene::LoadFirstFieldSelector.