Lucene++ - a full-featured, c++ search engine
API Documentation
#include <PayloadNearQuery.h>
Public Member Functions | |
PayloadNearSpanScorer (const SpansPtr &spans, const WeightPtr &weight, const SimilarityPtr &similarity, ByteArray norms) | |
virtual | ~PayloadNearSpanScorer () |
virtual String | getClassName () |
boost::shared_ptr< PayloadNearSpanScorer > | shared_from_this () |
void | getPayloads (Collection< SpansPtr > subSpans) |
Get the payloads associated with all underlying subspans. More... | |
virtual double | score () |
Returns the score of the current document matching the query. Initially invalid, until {} or #advance(int32_t)} is called the first time, or when called from within Collector#collect}. More... | |
![]() | |
SpanScorer (const SpansPtr &spans, const WeightPtr &weight, const SimilarityPtr &similarity, ByteArray norms) | |
virtual | ~SpanScorer () |
boost::shared_ptr< SpanScorer > | shared_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. More... | |
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. More... | |
virtual int32_t | docID () |
Returns the following: More... | |
![]() | |
Scorer (const SimilarityPtr &similarity) | |
Constructs a Scorer. More... | |
virtual | ~Scorer () |
boost::shared_ptr< Scorer > | shared_from_this () |
SimilarityPtr | getSimilarity () |
Returns the Similarity implementation used by this scorer. More... | |
virtual void | score (const CollectorPtr &collector) |
Scores and collects all matching documents. More... | |
![]() | |
virtual | ~DocIdSetIterator () |
boost::shared_ptr< DocIdSetIterator > | shared_from_this () |
![]() | |
virtual | ~LuceneObject () |
virtual void | initialize () |
Called directly after instantiation to create objects that depend on this object being fully constructed. More... | |
virtual LuceneObjectPtr | clone (const LuceneObjectPtr &other=LuceneObjectPtr()) |
Return clone of this object. More... | |
virtual int32_t | hashCode () |
Return hash code for this object. More... | |
virtual bool | equals (const LuceneObjectPtr &other) |
Return whether two objects are equal. More... | |
virtual int32_t | compareTo (const LuceneObjectPtr &other) |
Compare two objects. More... | |
virtual String | toString () |
Returns a string representation of the object. More... | |
![]() | |
virtual | ~LuceneSync () |
virtual SynchronizePtr | getSync () |
Return this object synchronize lock. More... | |
virtual LuceneSignalPtr | getSignal () |
Return this object signal. More... | |
virtual void | lock (int32_t timeout=0) |
Lock this object using an optional timeout. More... | |
virtual void | unlock () |
Unlock this object. More... | |
virtual bool | holdsLock () |
Returns true if this object is currently locked by current thread. More... | |
virtual void | wait (int32_t timeout=0) |
Wait for signal using an optional timeout. More... | |
virtual void | notifyAll () |
Notify all threads waiting for signal. More... | |
Static Public Member Functions | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
![]() | |
static String | _getClassName () |
Data Fields | |
SpansPtr | spans |
SimilarityPtr | similarity |
Protected Member Functions | |
void | processPayloads (Collection< ByteArray > payLoads, int32_t start, int32_t end) |
By default, uses the PayloadFunction to score the payloads, but can be overridden to do other things. More... | |
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. More... | |
![]() | |
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. More... | |
![]() | |
LuceneObject () | |
Protected Attributes | |
double | payloadScore |
int32_t | payloadsSeen |
![]() | |
SpansPtr | spans |
WeightPtr | weight |
ByteArray | norms |
double | value |
bool | more |
int32_t | doc |
double | freq |
![]() | |
SimilarityPtr | similarity |
![]() | |
SynchronizePtr | objectLock |
LuceneSignalPtr | objectSignal |
Additional Inherited Members | |
![]() | |
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. More... | |
Lucene::PayloadNearSpanScorer::PayloadNearSpanScorer | ( | const SpansPtr & | spans, |
const WeightPtr & | weight, | ||
const SimilarityPtr & | similarity, | ||
ByteArray | norms | ||
) |
|
virtual |
|
inlinestatic |
|
protectedvirtual |
This method is no longer an official member of Scorer, but it is needed by SpanWeight to build an explanation.
Reimplemented from Lucene::SpanScorer.
|
inlinevirtual |
Reimplemented from Lucene::SpanScorer.
void Lucene::PayloadNearSpanScorer::getPayloads | ( | Collection< SpansPtr > | subSpans | ) |
Get the payloads associated with all underlying subspans.
|
protected |
By default, uses the PayloadFunction to score the payloads, but can be overridden to do other things.
payLoads | The payloads |
start | The start position of the span being scored |
end | The end position of the span being scored |
|
virtual |
Returns the score of the current document matching the query. Initially invalid, until {} or #advance(int32_t)} is called the first time, or when called from within Collector#collect}.
Reimplemented from Lucene::SpanScorer.
|
protectedvirtual |
Reimplemented from Lucene::SpanScorer.
|
inline |
|
protected |
|
protected |
SimilarityPtr Lucene::PayloadNearSpanScorer::similarity |
SpansPtr Lucene::PayloadNearSpanScorer::spans |