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

---

Field.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_Field_
#define _lucene_document_Field_

#if defined(_LUCENE_PRAGMA_ONCE)
# pragma once
#endif

#include "CLucene/util/Reader.h"
#include "CLucene/util/streambase.h"

CL_NS_DEF(document)
class Field :LUCENE_BASE{
private:
        const TCHAR* _name;
        TCHAR* _stringValue;
        CL_NS(util)::Reader* _readerValue;
    jstreams::StreamBase<char>* _streamValue;

        int config;
        float_t boost;
        bool omitNorms;
public:
        enum Store{ 
                STORE_YES=1, 
                STORE_NO=2,

            STORE_COMPRESS=4
        };

        enum Index{ 
                INDEX_NO=16, 
                INDEX_TOKENIZED=32, 
                INDEX_UNTOKENIZED=64, 
                INDEX_NONORMS=128
        };

        enum TermVector{
                TERMVECTOR_NO=256, 
                TERMVECTOR_YES=512,    
                TERMVECTOR_WITH_POSITIONS=1024,
                TERMVECTOR_WITH_OFFSETS=2048
        };

        _CL_DEPRECATED( another overload ) Field(const TCHAR* name, const TCHAR* value, bool store, bool index, bool token, const bool storeTermVector=false);
        _CL_DEPRECATED( another overload ) Field(const TCHAR* name, CL_NS(util)::Reader* reader, bool store, bool index, bool token, const bool storeTermVector=false);

        Field(const TCHAR* name, const TCHAR* value, int configs);
        Field(const TCHAR* name, CL_NS(util)::Reader* reader, int configs);
        Field(const TCHAR* name, jstreams::StreamBase<char>* stream, int configs);
    ~Field();

        _CL_DEPRECATED( new Field(*) ) static Field* Keyword(const TCHAR* name, const TCHAR* value);

        _CL_DEPRECATED( new Field(*) ) static Field* UnIndexed(const TCHAR* name, const TCHAR* value);

        _CL_DEPRECATED( new Field(*) ) static Field* Text(const TCHAR* name, const TCHAR* value, const bool storeTermVector=false);

        _CL_DEPRECATED( new Field(*) ) static Field* UnStored(const TCHAR* name, const TCHAR* value, const bool storeTermVector=false);

        _CL_DEPRECATED( new Field(*) ) static Field* Text(const TCHAR* name, CL_NS(util)::Reader* value, const bool storeTermVector=false);

        const TCHAR* name(); 

        TCHAR* stringValue(); 

        CL_NS(util)::Reader* readerValue();

        jstreams::StreamBase<char>* streamValue();

        //  True iff the value of the field is to be stored in the index for return
        //      with search hits.  It is an error for this to be true if a field is
        //      Reader-valued. 
        bool isStored();

        //  True iff the value of the field is to be indexed, so that it may be
        //      searched on. 
        bool isIndexed();

        // True iff the value of the field should be tokenized as text prior to
        //      indexing.  Un-tokenized fields are indexed as a single word and may not be
        //      Reader-valued.
        bool isTokenized();
        
        bool isCompressed();

        //Set configs using XOR. This resets all the settings
        //For example, to use term vectors with positions and offsets do:
        //object->setConfig(TERMVECTOR_WITH_POSITIONS | TERMVECTOR_WITH_OFFSETS);
        void setConfig(int termVector);

        bool isTermVectorStored();

        bool isStoreOffsetWithTermVector();
          
        bool isStorePositionWithTermVector();

        float_t getBoost();
      
        void setBoost(float_t value);

        bool isBinary();
        
        bool getOmitNorms();

        void setOmitNorms(bool omitNorms);

        // Prints a Field for human consumption.
        TCHAR* toString();
};
CL_NS_END
#endif

---

clucene.sourceforge.net