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

---

SearchHeader.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
* Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team
* 
* Distributable under the terms of either the Apache License (Version 2.0) or 
* the GNU Lesser General Public License, as specified in the COPYING file.
------------------------------------------------------------------------------*/
#ifndef _lucene_search_SearchHeader_
#define _lucene_search_SearchHeader_


//#include "CLucene/index/IndexReader.h"
CL_CLASS_DEF(index,Term)
CL_CLASS_DEF(index,IndexReader)
//#include "Filter.h"
CL_CLASS_DEF(document,Document)
CL_CLASS_DEF(util,Comparable)
//#include "Sort.h"
//#include "CLucene/util/VoidList.h"
//#include "Explanation.h"
//#include "Similarity.h"

CL_NS_DEF(search)

        class Query;
        class Scorer;
        class Explanation;
        class Hits;
        class Sort;
        class FieldDoc;
        class TopFieldDocs;
   
        struct ScoreDoc {
                int32_t doc;

                float_t score;
        };

        class TopDocs:LUCENE_BASE {
        public:
                int32_t totalHits;

                ScoreDoc* scoreDocs;
                int32_t scoreDocsLength;

                TopDocs(const int32_t th, ScoreDoc* sds, int32_t scoreDocsLength);
                ~TopDocs();

        private:
                //float_t maxScore;
        };

    // Lower-level search API.
    // @see Searcher#search(Query,HitCollector)
        class HitCollector: LUCENE_BASE {
    public:
      virtual void collect(const int32_t doc, const float_t score) = 0;
                virtual ~HitCollector(){}
    };

        class Weight: LUCENE_BASE {
    public:
                virtual ~Weight(){
                };

      virtual Query* getQuery() = 0;

      virtual float_t getValue() = 0;

      virtual float_t sumOfSquaredWeights() = 0;

      virtual void normalize(float_t norm) = 0;

      virtual Scorer* scorer(CL_NS(index)::IndexReader* reader) = 0;

      virtual void explain(CL_NS(index)::IndexReader* reader, int32_t doc, Explanation* ret) = 0;

      virtual TCHAR* toString();
   };

   class HitDoc:LUCENE_BASE {
    public:
                float_t score;
                int32_t id;
                CL_NS(document)::Document* doc;
                
                HitDoc* next;                                     // in doubly-linked cache
                HitDoc* prev;                                     // in doubly-linked cache
                
                HitDoc(const float_t s, const int32_t i);
                ~HitDoc();
    };


CL_NS_END
#endif

---

clucene.sourceforge.net