CLucene - a full-featured, c++ search engine
API Documentation

---

Document.h

Go to the documentation of this file.

/*------------------------------------------------------------------------------
* Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team
* 
* Distributable under the terms of either the Apache License (Version 2.0) or 
* the GNU Lesser General Public License, as specified in the COPYING file.
------------------------------------------------------------------------------*/
#ifndef _lucene_document_Document_
#define _lucene_document_Document_

CL_CLASS_DEF(document,Field)



CL_NS_DEF(document)

class Document; //predefine
class DocumentFieldEnumeration :LUCENE_BASE{
    class DocumentFieldList :LUCENE_BASE{
    public:
        DocumentFieldList(Field* f, DocumentFieldList* n);
        ~DocumentFieldList();
        Field* field;
        DocumentFieldList* next;
    };
        friend class Document;
private:
        const DocumentFieldList* fields;
public:
        DocumentFieldEnumeration(const DocumentFieldList* fl);
        ~DocumentFieldEnumeration();
        bool hasMoreElements() const;
        Field* nextElement();
};

class CLUCENE_EXPORT Document:LUCENE_BASE {
private:
        DocumentFieldEnumeration::DocumentFieldList* fieldList;
        float_t boost;
public:
        Document();

        ~Document();

        void setBoost(const float_t boost);
  
        float_t getBoost() const;

        void add(Field& field);

        void removeField(const TCHAR* name);

        void removeFields(const TCHAR* name);

        Field* getField(const TCHAR* name) const;
        
        const TCHAR* get(const TCHAR* field) const;

        _CL_DEPRECATED(  getFields() ) DocumentFieldEnumeration* fields() const;

        DocumentFieldEnumeration* getFields() const;

        TCHAR* toString() const;
        

        TCHAR** getValues(const TCHAR* name);
        
        void clear();
};
CL_NS_END
#endif

---

clucene.sourceforge.net