common/termlist.h

Go to the documentation of this file.

/* Copyright (C) 2007 Olly Betts
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef XAPIAN_INCLUDED_TERMLIST_H
#define XAPIAN_INCLUDED_TERMLIST_H

#include <string>

#include <xapian/base.h>
#include <xapian/types.h>
#include <xapian/termiterator.h>

namespace Xapian {
    class PositionIterator;
    namespace Internal {
        class ExpandStats;
    }
}

class Xapian::TermIterator::Internal : public Xapian::Internal::RefCntBase {
    void operator=(const Internal &);

    Internal(const Internal &);

  protected:
    Internal() { }

  public:
    virtual ~Internal();

    virtual Xapian::termcount get_approx_size() const = 0;

    virtual void accumulate_stats(Xapian::Internal::ExpandStats & stats) const;

    virtual std::string get_termname() const = 0;

    virtual Xapian::termcount get_wdf() const = 0;

    virtual Xapian::doccount get_termfreq() const = 0;

    virtual Xapian::termcount get_collection_freq() const;

    virtual Internal * next() = 0;

    virtual Internal * skip_to(const std::string &term);

    virtual bool at_end() const = 0;

    virtual Xapian::termcount positionlist_count() const = 0;

    virtual Xapian::PositionIterator positionlist_begin() const = 0;
};

// In the external API headers, this class is Xapian::TermIterator::Internal,
// but in the library code it's still known as "TermList" in most places.
typedef Xapian::TermIterator::Internal TermList;

#endif // XAPIAN_INCLUDED_TERMLIST_H

---