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


Query.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3 // Distributable under the terms of either the Apache License (Version 2.0)
4 // or the GNU Lesser General Public License.
6 
7 #ifndef QUERY_H
8 #define QUERY_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
31 class LPPAPI Query : public LuceneObject {
32 public:
33  Query();
34  virtual ~Query();
35 
37 
38 protected:
39  double boost; // query boost factor
40 
41 public:
44  virtual void setBoost(double b);
45 
48  virtual double getBoost();
49 
61  virtual String toString(const String& field);
62 
64  virtual String toString();
65 
68  virtual WeightPtr createWeight(const SearcherPtr& searcher);
69 
71  virtual WeightPtr weight(const SearcherPtr& searcher);
72 
75  virtual QueryPtr rewrite(const IndexReaderPtr& reader);
76 
85 
88  virtual void extractTerms(SetTerm terms);
89 
94 
98  virtual SimilarityPtr getSimilarity(const SearcherPtr& searcher);
99 
102 
103  virtual int32_t hashCode();
104  virtual bool equals(const LuceneObjectPtr& other);
105 
107  String boostString();
108 };
109 
110 }
111 
112 #endif
Lucene::Query::boost
double boost
Definition: Query.h:36
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene::Collection< QueryPtr >
Lucene::LuceneObjectPtr
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition: LuceneTypes.h:539
Lucene::QueryPtr
boost::shared_ptr< Query > QueryPtr
Definition: LuceneTypes.h:420
Lucene::Query::weight
virtual WeightPtr weight(const SearcherPtr &searcher)
Constructs and initializes a Weight for a top-level query.
Lucene::Query::~Query
virtual ~Query()
Lucene::Query::extractTerms
virtual void extractTerms(SetTerm terms)
Adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten...
Lucene::Query::rewrite
virtual QueryPtr rewrite(const IndexReaderPtr &reader)
Called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into ...
Lucene::Query::setBoost
virtual void setBoost(double b)
Sets the boost for this query clause to b. Documents matching this clause will (in addition to the no...
Lucene::Query::Query
Query()
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::Query::getSimilarity
virtual SimilarityPtr getSimilarity(const SearcherPtr &searcher)
Returns the Similarity implementation to be used for this query. Subclasses may override this method ...
Lucene::WeightPtr
boost::shared_ptr< Weight > WeightPtr
Definition: LuceneTypes.h:480
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Lucene::IndexReaderPtr
boost::shared_ptr< IndexReader > IndexReaderPtr
Definition: LuceneTypes.h:157
Lucene::Query::hashCode
virtual int32_t hashCode()
Return hash code for this object.
Lucene::Query::clone
virtual LuceneObjectPtr clone(const LuceneObjectPtr &other=LuceneObjectPtr())
Returns a clone of this query.
Lucene::Query
The abstract base class for queries.
Definition: Query.h:31
Lucene::Query::mergeBooleanQueries
static QueryPtr mergeBooleanQueries(Collection< BooleanQueryPtr > queries)
Merges the clauses of a set of BooleanQuery's into a single BooleanQuery.
Lucene::Query::equals
virtual bool equals(const LuceneObjectPtr &other)
Return whether two objects are equal.
Lucene::Query::createWeight
virtual WeightPtr createWeight(const SearcherPtr &searcher)
Constructs an appropriate Weight implementation for this query. Only implemented by primitive queries...
Lucene::SimilarityPtr
boost::shared_ptr< Similarity > SimilarityPtr
Definition: LuceneTypes.h:435
Lucene::Query::combine
virtual QueryPtr combine(Collection< QueryPtr > queries)
Called when re-writing queries under MultiSearcher.
Lucene::Query::boostString
String boostString()
Return given boost value as a string.
Lucene::Query::getBoost
virtual double getBoost()
Gets the boost for this clause. Documents matching this clause will (in addition to the normal weight...
Lucene::SearcherPtr
boost::shared_ptr< Searcher > SearcherPtr
Definition: LuceneTypes.h:434
LuceneObject.h

clucene.sourceforge.net