xapian-core  1.4.18
Public Member Functions | Private Member Functions | List of all members
Xapian::ValueRangeProcessor Class Referenceabstract

Base class for value range processors. More...

#include <queryparser.h>

+ Inheritance diagram for Xapian::ValueRangeProcessor:
+ Collaboration diagram for Xapian::ValueRangeProcessor:

Public Member Functions

 ValueRangeProcessor ()
 Default constructor. More...
 
virtual ~ValueRangeProcessor ()
 Destructor. More...
 
virtual Xapian::valueno operator() (std::string &begin, std::string &end)=0
 Check for a valid range of this type. More...
 
ValueRangeProcessorrelease ()
 Start reference counting this object. More...
 
const ValueRangeProcessorrelease () const
 Start reference counting this object. More...
 
- Public Member Functions inherited from Xapian::Internal::opt_intrusive_base
 opt_intrusive_base (const opt_intrusive_base &)
 
opt_intrusive_baseoperator= (const opt_intrusive_base &)
 
 opt_intrusive_base ()
 Construct object which is initially not reference counted. More...
 
virtual ~opt_intrusive_base ()
 
void ref () const
 
void unref () const
 

Private Member Functions

void operator= (const ValueRangeProcessor &)
 Don't allow assignment. More...
 
 ValueRangeProcessor (const ValueRangeProcessor &)
 Don't allow copying. More...
 

Additional Inherited Members

- Public Attributes inherited from Xapian::Internal::opt_intrusive_base
unsigned _refs
 Reference count. More...
 
- Protected Member Functions inherited from Xapian::Internal::opt_intrusive_base
void release () const
 Start reference counting. More...
 

Detailed Description

Base class for value range processors.

Definition at line 396 of file queryparser.h.

Constructor & Destructor Documentation

◆ ValueRangeProcessor() [1/2]

Xapian::ValueRangeProcessor::ValueRangeProcessor ( const ValueRangeProcessor )
private

Don't allow copying.

◆ ValueRangeProcessor() [2/2]

Xapian::ValueRangeProcessor::ValueRangeProcessor ( )
inline

Default constructor.

Definition at line 406 of file queryparser.h.

◆ ~ValueRangeProcessor()

ValueRangeProcessor::~ValueRangeProcessor ( )
virtual

Destructor.

Definition at line 61 of file queryparser.cc.

Member Function Documentation

◆ operator()()

virtual Xapian::valueno Xapian::ValueRangeProcessor::operator() ( std::string &  begin,
std::string &  end 
)
pure virtual

Check for a valid range of this type.

Parameters
[in,out]beginThe start of the range as specified in the query string by the user. This parameter is a non-const reference so the ValueRangeProcessor can modify it to return the value to start the range with.
[in,out]endThe end of the range. This is also a non-const reference so it can be modified.
Returns
If this ValueRangeProcessor recognises the range BEGIN..END it returns the value slot number to range filter on. Otherwise it returns Xapian::BAD_VALUENO.

Implemented in AuthorValueRangeProcessor, TestValueRangeProcessor, Xapian::NumberValueRangeProcessor, Xapian::DateValueRangeProcessor, and Xapian::StringValueRangeProcessor.

◆ operator=()

void Xapian::ValueRangeProcessor::operator= ( const ValueRangeProcessor )
private

Don't allow assignment.

◆ release() [1/2]

ValueRangeProcessor* Xapian::ValueRangeProcessor::release ( )
inline

Start reference counting this object.

You can hand ownership of a dynamically allocated ValueRangeProcessor object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

Definition at line 434 of file queryparser.h.

Referenced by DEFINE_TESTCASE().

◆ release() [2/2]

const ValueRangeProcessor* Xapian::ValueRangeProcessor::release ( ) const
inline

Start reference counting this object.

You can hand ownership of a dynamically allocated ValueRangeProcessor object to Xapian by calling release() and then passing the object to a Xapian method. Xapian will arrange to delete the object once it is no longer required.

Definition at line 446 of file queryparser.h.


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