Lucene++ - a full-featured, c++ search engine
API Documentation
Declare what fields to load normally and what fields to load lazily. More...
#include <SetBasedFieldSelector.h>
Public Member Functions | |
SetBasedFieldSelector (HashSet< String > fieldsToLoad, HashSet< String > lazyFieldsToLoad) | |
Pass in the Set of Field names to load and the Set of Field names to load lazily. If both are null, the Document will not have any Field on it. | |
virtual | ~SetBasedFieldSelector () |
virtual String | getClassName () |
boost::shared_ptr< SetBasedFieldSelector > | shared_from_this () |
virtual FieldSelectorResult | accept (const String &fieldName) |
Indicate whether to load the field with the given name or not. If the Field#name() is not in either of the initializing Sets, then FieldSelectorResult#NO_LOAD is returned. If a Field name is in both fieldsToLoad and lazyFieldsToLoad, lazy has precedence. | |
![]() | |
virtual | ~FieldSelector () |
boost::shared_ptr< FieldSelector > | shared_from_this () |
![]() | |
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 () |
![]() | |
static String | _getClassName () |
Protected Attributes | |
HashSet< String > | fieldsToLoad |
HashSet< String > | lazyFieldsToLoad |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
FieldSelector () | |
![]() | |
LuceneObject () | |
Declare what fields to load normally and what fields to load lazily.
Lucene::SetBasedFieldSelector::SetBasedFieldSelector | ( | HashSet< String > | fieldsToLoad, |
HashSet< String > | lazyFieldsToLoad | ||
) |
|
virtual |
|
inlinestatic |
|
virtual |
Indicate whether to load the field with the given name or not. If the Field#name()
is not in either of the initializing Sets, then FieldSelectorResult#NO_LOAD
is returned. If a Field name is in both fieldsToLoad and lazyFieldsToLoad, lazy has precedence.
fieldName | The Field name to check |
FieldSelectorResult
Implements Lucene::FieldSelector.
|
inlinevirtual |
Reimplemented from Lucene::FieldSelector.
|
inline |
|
protected |
|
protected |