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


 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
FieldDoc.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 FIELDDOC_H
8 #define FIELDDOC_H
9 
10 #include "ScoreDoc.h"
11 
12 namespace Lucene {
13 
20 class LPPAPI FieldDoc : public ScoreDoc {
21 public:
22  FieldDoc(int32_t doc, double score, Collection<ComparableValue> fields = Collection<ComparableValue>());
23  virtual ~FieldDoc();
24 
26 
27 public:
34 
35 public:
36  virtual String toString();
37 };
38 
39 }
40 
41 #endif
A ScoreDoc which also contains information about how to sort the referenced document. In addition to the document number and score, this object contains an array of values for the document from the field(s) used to sort. For example, if the sort criteria was to sort by fields "a", "b" then "c", the fields object array will have three elements, corresponding respectively to the term values for the document in fields "a", "b" and "c". The class of each element in the array will be either Integer, Double or String depending on the type of values in the terms of each field.
Definition: FieldDoc.h:20
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Definition: AbstractAllTermDocs.h:12
Expert: Returned by low-level search implementations.
Definition: ScoreDoc.h:16

clucene.sourceforge.net