postingJoinOperatorInterface.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_POSTING_JOIN_OPERATOR_INTERFACE_HPP_INCLUDED
#define _STRUS_POSTING_JOIN_OPERATOR_INTERFACE_HPP_INCLUDED
#include "strus/postingIteratorInterface.hpp"
#include "strus/reference.hpp"
#include <vector>
#include <string>

namespace strus
{
class PostingIteratorInterface;

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

        virtual PostingIteratorInterface* createResultIterator(
                        const std::vector<Reference<PostingIteratorInterface> >& argitrs,
                        int range,
                        unsigned int cardinality) const=0;

        struct Description
        {
                Description()
                        :m_name(),m_text(){}
                Description( const std::string& name_, const std::string& text_)
                        :m_name(name_),m_text(text_){}
                Description( const Description& o)
                        :m_name(o.m_name),m_text(o.m_text){}

                const std::string& name() const                 {return m_name;}
                const std::string& text() const                 {return m_text;}

        private:
                std::string m_name;             
                std::string m_text;             
        };

        virtual Description getDescription() const=0;
};

}//namespace
#endif