1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>LCOV - lcov.info - /usr/include/xapian/document.h</title>
<link rel="stylesheet" type="text/css" href="../../../gcov.css">
</head>
<body>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="title">LTP GCOV extension - code coverage report</td></tr>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
<tr>
<td width="100%">
<table cellpadding=1 border=0 width="100%">
<tr>
<td class="headerItem" width="20%">Current view:</td>
<td class="headerValue" width="80%" colspan=4><a href="../../../index.html">directory</a> - <a href="index.html">usr/include/xapian</a> - document.h</td>
</tr>
<tr>
<td class="headerItem" width="20%">Test:</td>
<td class="headerValue" width="80%" colspan=4>lcov.info</td>
</tr>
<tr>
<td class="headerItem" width="20%">Date:</td>
<td class="headerValue" width="20%">2008-08-14</td>
<td width="20%"></td>
<td class="headerItem" width="20%">Instrumented lines:</td>
<td class="headerValue" width="20%">2</td>
</tr>
<tr>
<td class="headerItem" width="20%">Code covered:</td>
<td class="headerValue" width="20%">0.0 %</td>
<td width="20%"></td>
<td class="headerItem" width="20%">Executed lines:</td>
<td class="headerValue" width="20%">0</td>
</tr>
</table>
</td>
</tr>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
</table>
<table cellpadding=0 cellspacing=0 border=0>
<tr>
<td><br></td>
</tr>
<tr>
<td><pre class="source">
<span class="lineNum"> 1 </span> : /** \file document.h
<span class="lineNum"> 2 </span> : * \brief API for working with documents
<span class="lineNum"> 3 </span> : */
<span class="lineNum"> 4 </span> : /* Copyright 1999,2000,2001 BrightStation PLC
<span class="lineNum"> 5 </span> : * Copyright 2002 Ananova Ltd
<span class="lineNum"> 6 </span> : * Copyright 2002,2003,2004,2006,2007 Olly Betts
<span class="lineNum"> 7 </span> : *
<span class="lineNum"> 8 </span> : * This program is free software; you can redistribute it and/or
<span class="lineNum"> 9 </span> : * modify it under the terms of the GNU General Public License as
<span class="lineNum"> 10 </span> : * published by the Free Software Foundation; either version 2 of the
<span class="lineNum"> 11 </span> : * License, or (at your option) any later version.
<span class="lineNum"> 12 </span> : *
<span class="lineNum"> 13 </span> : * This program is distributed in the hope that it will be useful,
<span class="lineNum"> 14 </span> : * but WITHOUT ANY WARRANTY; without even the implied warranty of
<span class="lineNum"> 15 </span> : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
<span class="lineNum"> 16 </span> : * GNU General Public License for more details.
<span class="lineNum"> 17 </span> : *
<span class="lineNum"> 18 </span> : * You should have received a copy of the GNU General Public License
<span class="lineNum"> 19 </span> : * along with this program; if not, write to the Free Software
<span class="lineNum"> 20 </span> : * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
<span class="lineNum"> 21 </span> : * USA
<span class="lineNum"> 22 </span> : */
<span class="lineNum"> 23 </span> :
<span class="lineNum"> 24 </span> : #ifndef XAPIAN_INCLUDED_DOCUMENT_H
<span class="lineNum"> 25 </span> : #define XAPIAN_INCLUDED_DOCUMENT_H
<span class="lineNum"> 26 </span> :
<span class="lineNum"> 27 </span> : #include <string>
<span class="lineNum"> 28 </span> :
<span class="lineNum"> 29 </span> : #include <xapian/base.h>
<span class="lineNum"> 30 </span> : #include <xapian/types.h>
<span class="lineNum"> 31 </span> : #include <xapian/termiterator.h>
<span class="lineNum"> 32 </span> : #include <xapian/visibility.h>
<span class="lineNum"> 33 </span> :
<span class="lineNum"> 34 </span> : namespace Xapian {
<span class="lineNum"> 35 </span> :
<span class="lineNum"> 36 </span> : class ValueIterator;
<span class="lineNum"> 37 </span> :
<span class="lineNum"> 38 </span> : /// A document in the database - holds data, values, terms, and postings
<span class="lineNum"> 39 </span> : class XAPIAN_VISIBILITY_DEFAULT Document {
<span class="lineNum"> 40 </span> : public:
<span class="lineNum"> 41 </span> : class Internal;
<span class="lineNum"> 42 </span> : /// @private @internal Reference counted internals.
<span class="lineNum"> 43 </span> : Xapian::Internal::RefCntPtr<Internal> internal;
<span class="lineNum"> 44 </span> :
<span class="lineNum"> 45 </span> : /** @private @internal Constructor is only used by internal classes.
<span class="lineNum"> 46 </span> : *
<span class="lineNum"> 47 </span> : * @param internal_ pointer to internal opaque class
<span class="lineNum"> 48 </span> : */
<span class="lineNum"> 49 </span> : explicit Document(Internal *internal_);
<span class="lineNum"> 50 </span> :
<span class="lineNum"> 51 </span> : /** Copying is allowed. The internals are reference counted, so
<span class="lineNum"> 52 </span> : * copying is cheap.
<span class="lineNum"> 53 </span> : */
<span class="lineNum"> 54 </span> : Document(const Document &other);
<span class="lineNum"> 55 </span> :
<span class="lineNum"> 56 </span> : /** Assignment is allowed. The internals are reference counted,
<span class="lineNum"> 57 </span> : * so assignment is cheap.
<span class="lineNum"> 58 </span> : */
<span class="lineNum"> 59 </span> : void operator=(const Document &other);
<span class="lineNum"> 60 </span> :
<span class="lineNum"> 61 </span> : /// Make a new empty Document
<span class="lineNum"> 62 </span> : Document();
<span class="lineNum"> 63 </span> :
<span class="lineNum"> 64 </span> : /// Destructor
<span class="lineNum"> 65 </span> : ~Document();
<span class="lineNum"> 66 </span> :
<span class="lineNum"> 67 </span> : /** Get value by number.
<span class="lineNum"> 68 </span> : *
<span class="lineNum"> 69 </span> : * Returns an empty string if no value with the given number is present
<span class="lineNum"> 70 </span> : * in the document.
<span class="lineNum"> 71 </span> : *
<span class="lineNum"> 72 </span> : * @param valueno The number of the value.
<span class="lineNum"> 73 </span> : */
<span class="lineNum"> 74 </span> : std::string get_value(Xapian::valueno valueno) const;
<span class="lineNum"> 75 </span> :
<span class="lineNum"> 76 </span> : /** Add a new value. It will replace any existing value with the
<span class="lineNum"> 77 </span> : * same number.
<span class="lineNum"> 78 </span> : */
<span class="lineNum"> 79 </span> : void add_value(Xapian::valueno valueno, const std::string &value);
<span class="lineNum"> 80 </span> :
<span class="lineNum"> 81 </span> : /// Remove any value with the given number.
<span class="lineNum"> 82 </span> : void remove_value(Xapian::valueno valueno);
<span class="lineNum"> 83 </span> :
<span class="lineNum"> 84 </span> : /// Remove all values associated with the document.
<span class="lineNum"> 85 </span> : void clear_values();
<span class="lineNum"> 86 </span> :
<span class="lineNum"> 87 </span> : /** Get data stored in the document.
<span class="lineNum"> 88 </span> : * This is a potentially expensive operation, and shouldn't normally
<span class="lineNum"> 89 </span> : * be used in a match decider functor. Put data for use by match
<span class="lineNum"> 90 </span> : * deciders in a value instead.
<span class="lineNum"> 91 </span> : */
<span class="lineNum"> 92 </span> : std::string get_data() const;
<span class="lineNum"> 93 </span> :
<span class="lineNum"> 94 </span> : /// Set data stored in the document.
<span class="lineNum"> 95 </span> : void set_data(const std::string &data);
<span class="lineNum"> 96 </span> :
<span class="lineNum"> 97 </span> : /** Add an occurrence of a term at a particular position.
<span class="lineNum"> 98 </span> : *
<span class="lineNum"> 99 </span> : * Multiple occurrences of the term at the same position are
<span class="lineNum"> 100 </span> : * represented only once in the positional information, but do
<span class="lineNum"> 101 </span> : * increase the wdf.
<span class="lineNum"> 102 </span> : *
<span class="lineNum"> 103 </span> : * If the term is not already in the document, it will be added to
<span class="lineNum"> 104 </span> : * it.
<span class="lineNum"> 105 </span> : *
<span class="lineNum"> 106 </span> : * @param tname The name of the term.
<span class="lineNum"> 107 </span> : * @param tpos The position of the term.
<span class="lineNum"> 108 </span> : * @param wdfinc The increment that will be applied to the wdf
<span class="lineNum"> 109 </span> : * for this term.
<span class="lineNum"> 110 </span> : */
<span class="lineNum"> 111 </span> : void add_posting(const std::string & tname,
<span class="lineNum"> 112 </span> : Xapian::termpos tpos,
<span class="lineNum"> 113 </span> : Xapian::termcount wdfinc = 1);
<span class="lineNum"> 114 </span> :
<span class="lineNum"> 115 </span> : /** Add a term to the document, without positional information.
<span class="lineNum"> 116 </span> : *
<span class="lineNum"> 117 </span> : * Any existing positional information for the term will be left
<span class="lineNum"> 118 </span> : * unmodified.
<span class="lineNum"> 119 </span> : *
<span class="lineNum"> 120 </span> : * @param tname The name of the term.
<span class="lineNum"> 121 </span> : * @param wdfinc The increment that will be applied to the wdf
<span class="lineNum"> 122 </span> : * for this term.
<span class="lineNum"> 123 </span> : */
<span class="lineNum"> 124 </span> : void add_term(const std::string & tname, Xapian::termcount wdfinc = 1);
<span class="lineNum"> 125 </span> :
<span class="lineNum"> 126 </span> : /** Remove a posting of a term from the document.
<span class="lineNum"> 127 </span> : *
<span class="lineNum"> 128 </span> : * Note that the term will still index the document even if all
<span class="lineNum"> 129 </span> : * occurrences are removed. To remove a term from a document
<span class="lineNum"> 130 </span> : * completely, use remove_term().
<span class="lineNum"> 131 </span> : *
<span class="lineNum"> 132 </span> : * @param tname The name of the term.
<span class="lineNum"> 133 </span> : * @param tpos The position of the term.
<span class="lineNum"> 134 </span> : * @param wdfdec The decrement that will be applied to the wdf
<span class="lineNum"> 135 </span> : * when removing this posting. The wdf will not go
<span class="lineNum"> 136 </span> : * below the value of 0.
<span class="lineNum"> 137 </span> : *
<span class="lineNum"> 138 </span> : * @exception Xapian::InvalidArgumentError will be thrown if the term
<span class="lineNum"> 139 </span> : * is not at the position specified in the position list for this term
<span class="lineNum"> 140 </span> : * in this document.
<span class="lineNum"> 141 </span> : *
<span class="lineNum"> 142 </span> : * @exception Xapian::InvalidArgumentError will be thrown if the term
<span class="lineNum"> 143 </span> : * is not in the document
<span class="lineNum"> 144 </span> : */
<span class="lineNum"> 145 </span> : void remove_posting(const std::string & tname,
<span class="lineNum"> 146 </span> : Xapian::termpos tpos,
<span class="lineNum"> 147 </span> : Xapian::termcount wdfdec = 1);
<span class="lineNum"> 148 </span> :
<span class="lineNum"> 149 </span> : /** Remove a term and all postings associated with it.
<span class="lineNum"> 150 </span> : *
<span class="lineNum"> 151 </span> : * @param tname The name of the term.
<span class="lineNum"> 152 </span> : *
<span class="lineNum"> 153 </span> : * @exception Xapian::InvalidArgumentError will be thrown if the term
<span class="lineNum"> 154 </span> : * is not in the document
<span class="lineNum"> 155 </span> : */
<span class="lineNum"> 156 </span> : void remove_term(const std::string & tname);
<span class="lineNum"> 157 </span> :
<span class="lineNum"> 158 </span> : /// Remove all terms (and postings) from the document.
<span class="lineNum"> 159 </span> : void clear_terms();
<span class="lineNum"> 160 </span> :
<span class="lineNum"> 161 </span> : /** The length of the termlist - i.e. the number of different terms
<span class="lineNum"> 162 </span> : * which index this document.
<span class="lineNum"> 163 </span> : */
<span class="lineNum"> 164 </span> : Xapian::termcount termlist_count() const;
<span class="lineNum"> 165 </span> :
<span class="lineNum"> 166 </span> : /// Iterator for the terms in this document.
<span class="lineNum"> 167 </span> : TermIterator termlist_begin() const;
<span class="lineNum"> 168 </span> :
<span class="lineNum"> 169 </span> : /// Equivalent end iterator for termlist_begin().
<span class="lineNum"> 170 </span><span class="lineNoCov"> 0 : TermIterator termlist_end() const {</span>
<span class="lineNum"> 171 </span><span class="lineNoCov"> 0 : return TermIterator(NULL);</span>
<span class="lineNum"> 172 </span> : }
<span class="lineNum"> 173 </span> :
<span class="lineNum"> 174 </span> : /// Count the values in this document.
<span class="lineNum"> 175 </span> : Xapian::termcount values_count() const;
<span class="lineNum"> 176 </span> :
<span class="lineNum"> 177 </span> : /// Iterator for the values in this document.
<span class="lineNum"> 178 </span> : ValueIterator values_begin() const;
<span class="lineNum"> 179 </span> :
<span class="lineNum"> 180 </span> : /// Equivalent end iterator for values_begin().
<span class="lineNum"> 181 </span> : ValueIterator values_end() const;
<span class="lineNum"> 182 </span> :
<span class="lineNum"> 183 </span> : /** Get the document id which is associated with this document (if any).
<span class="lineNum"> 184 </span> : *
<span class="lineNum"> 185 </span> : * NB If multiple databases are being searched together, then this
<span class="lineNum"> 186 </span> : * will be the document id in the individual database, not the merged
<span class="lineNum"> 187 </span> : * database!
<span class="lineNum"> 188 </span> : *
<span class="lineNum"> 189 </span> : * @return If this document came from a database, return the document
<span class="lineNum"> 190 </span> : * id in that database. Otherwise, return 0.
<span class="lineNum"> 191 </span> : */
<span class="lineNum"> 192 </span> : docid get_docid() const;
<span class="lineNum"> 193 </span> :
<span class="lineNum"> 194 </span> : /// Return a string describing this object.
<span class="lineNum"> 195 </span> : std::string get_description() const;
<span class="lineNum"> 196 </span> : };
<span class="lineNum"> 197 </span> :
<span class="lineNum"> 198 </span> : }
<span class="lineNum"> 199 </span> :
<span class="lineNum"> 200 </span> : #endif // XAPIAN_INCLUDED_DOCUMENT_H
</pre>
</td>
</tr>
</table>
<br>
<table width="100%" border=0 cellspacing=0 cellpadding=0>
<tr><td class="ruler"><img src="../../../glass.png" width=3 height=3 alt=""></td></tr>
<tr><td class="versionInfo">Generated by: <a href="http://ltp.sourceforge.net/coverage/lcov.php" target="_parent">LTP GCOV extension version 1.6</a></td></tr>
</table>
<br>
</body>
</html>
|
