queryEvalInterface.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_EVAL_INTERFACE_HPP_INCLUDED
#define _STRUS_QUERY_EVAL_INTERFACE_HPP_INCLUDED
#include <iostream>
#include <vector>

namespace strus
{
class QueryInterface;
class StorageClientInterface;
class WeightingFunctionInstanceInterface;
class SummarizerFunctionInstanceInterface;
class ScalarFunctionInterface;
class QueryProcessorInterface;

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

        virtual void addTerm(
                        const std::string& set_,
                        const std::string& type_,
                        const std::string& value_)=0;

        virtual void addSelectionFeature( const std::string& set_)=0;

        virtual void addRestrictionFeature( const std::string& set_)=0;

        virtual void addExclusionFeature( const std::string& set_)=0;

        virtual std::vector<std::string> getWeightingFeatureSets() const=0;

        virtual std::vector<std::string> getSelectionFeatureSets() const=0;

        virtual std::vector<std::string> getRestrictionFeatureSets() const=0;

        virtual std::vector<std::string> getExclusionFeatureSets() const=0;

        class FeatureParameter
        {
        public:
                FeatureParameter(
                                const std::string& parameterName_,
                                const std::string& featureSet_)
                        :m_parameterName(parameterName_),m_featureSet(featureSet_){}
                FeatureParameter(
                                const FeatureParameter& o)
                        :m_parameterName(o.m_parameterName),m_featureSet(o.m_featureSet){}

                const std::string& parameterName() const        {return m_parameterName;}
                const std::string& featureSet() const           {return m_featureSet;}

        private:
                std::string m_parameterName;
                std::string m_featureSet;
        };

        virtual void addSummarizerFunction(
                        const std::string& functionName,
                        SummarizerFunctionInstanceInterface* function,
                        const std::vector<FeatureParameter>& featureParameters,
                        const std::string& debugAttributeName=std::string())=0;

        virtual void addWeightingFunction(
                        const std::string& functionName,
                        WeightingFunctionInstanceInterface* function,
                        const std::vector<FeatureParameter>& featureParameters,
                        const std::string& debugAttributeName=std::string())=0;

        virtual void defineWeightingFormula(
                        ScalarFunctionInterface* combinefunc)=0;

        virtual QueryInterface* createQuery(
                        const StorageClientInterface* storage) const=0;
};

}//namespace
#endif