Lucene::PayloadNearSpanScorer Class Reference

#include <PayloadNearQuery.h>

Inheritance diagram for Lucene::PayloadNearSpanScorer:

Public Member Functions
	PayloadNearSpanScorer (SpansPtr spans, WeightPtr weight, 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 nextDoc() or advance(int32_t) is called the first time, or when called from within Collector#collect. More...
Public Member Functions inherited from Lucene::SpanScorer
	SpanScorer (SpansPtr spans, WeightPtr weight, 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...
Public Member Functions inherited from Lucene::Scorer
	Scorer (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 (CollectorPtr collector)
	Scores and collects all matching documents. More...
Public Member Functions inherited from Lucene::DocIdSetIterator
virtual	~DocIdSetIterator ()
boost::shared_ptr < DocIdSetIterator >	shared_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. More...
virtual LuceneObjectPtr	clone (LuceneObjectPtr other=LuceneObjectPtr())
	Return clone of this object. More...
virtual int32_t	hashCode ()
	Return hash code for this object. More...
virtual bool	equals (LuceneObjectPtr other)
	Return whether two objects are equal. More...
virtual int32_t	compareTo (LuceneObjectPtr other)
	Compare two objects. More...
virtual String	toString ()
	Returns a string representation of the object. More...
Public Member Functions inherited from Lucene::LuceneSync
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 Public Member Functions inherited from Lucene::SpanScorer
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 ()

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...

Protected Attributes
double	payloadScore
int32_t	payloadsSeen
Protected Attributes inherited from Lucene::SpanScorer
SpansPtr	spans
WeightPtr	weight
ByteArray	norms
double	value
bool	more
int32_t	doc
double	freq
Protected Attributes inherited from Lucene::Scorer
SimilarityPtr	similarity

Additional Inherited Members
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. More...

Constructor & Destructor Documentation

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

virtual Lucene::PayloadNearSpanScorer::~PayloadNearSpanScorer ( )

virtual

Member Function Documentation

static String Lucene::PayloadNearSpanScorer::_getClassName ( )

inlinestatic

virtual ExplanationPtr Lucene::PayloadNearSpanScorer::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 from Lucene::SpanScorer.

virtual String Lucene::PayloadNearSpanScorer::getClassName ( )

inlinevirtual

Reimplemented from Lucene::SpanScorer.

void Lucene::PayloadNearSpanScorer::getPayloads

(

Collection< SpansPtr >

subSpans)

Get the payloads associated with all underlying subspans.

void Lucene::PayloadNearSpanScorer::processPayloads ( Collection< ByteArray >  payLoads, int32_t  start, int32_t  end  )

protected

By default, uses the PayloadFunction to score the payloads, but can be overridden to do other things.

Parameters

payLoads	The payloads
start	The start position of the span being scored
end	The end position of the span being scored

See Also

Spans

virtual double Lucene::PayloadNearSpanScorer::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.

Reimplemented from Lucene::SpanScorer.

virtual bool Lucene::PayloadNearSpanScorer::setFreqCurrentDoc ( )

protectedvirtual

Reimplemented from Lucene::SpanScorer.

boost::shared_ptr< PayloadNearSpanScorer > Lucene::PayloadNearSpanScorer::shared_from_this ( )

inline

Field Documentation

double Lucene::PayloadNearSpanScorer::payloadScore

protected

int32_t Lucene::PayloadNearSpanScorer::payloadsSeen

protected

SimilarityPtr Lucene::PayloadNearSpanScorer::similarity

SpansPtr Lucene::PayloadNearSpanScorer::spans

---

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

• PayloadNearQuery.h