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

Document.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 DOCUMENT_H
8 #define DOCUMENT_H
9
10 #include "LuceneObject.h"
11
12 namespace Lucene {
13
24 class LPPAPI Document : public LuceneObject {
25 public:
27 Document();
28
29 virtual ~Document();
30
31 LUCENE_CLASS(Document);
32
33 protected:
34 Collection<FieldablePtr> fields;
35 double boost;
36
37 public:
47 void setBoost(double boost);
48
58 double getBoost();
59
66 void add(const FieldablePtr& field);
67
75 void removeField(const String& name);
76
83 void removeFields(const String& name);
84
88 FieldPtr getField(const String& name);
89
92 FieldablePtr getFieldable(const String& name);
93
97 String get(const String& name);
98
103 Collection<FieldablePtr> getFields();
104
109 Collection<FieldPtr> getFields(const String& name);
110
115 Collection<FieldablePtr> getFieldables(const String& name);
116
121 Collection<String> getValues(const String& name);
122
127 Collection<ByteArray> getBinaryValues(const String& name);
128
134 ByteArray getBinaryValue(const String& name);
135
137 virtual String toString();
138 };
139
140 }
141
142 #endif
LUCENE_CLASS
#define LUCENE_CLASS(Name)
Definition: LuceneObject.h:24
Lucene::Collection< FieldablePtr >
Lucene::Document
Documents are the unit of indexing and search.
Definition: Document.h:24
Lucene::FieldPtr
boost::shared_ptr< Field > FieldPtr
Definition: LuceneTypes.h:75
Lucene
Definition: AbstractAllTermDocs.h:12
Lucene::LuceneObject
Base class for all Lucene classes.
Definition: LuceneObject.h:31
Lucene::FieldablePtr
boost::shared_ptr< Fieldable > FieldablePtr
Definition: LuceneTypes.h:76
Lucene::Document::boost
double boost
Definition: Document.h:35
LuceneObject.h

clucene.sourceforge.net