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


lucene::search::Hits Class Reference

#include <SearchHeader.h>

Inheritance diagram for lucene::search::Hits:
lucene::debug::LuceneBase

List of all members.

Public Member Functions

 Hits (Searcher *s, Query *q, Filter *f, const Sort *sort=NULL)
 ~Hits ()
int32_t length () const
 Returns the total number of hits available in this set.
lucene::document::Documentdoc (const int32_t n)
 Returns the stored fields of the nth document in this set.
int32_t id (const int32_t n)
 Returns the id for the nth document in this set.
float_t score (const int32_t n)
 Returns the score for the nth document in this set.

Constructor & Destructor Documentation

lucene::search::Hits::Hits ( Searcher s,
Query q,
Filter f,
const Sort sort = NULL 
)
lucene::search::Hits::~Hits (  ) 

Member Function Documentation

lucene:: document ::Document& lucene::search::Hits::doc ( const int32_t  n  ) 

Returns the stored fields of the nth document in this set.

Documents are cached, so that repeated requests for the same element may return the same Document object.

Memory management:
Memory belongs to the hits object. Don't delete the return value.
int32_t lucene::search::Hits::id ( const int32_t  n  ) 

Returns the id for the nth document in this set.

int32_t lucene::search::Hits::length (  )  const

Returns the total number of hits available in this set.

float_t lucene::search::Hits::score ( const int32_t  n  ) 

Returns the score for the nth document in this set.


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

clucene.sourceforge.net