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


 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::ScoreDoc Class Reference

Expert: Returned by low-level search implementations. More...

#include <ScoreDoc.h>

+ Inheritance diagram for Lucene::ScoreDoc:

Public Member Functions

 ScoreDoc (int32_t doc, double score)
 
virtual ~ScoreDoc ()
 
virtual String getClassName ()
 
boost::shared_ptr< ScoreDocshared_from_this ()
 
virtual String toString ()
 Returns a string representation of the object. More...
 
- 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...
 
- 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 ()
 

Data Fields

double score
 The score of this document for the query. More...
 
int32_t doc
 A hit document's number. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Lucene::LuceneObject
 LuceneObject ()
 
- Protected Attributes inherited from Lucene::LuceneSync
SynchronizePtr objectLock
 
LuceneSignalPtr objectSignal
 

Detailed Description

Expert: Returned by low-level search implementations.

See Also
TopDocs

Constructor & Destructor Documentation

Lucene::ScoreDoc::ScoreDoc ( int32_t  doc,
double  score 
)
virtual Lucene::ScoreDoc::~ScoreDoc ( )
virtual

Member Function Documentation

static String Lucene::ScoreDoc::_getClassName ( )
inlinestatic
virtual String Lucene::ScoreDoc::getClassName ( )
inlinevirtual
boost::shared_ptr< ScoreDoc > Lucene::ScoreDoc::shared_from_this ( )
inline
virtual String Lucene::ScoreDoc::toString ( )
virtual

Returns a string representation of the object.

Reimplemented from Lucene::LuceneObject.

Reimplemented in Lucene::FieldValueHitQueueEntry, and Lucene::FieldDoc.

Field Documentation

int32_t Lucene::ScoreDoc::doc

A hit document's number.

See Also
Searcher::doc(int32_t)
double Lucene::ScoreDoc::score

The score of this document for the query.


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

clucene.sourceforge.net