documentTermIteratorInterface.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_DOCUMENT_TERM_OCCURRENCE_ITERATOR_INTERFACE_HPP_INCLUDED
#define _STRUS_DOCUMENT_TERM_OCCURRENCE_ITERATOR_INTERFACE_HPP_INCLUDED
#include "strus/index.hpp"
#include <vector>
#include <string>

namespace strus
{

class DocumentTermIteratorInterface
{
public:
        struct Term
        {
                Index tf;               
                Index firstpos;         
                Index termno;           

                Term()
                        :tf(0),firstpos(0),termno(0){}
                Term( Index tf_, Index firstpos_, Index termno_)
                        :tf(tf_),firstpos(firstpos_),termno(termno_){}
                Term( const Term& o)
                        :tf(o.tf),firstpos(o.firstpos),termno(o.termno){}
                void init( Index tf_, Index firstpos_, Index termno_)
                        {tf=tf_; firstpos=firstpos_; termno=termno_;}
        };
        virtual ~DocumentTermIteratorInterface(){}

        virtual Index skipDoc( const Index& docno)=0;

        virtual bool nextTerm( Term& value)=0;

        virtual unsigned int termDocumentFrequency( const Index& termno) const=0;

        virtual std::string termValue( const Index& termno) const=0;
};

}//namespace
#endif