MultiTermQuery.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 MULTITERMQUERY_H
#define MULTITERMQUERY_H
 
#include "Query.h"
 
namespace Lucene {

class LPPAPI MultiTermQuery : public Query {
public:
    MultiTermQuery();
    virtual ~MultiTermQuery();
 
    LUCENE_CLASS(MultiTermQuery);
 
protected:
    RewriteMethodPtr rewriteMethod;
    int32_t numberOfTerms;
 
public:
    static RewriteMethodPtr CONSTANT_SCORE_FILTER_REWRITE();

    static RewriteMethodPtr SCORING_BOOLEAN_QUERY_REWRITE();

    static RewriteMethodPtr CONSTANT_SCORE_BOOLEAN_QUERY_REWRITE();

    static RewriteMethodPtr CONSTANT_SCORE_AUTO_REWRITE_DEFAULT();

    int32_t getTotalNumberOfTerms();

    void clearTotalNumberOfTerms();
 
    virtual QueryPtr rewrite(const IndexReaderPtr& reader);

    virtual RewriteMethodPtr getRewriteMethod();

    virtual void setRewriteMethod(const RewriteMethodPtr& method);
 
    virtual LuceneObjectPtr clone(const LuceneObjectPtr& other = LuceneObjectPtr());
    virtual int32_t hashCode();
    virtual bool equals(const LuceneObjectPtr& other);
 
protected:
    virtual FilteredTermEnumPtr getEnum(const IndexReaderPtr& reader) = 0;
 
    void incTotalNumberOfTerms(int32_t inc);
 
    friend class MultiTermQueryWrapperFilter;
    friend class ScoringBooleanQueryRewrite;
    friend class ConstantScoreAutoRewrite;
};

class LPPAPI RewriteMethod : public LuceneObject {
public:
    virtual ~RewriteMethod();
    LUCENE_CLASS(RewriteMethod);
 
public:
    virtual QueryPtr rewrite(const IndexReaderPtr& reader, const MultiTermQueryPtr& query) = 0;
};

class LPPAPI ConstantScoreAutoRewrite : public RewriteMethod {
public:
    ConstantScoreAutoRewrite();
    virtual ~ConstantScoreAutoRewrite();
 
    LUCENE_CLASS(ConstantScoreAutoRewrite);
 
public:
    // Defaults derived from rough tests with a 20.0 million doc Wikipedia index.  With more than 350 terms
    // in the query, the filter method is fastest
    static const int32_t DEFAULT_TERM_COUNT_CUTOFF;
 
    // If the query will hit more than 1 in 1000 of the docs in the index (0.1%), the filter method is fastest
    static const double DEFAULT_DOC_COUNT_PERCENT;
 
protected:
    int32_t termCountCutoff;
    double docCountPercent;
 
public:
    virtual void setTermCountCutoff(int32_t count);

    virtual int32_t getTermCountCutoff();

    virtual void setDocCountPercent(double percent);

    virtual double getDocCountPercent();
 
    virtual QueryPtr rewrite(const IndexReaderPtr& reader, const MultiTermQueryPtr& query);
 
    virtual int32_t hashCode();
    virtual bool equals(const LuceneObjectPtr& other);
};
 
}
 
#endif