Lucene++ - a full-featured, c++ search engine
API Documentation


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::MapFieldSelector Class Reference

A FieldSelector based on a Map of field names to FieldSelectorResults. More...

#include <MapFieldSelector.h>

+ Inheritance diagram for Lucene::MapFieldSelector:

Public Member Functions

 MapFieldSelector (MapStringFieldSelectorResult fieldSelections)
 Create a MapFieldSelector.
 
 MapFieldSelector (Collection< String > fields)
 Create a MapFieldSelector.
 
virtual ~MapFieldSelector ()
 
virtual String getClassName ()
 
boost::shared_ptr< MapFieldSelectorshared_from_this ()
 
virtual FieldSelectorResult accept (const String &fieldName)
 Load field according to its associated value in fieldSelections.
 
- Public Member Functions inherited from Lucene::FieldSelector
virtual ~FieldSelector ()
 
boost::shared_ptr< FieldSelectorshared_from_this ()
 
- Public Member Functions inherited from Lucene::LuceneObject
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.
 
- Public Member Functions inherited from Lucene::LuceneSync
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 Public Member Functions inherited from Lucene::FieldSelector
static String _getClassName ()
 

Data Fields

MapStringFieldSelectorResult fieldSelections
 

Additional Inherited Members

- Public Types inherited from Lucene::FieldSelector
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...
 
- Protected Member Functions inherited from Lucene::FieldSelector
 FieldSelector ()
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

A FieldSelector based on a Map of field names to FieldSelectorResults.

Constructor & Destructor Documentation

◆ MapFieldSelector() [1/2]

Lucene::MapFieldSelector::MapFieldSelector ( MapStringFieldSelectorResult  fieldSelections)

Create a MapFieldSelector.

Parameters
fieldSelectionsmaps from field names (String) to FieldSelectorResults

◆ MapFieldSelector() [2/2]

Lucene::MapFieldSelector::MapFieldSelector ( Collection< String >  fields)

Create a MapFieldSelector.

Parameters
fieldsfields to LOAD. List of Strings. All other fields are NO_LOAD.

◆ ~MapFieldSelector()

virtual Lucene::MapFieldSelector::~MapFieldSelector ( )
virtual

Member Function Documentation

◆ _getClassName()

static String Lucene::MapFieldSelector::_getClassName ( )
inlinestatic

◆ accept()

virtual FieldSelectorResult Lucene::MapFieldSelector::accept ( const String &  fieldName)
virtual

Load field according to its associated value in fieldSelections.

Parameters
fielda field name
Returns
the fieldSelections value that field maps to or NO_LOAD if none.

Implements Lucene::FieldSelector.

◆ getClassName()

virtual String Lucene::MapFieldSelector::getClassName ( )
inlinevirtual

Reimplemented from Lucene::FieldSelector.

◆ shared_from_this()

boost::shared_ptr< MapFieldSelector > Lucene::MapFieldSelector::shared_from_this ( )
inline

Field Documentation

◆ fieldSelections

MapStringFieldSelectorResult Lucene::MapFieldSelector::fieldSelections

The documentation for this class was generated from the following file:

clucene.sourceforge.net