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


ByteFieldSource.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 BYTEFIELDSOURCE_H
8 #define BYTEFIELDSOURCE_H
9 
10 #include "FieldCacheSource.h"
11 
12 namespace Lucene {
13 
24 class LPPAPI ByteFieldSource : public FieldCacheSource {
25 public:
27  ByteFieldSource(const String& field, const ByteParserPtr& parser = ByteParserPtr());
28  virtual ~ByteFieldSource();
29 
31 
32 protected:
34 
35 public:
36  virtual String description();
37  virtual DocValuesPtr getCachedFieldValues(const FieldCachePtr& cache, const String& field, const IndexReaderPtr& reader);
38  virtual bool cachedFieldSourceEquals(const FieldCacheSourcePtr& other);
39  virtual int32_t cachedFieldSourceHashCode();
40 };
41 
42 }
43 
44 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Obtains byte field values from the FieldCache using getBytes() and makes those values available as ot...
Definition: ByteFieldSource.h:24
virtual bool cachedFieldSourceEquals(const FieldCacheSourcePtr &other)
Check if equals to another FieldCacheSource, already knowing that cache and field are equal.
ByteFieldSource(const String &field, const ByteParserPtr &parser=ByteParserPtr())
Create a cached byte field source with a specific string-to-byte parser.
virtual String description()
Description of field, used in explain()
ByteParserPtr parser
Definition: ByteFieldSource.h:30
virtual DocValuesPtr getCachedFieldValues(const FieldCachePtr &cache, const String &field, const IndexReaderPtr &reader)
Return cached DocValues for input field and reader.
virtual int32_t cachedFieldSourceHashCode()
Return a hash code of a FieldCacheSource, without the hash-codes of the field and the cache (those ar...
A base class for ValueSource implementations that retrieve values for a single field from the FieldCa...
Definition: FieldCacheSource.h:28
Definition: AbstractAllTermDocs.h:12
boost::shared_ptr< ByteParser > ByteParserPtr
Definition: LuceneTypes.h:289
boost::shared_ptr< FieldCacheSource > FieldCacheSourcePtr
Definition: LuceneTypes.h:345
boost::shared_ptr< DocValues > DocValuesPtr
Definition: LuceneTypes.h:325
boost::shared_ptr< FieldCache > FieldCachePtr
Definition: LuceneTypes.h:334
boost::shared_ptr< IndexReader > IndexReaderPtr
Definition: LuceneTypes.h:157

clucene.sourceforge.net