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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
Lucene::SpanScorer Class Reference

Public for extension only. More...

#include <SpanScorer.h>

+ Inheritance diagram for Lucene::SpanScorer:

Public Member Functions

 SpanScorer (const SpansPtr &spans, const WeightPtr &weight, const SimilarityPtr &similarity, ByteArray norms)
 
virtual ~SpanScorer ()
 
virtual String getClassName ()
 
boost::shared_ptr< SpanScorershared_from_this ()
 
virtual int32_t nextDoc ()
 Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.
 
virtual int32_t advance (int32_t target)
 Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set.
 
virtual int32_t docID ()
 Returns the following:
 
virtual double score ()
 Returns the score of the current document matching the query. Initially invalid, until nextDoc() or advance(int32_t) is called the first time, or when called from within Collector#collect.
 
virtual float termFreq ()
 
- Public Member Functions inherited from Lucene::Scorer
 Scorer (const SimilarityPtr &similarity)
 Constructs a Scorer.
 
 Scorer (const WeightPtr &weight)
 
virtual ~Scorer ()
 
boost::shared_ptr< Scorershared_from_this ()
 
SimilarityPtr getSimilarity ()
 Returns the Similarity implementation used by this scorer.
 
virtual void score (const CollectorPtr &collector)
 Scores and collects all matching documents.
 
void visitSubScorers (QueryPtr parent, BooleanClause::Occur relationship, ScorerVisitor *visitor)
 
void visitScorers (ScorerVisitor *visitor)
 
- Public Member Functions inherited from Lucene::DocIdSetIterator
virtual ~DocIdSetIterator ()
 
boost::shared_ptr< DocIdSetIteratorshared_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::Scorer
static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::DocIdSetIterator
static String _getClassName ()
 

Protected Member Functions

virtual bool setFreqCurrentDoc ()
 
virtual ExplanationPtr explain (int32_t doc)
 This method is no longer an official member of Scorer, but it is needed by SpanWeight to build an explanation.
 
- Protected Member Functions inherited from Lucene::Scorer
virtual bool score (const CollectorPtr &collector, int32_t max, int32_t firstDocID)
 Collects matching documents in a range. Hook for optimization. Note, firstDocID is added to ensure that nextDoc() was called before this method.
 
- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 

Protected Attributes

SpansPtr spans
 
WeightPtr weight
 
ByteArray norms
 
double value
 
bool more
 
int32_t doc
 
double freq
 
- Protected Attributes inherited from Lucene::Scorer
SimilarityPtr similarity
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Additional Inherited Members

- Data Fields inherited from Lucene::Scorer
WeightPtr weight
 
- Static Public Attributes inherited from Lucene::DocIdSetIterator
static const int32_t NO_MORE_DOCS
 When returned by nextDoc(), advance(int) and docID() it means there are no more docs in the iterator.
 

Detailed Description

Public for extension only.

Constructor & Destructor Documentation

◆ SpanScorer()

Lucene::SpanScorer::SpanScorer ( const SpansPtr spans,
const WeightPtr weight,
const SimilarityPtr similarity,
ByteArray  norms 
)

◆ ~SpanScorer()

virtual Lucene::SpanScorer::~SpanScorer ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ advance()

virtual int32_t Lucene::SpanScorer::advance ( int32_t  target)
virtual

Advances to the first beyond the current whose document number is greater than or equal to target. Returns the current document number or NO_MORE_DOCS if there are no more docs in the set.

Behaves as if written:

int32_t advance(int32_t target)
{
    int32_t doc;
    while ((doc = nextDoc()) < target)
    { }
    return doc;
}

Some implementations are considerably more efficient than that.

NOTE: certain implementations may return a different value (each time) if called several times in a row with the same target.

NOTE: this method may be called with {@value NO_MORE_DOCS} for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behaviour.

Implements Lucene::DocIdSetIterator.

◆ docID()

virtual int32_t Lucene::SpanScorer::docID ( )
virtual

Returns the following:

Implements Lucene::DocIdSetIterator.

◆ explain()

virtual ExplanationPtr Lucene::SpanScorer::explain ( int32_t  doc)
protectedvirtual

This method is no longer an official member of Scorer, but it is needed by SpanWeight to build an explanation.

Reimplemented in Lucene::PayloadNearSpanScorer.

◆ getClassName()

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

Reimplemented from Lucene::Scorer.

Reimplemented in Lucene::PayloadNearSpanScorer.

◆ nextDoc()

virtual int32_t Lucene::SpanScorer::nextDoc ( )
virtual

Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if there are no more docs in the set.

NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behaviour.

Implements Lucene::DocIdSetIterator.

◆ score()

virtual double Lucene::SpanScorer::score ( )
virtual

Returns the score of the current document matching the query. Initially invalid, until nextDoc() or advance(int32_t) is called the first time, or when called from within Collector#collect.

Implements Lucene::Scorer.

Reimplemented in Lucene::PayloadNearSpanScorer.

◆ setFreqCurrentDoc()

virtual bool Lucene::SpanScorer::setFreqCurrentDoc ( )
protectedvirtual

Reimplemented in Lucene::PayloadNearSpanScorer.

◆ shared_from_this()

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

◆ termFreq()

virtual float Lucene::SpanScorer::termFreq ( )
inlinevirtual

Reimplemented from Lucene::Scorer.

Field Documentation

◆ doc

int32_t Lucene::SpanScorer::doc
protected

◆ freq

double Lucene::SpanScorer::freq
protected

◆ more

bool Lucene::SpanScorer::more
protected

◆ norms

ByteArray Lucene::SpanScorer::norms
protected

◆ spans

SpansPtr Lucene::SpanScorer::spans
protected

◆ value

double Lucene::SpanScorer::value
protected

◆ weight

WeightPtr Lucene::SpanScorer::weight
protected

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

clucene.sourceforge.net