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


ValueSource.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 VALUESOURCE_H
8 #define VALUESOURCE_H
9 
10 #include "LuceneObject.h"
11 
12 namespace Lucene {
13 
21 class LPPAPI ValueSource : public LuceneObject {
22 public:
23  virtual ~ValueSource();
25 
26 public:
30  virtual DocValuesPtr getValues(const IndexReaderPtr& reader) = 0;
31 
33  virtual String description() = 0;
34 
35  virtual String toString();
36 
38  virtual bool equals(const LuceneObjectPtr& other) = 0;
39 
41  virtual int32_t hashCode() = 0;
42 };
43 
44 }
45 
46 #endif
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Source of values for basic function queries.
Definition: ValueSource.h:21
virtual String toString()
Returns a string representation of the object.
virtual bool equals(const LuceneObjectPtr &other)=0
Needed for possible caching of query results - used by ValueSourceQuery#equals(LuceneObjectPtr).
virtual String description()=0
Description of field, used in explain()
virtual DocValuesPtr getValues(const IndexReaderPtr &reader)=0
Return the DocValues used by the function query.
virtual int32_t hashCode()=0
Needed for possible caching of query results - used by ValueSourceQuery#hashCode().
virtual ~ValueSource()
Definition: AbstractAllTermDocs.h:12
boost::shared_ptr< LuceneObject > LuceneObjectPtr
Definition: LuceneTypes.h:539
boost::shared_ptr< DocValues > DocValuesPtr
Definition: LuceneTypes.h:325
boost::shared_ptr< IndexReader > IndexReaderPtr
Definition: LuceneTypes.h:157

clucene.sourceforge.net