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

Fieldable.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2014 Alan Wright. All rights reserved.
3 // Distributable under the terms of either the Apache License (Version 2.0)
4 // or the GNU Lesser General Public License.
6
7 #ifndef FIELDABLE_H
8 #define FIELDABLE_H
9
10 #include "LuceneObject.h"
11
12 namespace Lucene {
13
20 class LPPAPI Fieldable {
21 public:
22 LUCENE_INTERFACE(Fieldable);
23 virtual ~Fieldable() {}
24
25 public:
40 virtual void setBoost(double boost) = 0;
41
49 virtual double getBoost() = 0;
50
52 virtual String name() = 0;
53
63 virtual String stringValue() = 0;
64
67 virtual ReaderPtr readerValue() = 0;
68
71 virtual TokenStreamPtr tokenStreamValue() = 0;
72
74 virtual bool isStored() = 0;
75
77 virtual bool isIndexed() = 0;
78
81 virtual bool isTokenized() = 0;
82
87 virtual bool isTermVectorStored() = 0;
88
91 virtual bool isStoreOffsetWithTermVector() = 0;
92
94 virtual bool isStorePositionWithTermVector() = 0;
95
97 virtual bool isBinary() = 0;
98
100 virtual bool getOmitNorms() = 0;
101
104 virtual void setOmitNorms(bool omitNorms) = 0;
105
111 virtual bool isLazy() = 0;
112
116 virtual int32_t getBinaryOffset() = 0;
117
121 virtual int32_t getBinaryLength() = 0;
122
126 virtual ByteArray getBinaryValue() = 0;
127
137 virtual ByteArray getBinaryValue(ByteArray result) = 0;
138
140 virtual bool getOmitTermFreqAndPositions() = 0;
141
147 virtual void setOmitTermFreqAndPositions(bool omitTermFreqAndPositions) = 0;
148 };
149
150 }
151
152 #endif
Lucene::ReaderPtr
boost::shared_ptr< Reader > ReaderPtr
Definition: LuceneTypes.h:547
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::Fieldable::~Fieldable
virtual ~Fieldable()
Definition: Fieldable.h:23
LUCENE_INTERFACE
#define LUCENE_INTERFACE(Name)
Definition: LuceneObject.h:19
Lucene::Fieldable
Synonymous with Field.
Definition: Fieldable.h:20
Lucene::TokenStreamPtr
boost::shared_ptr< TokenStream > TokenStreamPtr
Definition: LuceneTypes.h:63
LuceneObject.h

clucene.sourceforge.net