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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions
Lucene::PayloadNearSpanWeight Class Reference

#include <PayloadNearQuery.h>

+ Inheritance diagram for Lucene::PayloadNearSpanWeight:

Public Member Functions

 PayloadNearSpanWeight (const SpanQueryPtr &query, const SearcherPtr &searcher)
 
virtual ~PayloadNearSpanWeight ()
 
virtual String getClassName ()
 
boost::shared_ptr< PayloadNearSpanWeightshared_from_this ()
 
virtual ScorerPtr scorer (const IndexReaderPtr &reader, bool scoreDocsInOrder, bool topScorer)
 Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.
 
- Public Member Functions inherited from Lucene::SpanWeight
 SpanWeight (const SpanQueryPtr &query, const SearcherPtr &searcher)
 
virtual ~SpanWeight ()
 
boost::shared_ptr< SpanWeightshared_from_this ()
 
virtual QueryPtr getQuery ()
 The query that this concerns.
 
virtual double getValue ()
 The weight for this query.
 
virtual double sumOfSquaredWeights ()
 The sum of squared weights of contained query clauses.
 
virtual void normalize (double norm)
 Assigns the query normalization factor to this.
 
virtual ExplanationPtr explain (const IndexReaderPtr &reader, int32_t doc)
 An explanation of the score computation for the named document.
 
- Public Member Functions inherited from Lucene::Weight
virtual ~Weight ()
 
boost::shared_ptr< Weightshared_from_this ()
 
virtual bool scoresDocsOutOfOrder ()
 Returns true if this implementation scores docs only out of order. This method is used in conjunction with Collector's acceptsDocsOutOfOrder and scorer(IndexReaderPtr, bool, bool) to create a matching Scorer instance for a given Collector, or vice versa.
 
- 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::SpanWeight
static String _getClassName ()
 
- Static Public Member Functions inherited from Lucene::Weight
static String _getClassName ()
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::SpanWeight
SimilarityPtr similarity
 
double value
 
double idf
 
double queryNorm
 
double queryWeight
 
SetTerm terms
 
SpanQueryPtr query
 
IDFExplanationPtr idfExp
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Constructor & Destructor Documentation

◆ PayloadNearSpanWeight()

Lucene::PayloadNearSpanWeight::PayloadNearSpanWeight ( const SpanQueryPtr query,
const SearcherPtr searcher 
)

◆ ~PayloadNearSpanWeight()

virtual Lucene::PayloadNearSpanWeight::~PayloadNearSpanWeight ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ getClassName()

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

Reimplemented from Lucene::SpanWeight.

◆ scorer()

virtual ScorerPtr Lucene::PayloadNearSpanWeight::scorer ( const IndexReaderPtr reader,
bool  scoreDocsInOrder,
bool  topScorer 
)
virtual

Returns a Scorer which scores documents in/out-of order according to scoreDocsInOrder.

NOTE: even if scoreDocsInOrder is false, it is recommended to check whether the returned Scorer indeed scores documents out of order (ie., call scoresDocsOutOfOrder()), as some Scorer implementations will always return documents in-order.

NOTE: null can be returned if no documents will be scored by this query.

Parameters
readerThe IndexReader for which to return the Scorer.
scoreDocsInOrderSpecifies whether in-order scoring of documents is required. Note that if set to false (i.e., out-of-order scoring is required), this method can return whatever scoring mode it supports, as every in-order scorer is also an out-of-order one. However, an out-of-order scorer may not support Scorer#nextDoc() and/or Scorer#advance(int), therefore it is recommended to request an in-order scorer if use of these methods is required.
topScorerIf true, Scorer#score(CollectorPtr) will be called; if false, Scorer#nextDoc() and/or Scorer#advance(int) will be called.
Returns
a Scorer which scores documents in/out-of order.

Reimplemented from Lucene::SpanWeight.

◆ shared_from_this()

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

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

clucene.sourceforge.net