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


lucene::search::ConjunctionScorer Class Reference

Scorer for conjunctions, sets of queries, all of which are required. More...

#include <ConjunctionScorer.h>

Inheritance diagram for lucene::search::ConjunctionScorer:
lucene::search::Scorer lucene::debug::LuceneBase

List of all members.

Public Member Functions

 ConjunctionScorer (Similarity *similarity)
virtual ~ConjunctionScorer ()
TCHAR * toString (void)
 Returns an string which explains the object.
void add (Scorer *scorer)
int32_t doc () const
 Returns the current document number.
bool next ()
 Advance to the next document matching the query.
bool skipTo (int32_t target)
 Skips to the first match beyond the current whose document number is greater than or equal to target.
float_t score ()
 Returns the score of the current document.
virtual void explain (int32_t doc, Explanation *ret)
 Returns an explanation of the score for doc.

Detailed Description

Scorer for conjunctions, sets of queries, all of which are required.


Constructor & Destructor Documentation

lucene::search::ConjunctionScorer::ConjunctionScorer ( Similarity similarity  ) 
virtual lucene::search::ConjunctionScorer::~ConjunctionScorer (  )  [virtual]

Member Function Documentation

void lucene::search::ConjunctionScorer::add ( Scorer scorer  ) 
int32_t lucene::search::ConjunctionScorer::doc (  )  const [virtual]

Returns the current document number.

Initially invalid, until next() is called the first time.

Implements lucene::search::Scorer.

virtual void lucene::search::ConjunctionScorer::explain ( int32_t  doc,
Explanation ret 
) [inline, virtual]

Returns an explanation of the score for doc.

Implements lucene::search::Scorer.

References _CLTHROWA, and CL_ERR_UnsupportedOperation.

bool lucene::search::ConjunctionScorer::next (  )  [virtual]

Advance to the next document matching the query.

Returns true iff there is another match.

Implements lucene::search::Scorer.

float_t lucene::search::ConjunctionScorer::score (  )  [virtual]

Returns the score of the current document.

Initially invalid, until next() is called the first time.

Implements lucene::search::Scorer.

bool lucene::search::ConjunctionScorer::skipTo ( int32_t  target  )  [virtual]

Skips to the first match beyond the current whose document number is greater than or equal to target.

Returns true iff there is such a match.

Behaves as if written:

   boolean skipTo(int32_t target) {
     do {
       if (!next())
 	     return false;
     } while (target > doc());
     return true;
   }
 

Most implementations are considerably more efficient than that.

Implements lucene::search::Scorer.

TCHAR* lucene::search::ConjunctionScorer::toString ( void   )  [inline, virtual]

Returns an string which explains the object.

Implements lucene::search::Scorer.

References _T, and STRDUP_TtoT.


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

clucene.sourceforge.net