common/documentterm.h

Go to the documentation of this file.

/* documentterm.h: internal class representing a term in a modified document
 *
 * Copyright 1999,2000,2001 BrightStation PLC
 * Copyright 2002 Ananova Ltd
 * Copyright 2003,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 OM_HGUARD_DOCUMENTTERM_H
#define OM_HGUARD_DOCUMENTTERM_H

#include "omdebug.h"

#include <string>
#include <vector>

#include <xapian/types.h>

using namespace std;

class OmDocumentTerm {
    public:
    OmDocumentTerm(const string & tname_, Xapian::termcount wdf_)
        : tname(tname_), wdf(wdf_)
    {
        DEBUGAPICALL(void, "OmDocumentTerm::OmDocumentTerm",
                     tname_ << ", " << wdf_);
    }

    string tname;

    Xapian::termcount wdf;

    typedef vector<Xapian::termpos> term_positions;

    term_positions positions;

    void add_position(Xapian::termpos tpos);

    void remove_position(Xapian::termpos tpos);

    void inc_wdf(Xapian::termcount inc) { wdf += inc; }

    void dec_wdf(Xapian::termcount dec) {
        if (wdf <= dec) {
            wdf = 0;
        } else {
            wdf -= dec;
        }
    }

    Xapian::termcount get_wdf() { return wdf; }

    string get_description() const;
};

#endif // OM_HGUARD_DOCUMENTTERM_H

---