CustomScoreQuery.h

Go to the documentation of this file.

// Copyright (c) 2009-2014 Alan Wright. All rights reserved.
// Distributable under the terms of either the Apache License (Version 2.0)
// or the GNU Lesser General Public License.
 
#ifndef CUSTOMSCOREQUERY_H
#define CUSTOMSCOREQUERY_H
 
#include "Query.h"
 
namespace Lucene {

class LPPAPI CustomScoreQuery : public Query {
public:
    CustomScoreQuery(const QueryPtr& subQuery);

    CustomScoreQuery(const QueryPtr& subQuery, const ValueSourceQueryPtr& valSrcQuery);

    CustomScoreQuery(const QueryPtr& subQuery, Collection<ValueSourceQueryPtr> valSrcQueries);
 
    virtual ~CustomScoreQuery();
 
    LUCENE_CLASS(CustomScoreQuery);
 
protected:
    QueryPtr subQuery;
    Collection<ValueSourceQueryPtr> valSrcQueries; // never null (empty array if there are no valSrcQueries).
    bool strict; // if true, valueSource part of query does not take part in weights normalization.
 
public:
    using Query::toString;
 
    virtual QueryPtr rewrite(const IndexReaderPtr& reader);
    virtual void extractTerms(SetTerm terms);
    virtual LuceneObjectPtr clone(const LuceneObjectPtr& other = LuceneObjectPtr());
    virtual String toString(const String& field);
    virtual bool equals(const LuceneObjectPtr& other);
    virtual int32_t hashCode();

    virtual double customScore(int32_t doc, double subQueryScore, Collection<double> valSrcScores);

    virtual double customScore(int32_t doc, double subQueryScore, double valSrcScore);

    virtual ExplanationPtr customExplain(int32_t doc, const ExplanationPtr& subQueryExpl, Collection<ExplanationPtr> valSrcExpls);

    virtual ExplanationPtr customExplain(int32_t doc, const ExplanationPtr& subQueryExpl, const ExplanationPtr& valSrcExpl);
 
    virtual WeightPtr createWeight(const SearcherPtr& searcher);

    virtual bool isStrict();

    virtual void setStrict(bool strict);

    virtual String name();
 
protected:
    void ConstructQuery(const QueryPtr& subQuery, Collection<ValueSourceQueryPtr> valSrcQueries);

    virtual CustomScoreProviderPtr getCustomScoreProvider(const IndexReaderPtr& reader);
 
    friend class CustomWeight;
    friend class CustomScorer;
};
 
}
 
#endif