summarizerFunctionInstanceInterface.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_SUMMARIZER_FUNCTION_INSTANCE_INTERFACE_HPP_INCLUDED
#define _STRUS_SUMMARIZER_FUNCTION_INSTANCE_INTERFACE_HPP_INCLUDED
#include "strus/globalStatistics.hpp"
#include <string>

namespace strus
{

class NumericVariant;
class StorageClientInterface;
class QueryProcessorInterface;
class MetaDataReaderInterface;
class SummarizerFunctionContextInterface;


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

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

        virtual void addNumericParameter(
                        const std::string& name,
                        const NumericVariant& value)=0;

        virtual void defineResultName(
                        const std::string& resultname,
                        const std::string& itemname)=0;

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

        virtual SummarizerFunctionContextInterface* createFunctionContext(
                        const StorageClientInterface* storage_,
                        MetaDataReaderInterface* metadata_,
                        const GlobalStatistics& stats) const=0;

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

}//namespace
#endif