Public Member Functions | List of all members
Xapian::ValueSetMatchDecider Class Reference

MatchDecider filtering results based on whether document values are in a user-defined set. More...

+ Inheritance diagram for Xapian::ValueSetMatchDecider:

Public Member Functions

 ValueSetMatchDecider (Xapian::valueno slot, bool inclusive_)
 Construct a ValueSetMatchDecider. More...
 
void add_value (const std::string &value)
 Add a value to the test set. More...
 
void remove_value (const std::string &value)
 Remove a value from the test set. More...
 
bool operator() (const Xapian::Document &doc) const
 Decide whether we want a particular document to be in the MSet. More...
 
- Public Member Functions inherited from Xapian::MatchDecider
 MatchDecider ()
 Default constructor.
 
virtual ~MatchDecider ()
 Destructor.
 

Detailed Description

MatchDecider filtering results based on whether document values are in a user-defined set.

Constructor & Destructor Documentation

◆ ValueSetMatchDecider()

Xapian::ValueSetMatchDecider::ValueSetMatchDecider ( Xapian::valueno  slot,
bool  inclusive_ 
)
inline

Construct a ValueSetMatchDecider.

Parameters
slotThe value slot number to look in.
inclusive_If true, match decider accepts documents which have a value in the specified slot which is a member of the test set; if false, match decider accepts documents which do not have a value in the specified slot.

Member Function Documentation

◆ add_value()

void Xapian::ValueSetMatchDecider::add_value ( const std::string &  value)
inline

Add a value to the test set.

Parameters
valueThe value to add to the test set.

◆ operator()()

bool Xapian::ValueSetMatchDecider::operator() ( const Xapian::Document doc) const
virtual

Decide whether we want a particular document to be in the MSet.

Parameters
docThe document to test.
Returns
true if the document is acceptable, or false if the document should be excluded from the MSet.

Implements Xapian::MatchDecider.

◆ remove_value()

void Xapian::ValueSetMatchDecider::remove_value ( const std::string &  value)
inline

Remove a value from the test set.

Parameters
valueThe value to remove from the test set.

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

Documentation for Xapian (version 1.4.9).
Generated on Sat Nov 3 2018 by Doxygen 1.8.13.