valuelist.h

Go to the documentation of this file.

/* Copyright (C) 2007,2008 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_VALUELIST_H
#define XAPIAN_INCLUDED_VALUELIST_H

#include <string>

#include "xapian/intrusive_ptr.h"
#include <xapian/types.h>
#include <xapian/valueiterator.h>

class Xapian::ValueIterator::Internal : public Xapian::Internal::intrusive_base {
    void operator=(const Internal &);

    Internal(const Internal &);

  protected:
    Internal() { }

  public:
    virtual ~Internal();

    virtual Xapian::docid get_docid() const = 0;

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

    virtual Xapian::valueno get_valueno() const = 0;

    virtual bool at_end() const = 0;

    virtual void next() = 0;

    virtual void skip_to(Xapian::docid) = 0;

    virtual bool check(Xapian::docid did);

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

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

#endif // XAPIAN_INCLUDED_VALUELIST_H