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


Loading...
Searching...
No Matches
FieldCache.h
Go to the documentation of this file.
1
2// 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 FIELDCACHE_H
8#define FIELDCACHE_H
9
10#include <boost/any.hpp>
11#include "LuceneObject.h"
12
13namespace Lucene {
14
17class LPPAPI FieldCache {
18public:
19 virtual ~FieldCache();
21
22public:
24 enum CacheType {
25 CACHE_BYTE = 1,
30 CACHE_STRING_INDEX
31 };
32
35 static const int32_t STRING_INDEX;
36
37public:
40
43
46
49
52
56
60
64
71 virtual Collection<uint8_t> getBytes(const IndexReaderPtr& reader, const String& field);
72
80 virtual Collection<uint8_t> getBytes(const IndexReaderPtr& reader, const String& field, const ByteParserPtr& parser);
81
88 virtual Collection<int32_t> getInts(const IndexReaderPtr& reader, const String& field);
89
97 virtual Collection<int32_t> getInts(const IndexReaderPtr& reader, const String& field, const IntParserPtr& parser);
98
105 virtual Collection<int64_t> getLongs(const IndexReaderPtr& reader, const String& field);
106
114 virtual Collection<int64_t> getLongs(const IndexReaderPtr& reader, const String& field, const LongParserPtr& parser);
115
122 virtual Collection<double> getDoubles(const IndexReaderPtr& reader, const String& field);
123
131 virtual Collection<double> getDoubles(const IndexReaderPtr& reader, const String& field, const DoubleParserPtr& parser);
132
139 virtual Collection<String> getStrings(const IndexReaderPtr& reader, const String& field);
140
147 virtual StringIndexPtr getStringIndex(const IndexReaderPtr& reader, const String& field);
148
151
155 virtual void purgeAllCaches() = 0;
156
160 virtual void purge(const IndexReaderPtr& r) = 0;
161
164 virtual void setInfoStream(const InfoStreamPtr& stream);
165
168};
169
170class LPPAPI CreationPlaceholder : public LuceneObject {
171public:
174
175public:
176 boost::any value;
177};
178
180class LPPAPI StringIndex : public LuceneObject {
181public:
183 virtual ~StringIndex();
184
186
187public:
190
193
194public:
195 int32_t binarySearchLookup(const String& key);
196};
197
200class LPPAPI Parser : public LuceneObject {
201public:
202 virtual ~Parser();
204};
205
208class LPPAPI ByteParser : public Parser {
209public:
210 virtual ~ByteParser();
212
213public:
215 virtual uint8_t parseByte(const String& string);
216};
217
220class LPPAPI IntParser : public Parser {
221public:
222 virtual ~IntParser();
224
225public:
227 virtual int32_t parseInt(const String& string);
228};
229
232class LPPAPI LongParser : public Parser {
233public:
234 virtual ~LongParser();
236
237public:
239 virtual int64_t parseLong(const String& string);
240};
241
244class LPPAPI DoubleParser : public Parser {
245public:
246 virtual ~DoubleParser();
248
249public:
251 virtual double parseDouble(const String& string);
252};
253
255class LPPAPI FieldCacheEntry : public LuceneObject {
256public:
259
260public:
262 virtual String getFieldName() = 0;
263 virtual int32_t getCacheType() = 0;
264 virtual boost::any getCustom() = 0;
265 virtual boost::any getValue() = 0;
266
267 virtual String toString();
268};
269
270}
271
272#endif
#define LUCENE_CLASS(Name)
Definition LuceneObject.h:24
#define LUCENE_INTERFACE(Name)
Definition LuceneObject.h:19
Interface to parse bytes from document fields.
Definition FieldCache.h:208
virtual ~ByteParser()
virtual uint8_t parseByte(const String &string)
Return a single Byte representation of this field's value.
Utility template class to handle collections that can be safely copied and shared.
Definition Collection.h:17
Definition FieldCache.h:170
boost::any value
Definition FieldCache.h:176
Interface to parse doubles from document fields.
Definition FieldCache.h:244
virtual double parseDouble(const String &string)
Return a double representation of this field's value.
A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/debugging.
Definition FieldCache.h:255
virtual String toString()
Returns a string representation of the object.
virtual boost::any getValue()=0
virtual boost::any getCustom()=0
virtual int32_t getCacheType()=0
virtual LuceneObjectPtr getReaderKey()=0
virtual String getFieldName()=0
Maintains caches of term values.
Definition FieldCache.h:17
CacheType
Specifies whether and how a field should be stored.
Definition FieldCache.h:24
@ CACHE_STRING
Definition FieldCache.h:29
@ CACHE_DOUBLE
Definition FieldCache.h:28
@ CACHE_INT
Definition FieldCache.h:26
@ CACHE_LONG
Definition FieldCache.h:27
virtual Collection< int32_t > getInts(const IndexReaderPtr &reader, const String &field, const IntParserPtr &parser)
Checks the internal cache for an appropriate entry, and if none are found, reads the terms in field a...
static DoubleParserPtr DEFAULT_DOUBLE_PARSER()
The default parser for double values, which are encoded by StringUtils::toDouble.
virtual StringIndexPtr getStringIndex(const IndexReaderPtr &reader, const String &field)
Checks the internal cache for an appropriate entry, and if none are found reads the term values in fi...
static IntParserPtr NUMERIC_UTILS_INT_PARSER()
A parser instance for int values encoded by NumericUtils#prefixCodedToInt(String),...
virtual Collection< int64_t > getLongs(const IndexReaderPtr &reader, const String &field, const LongParserPtr &parser)
Checks the internal cache for an appropriate entry, and if none are found, reads the terms in field a...
static DoubleParserPtr NUMERIC_UTILS_DOUBLE_PARSER()
A parser instance for double values encoded by NumericUtils, eg. when indexed via NumericField/Numeri...
static const int32_t STRING_INDEX
Indicator for StringIndex values in the cache. NOTE: the value assigned to this constant must not be ...
Definition FieldCache.h:35
static LongParserPtr DEFAULT_LONG_PARSER()
The default parser for int values, which are encoded by StringUtils::toLong.
virtual ~FieldCache()
virtual Collection< double > getDoubles(const IndexReaderPtr &reader, const String &field, const DoubleParserPtr &parser)
Checks the internal cache for an appropriate entry, and if none are found, reads the terms in field a...
virtual Collection< uint8_t > getBytes(const IndexReaderPtr &reader, const String &field)
Checks the internal cache for an appropriate entry, and if none are found, reads the terms in field a...
virtual Collection< FieldCacheEntryPtr > getCacheEntries()=0
Generates an array of CacheEntry objects representing all items currently in the FieldCache.
static LongParserPtr NUMERIC_UTILS_LONG_PARSER()
A parser instance for long values encoded by NumericUtils#prefixCodedToLong(String),...
virtual void setInfoStream(const InfoStreamPtr &stream)
If non-null, FieldCacheImpl will warn whenever entries are created that are not sane according to Fie...
virtual Collection< int32_t > getInts(const IndexReaderPtr &reader, const String &field)
Checks the internal cache for an appropriate entry, and if none are found, reads the terms in field a...
virtual Collection< String > getStrings(const IndexReaderPtr &reader, const String &field)
Checks the internal cache for an appropriate entry, and if none are found, reads the term values in f...
virtual InfoStreamPtr getInfoStream()
virtual Collection< int64_t > getLongs(const IndexReaderPtr &reader, const String &field)
Checks the internal cache for an appropriate entry, and if none are found, reads the terms in field a...
static ByteParserPtr DEFAULT_BYTE_PARSER()
The default parser for byte values, which are encoded by StringUtils::toInt.
static FieldCachePtr DEFAULT()
The cache used internally by sorting and range query classes.
virtual Collection< double > getDoubles(const IndexReaderPtr &reader, const String &field)
Checks the internal cache for an appropriate entry, and if none are found, reads the terms in field a...
virtual void purge(const IndexReaderPtr &r)=0
Drops all cache entries associated with this reader. NOTE: this reader must precisely match the reade...
virtual void purgeAllCaches()=0
Instructs the FieldCache to forcibly expunge all entries from the underlying caches....
virtual Collection< uint8_t > getBytes(const IndexReaderPtr &reader, const String &field, const ByteParserPtr &parser)
Checks the internal cache for an appropriate entry, and if none are found, reads the terms in field a...
static IntParserPtr DEFAULT_INT_PARSER()
The default parser for int values, which are encoded by StringUtils::toInt.
Interface to parse ints from document fields.
Definition FieldCache.h:220
virtual int32_t parseInt(const String &string)
Return a integer representation of this field's value.
virtual ~IntParser()
Interface to parse longs from document fields.
Definition FieldCache.h:232
virtual int64_t parseLong(const String &string)
Return a long representation of this field's value.
virtual ~LongParser()
Base class for all Lucene classes.
Definition LuceneObject.h:31
Marker interface as super-interface to all parsers. It is used to specify a custom parser to SortFiel...
Definition FieldCache.h:200
virtual ~Parser()
Stores term text values and document ordering data.
Definition FieldCache.h:180
int32_t binarySearchLookup(const String &key)
virtual ~StringIndex()
Collection< String > lookup
All the term values, in natural order.
Definition FieldCache.h:189
Collection< int32_t > order
For each document, an index into the lookup array.
Definition FieldCache.h:192
StringIndex(Collection< int32_t > values, Collection< String > lookup)
Definition AbstractAllTermDocs.h:12
boost::shared_ptr< LongParser > LongParserPtr
Definition LuceneTypes.h:378
boost::shared_ptr< InfoStream > InfoStreamPtr
Definition LuceneTypes.h:532
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition LuceneTypes.h:539
boost::shared_ptr< ByteParser > ByteParserPtr
Definition LuceneTypes.h:289
boost::shared_ptr< IntParser > IntParserPtr
Definition LuceneTypes.h:376
boost::shared_ptr< DoubleParser > DoubleParserPtr
Definition LuceneTypes.h:328
boost::shared_ptr< FieldCache > FieldCachePtr
Definition LuceneTypes.h:334
boost::shared_ptr< IndexReader > IndexReaderPtr
Definition LuceneTypes.h:157
boost::shared_ptr< StringIndex > StringIndexPtr
Definition LuceneTypes.h:460

clucene.sourceforge.net