queryInterface.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014 Patrick P. Frey
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
#ifndef _STRUS_QUERY_INTERFACE_HPP_INCLUDED
#define _STRUS_QUERY_INTERFACE_HPP_INCLUDED
#include "strus/storageClientInterface.hpp"
#include "strus/metaDataRestrictionInterface.hpp"
#include "strus/queryResult.hpp"
#include "strus/numericVariant.hpp"
#include "strus/termStatistics.hpp"
#include "strus/globalStatistics.hpp"
#include <string>
#include <vector>
#include <utility>
#include <iostream>

namespace strus {

class PostingJoinOperatorInterface;

class QueryInterface
{
public:
        virtual ~QueryInterface(){}

        virtual void pushTerm(
                        const std::string& type_,
                        const std::string& value_,
                        const Index& length_)=0;

        virtual void pushDocField(
                        const std::string& metadataRangeStart,
                        const std::string& metadataRangeEnd)=0;

        virtual void pushExpression(
                        const PostingJoinOperatorInterface* operation,
                        unsigned int argc, int range, unsigned int cardinality)=0;

        virtual void attachVariable( const std::string& name_)=0;

        virtual void defineFeature( const std::string& set_, double weight_=1.0)=0;

        virtual void defineTermStatistics(
                        const std::string& type_,
                        const std::string& value_,
                        const TermStatistics& stats_)=0;

        virtual void defineGlobalStatistics(
                        const GlobalStatistics& stats_)=0;

        virtual void addMetaDataRestrictionCondition(
                        const MetaDataRestrictionInterface::CompareOperator& opr,
                        const std::string& name,
                        const NumericVariant& operand,
                        bool newGroup=true)=0;

        virtual void addDocumentEvaluationSet(
                        const std::vector<Index>& docnolist_)=0;

        virtual void addAccess( const std::string& username_)=0;

        virtual void setMaxNofRanks( std::size_t maxNofRanks_)=0;
        virtual void setMinRank( std::size_t minRank_)=0;

        virtual void setWeightingVariableValue( const std::string& name, double value)=0;

        virtual void setDebugMode( bool debug)=0;

        virtual QueryResult evaluate() const=0;

        virtual std::string tostring() const=0;
};

}//namespace
#endif