postingIteratorInterface.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_ITERATOR_INTERFACE_HPP_INCLUDED
#define _STRUS_POSTING_ITERATOR_INTERFACE_HPP_INCLUDED
#include "strus/index.hpp"
#include <vector>

namespace strus
{

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

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

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

        virtual Index skipPos( const Index& firstpos)=0;

        virtual const char* featureid() const=0;

        virtual Index documentFrequency() const=0;

        virtual unsigned int frequency()=0;

        virtual Index docno() const=0;

        virtual Index posno() const=0;

        virtual Index length() const=0;
};

}//namespace
#endif