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


Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Data Fields
Lucene::ValueSourceQuery Class Reference

A Query that sets the scores of document to the values obtained from a ValueSource. More...

#include <ValueSourceQuery.h>

+ Inheritance diagram for Lucene::ValueSourceQuery:

Public Member Functions

 ValueSourceQuery (const ValueSourcePtr &valSrc)
 Create a value source query.
 
virtual ~ValueSourceQuery ()
 
virtual String getClassName ()
 
boost::shared_ptr< ValueSourceQueryshared_from_this ()
 
virtual QueryPtr rewrite (const IndexReaderPtr &reader)
 Called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.
 
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 form.
 
virtual WeightPtr createWeight (const SearcherPtr &searcher)
 Constructs an appropriate Weight implementation for this query. Only implemented by primitive queries, which re-write to themselves.
 
virtual String toString (const String &field)
 Prints a query to a string, with field assumed to be the default field and omitted.
 
virtual bool equals (const LuceneObjectPtr &other)
 Return whether two objects are equal.
 
virtual int32_t hashCode ()
 Return hash code for this object.
 
virtual LuceneObjectPtr clone (const LuceneObjectPtr &other=LuceneObjectPtr())
 Returns a clone of this query.
 
virtual String toString (const String &field)
 Prints a query to a string, with field assumed to be the default field and omitted.
 
virtual String toString ()
 Prints a query to a string.
 
- Public Member Functions inherited from Lucene::Query
 Query ()
 
virtual ~Query ()
 
boost::shared_ptr< Queryshared_from_this ()
 
virtual void setBoost (double b)
 Sets the boost for this query clause to b. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by b.
 
virtual double getBoost ()
 Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by b. The boost is 1.0 by default.
 
virtual WeightPtr weight (const SearcherPtr &searcher)
 Constructs and initializes a Weight for a top-level query.
 
virtual QueryPtr combine (Collection< QueryPtr > queries)
 Called when re-writing queries under MultiSearcher.
 
virtual SimilarityPtr getSimilarity (const SearcherPtr &searcher)
 Returns the Similarity implementation to be used for this query. Subclasses may override this method to specify their own Similarity implementation, perhaps one that delegates through that of the Searcher. By default the Searcher's Similarity implementation is returned.
 
String boostString ()
 Return given boost value as a string.
 
- 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 int32_t compareTo (const LuceneObjectPtr &other)
 Compare two objects.
 
- 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::Query
static String _getClassName ()
 
static QueryPtr mergeBooleanQueries (Collection< BooleanQueryPtr > queries)
 Merges the clauses of a set of BooleanQuery's into a single BooleanQuery.
 

Data Fields

ValueSourcePtr valSrc
 

Additional Inherited Members

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

Detailed Description

A Query that sets the scores of document to the values obtained from a ValueSource.

This query provides a score for each and every undeleted document in the index.

The value source can be based on a (cached) value of an indexed field, but it can also be based on an external source, eg. values read from an external database.

Score is set as: Score(doc,query) = (query.getBoost() * query.getBoost()) * valueSource(doc).

Constructor & Destructor Documentation

◆ ValueSourceQuery()

Lucene::ValueSourceQuery::ValueSourceQuery ( const ValueSourcePtr valSrc)

Create a value source query.

Parameters
valSrcprovides the values defines the function to be used for scoring

◆ ~ValueSourceQuery()

virtual Lucene::ValueSourceQuery::~ValueSourceQuery ( )
virtual

Member Function Documentation

◆ _getClassName()

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

◆ clone()

virtual LuceneObjectPtr Lucene::ValueSourceQuery::clone ( const LuceneObjectPtr other = LuceneObjectPtr())
virtual

Returns a clone of this query.

Reimplemented from Lucene::Query.

◆ createWeight()

virtual WeightPtr Lucene::ValueSourceQuery::createWeight ( const SearcherPtr searcher)
virtual

Constructs an appropriate Weight implementation for this query. Only implemented by primitive queries, which re-write to themselves.

Reimplemented from Lucene::Query.

◆ equals()

virtual bool Lucene::ValueSourceQuery::equals ( const LuceneObjectPtr other)
virtual

Return whether two objects are equal.

Reimplemented from Lucene::Query.

◆ extractTerms()

virtual void Lucene::ValueSourceQuery::extractTerms ( SetTerm  terms)
virtual

Adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten form.

Reimplemented from Lucene::Query.

◆ getClassName()

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

Reimplemented from Lucene::Query.

Reimplemented in Lucene::FieldScoreQuery.

◆ hashCode()

virtual int32_t Lucene::ValueSourceQuery::hashCode ( )
virtual

Return hash code for this object.

Reimplemented from Lucene::Query.

◆ rewrite()

virtual QueryPtr Lucene::ValueSourceQuery::rewrite ( const IndexReaderPtr reader)
virtual

Called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Reimplemented from Lucene::Query.

◆ shared_from_this()

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

◆ toString() [1/3]

virtual String Lucene::Query::toString ( )
virtual

Prints a query to a string.

Reimplemented from Lucene::Query.

◆ toString() [2/3]

virtual String Lucene::Query::toString ( const String &  field)
virtual

Prints a query to a string, with field assumed to be the default field and omitted.

The representation used is one that is supposed to be readable by QueryParser. However, there are the following limitations:

If the query was created by the parser, the printed representation may not be exactly what was parsed. For example, characters that need to be escaped will be represented without the required backslash.

Some of the more complicated queries (eg. span queries) don't have a representation that can be parsed by QueryParser.

Reimplemented from Lucene::Query.

◆ toString() [3/3]

virtual String Lucene::ValueSourceQuery::toString ( const String &  field)
virtual

Prints a query to a string, with field assumed to be the default field and omitted.

The representation used is one that is supposed to be readable by QueryParser. However, there are the following limitations:

If the query was created by the parser, the printed representation may not be exactly what was parsed. For example, characters that need to be escaped will be represented without the required backslash.

Some of the more complicated queries (eg. span queries) don't have a representation that can be parsed by QueryParser.

Reimplemented from Lucene::Query.

Field Documentation

◆ valSrc

ValueSourcePtr Lucene::ValueSourceQuery::valSrc

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

clucene.sourceforge.net