-
Notifications
You must be signed in to change notification settings - Fork 624
/
Document.cs
500 lines (460 loc) · 22.4 KB
/
Document.cs
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
using Lucene.Net.Index;
using Lucene.Net.Support;
using Lucene.Net.Util;
using System;
using System.Collections;
using System.Collections.Generic;
using System.Text;
namespace Lucene.Net.Documents
{
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/// <summary>
/// Documents are the unit of indexing and search.
/// <para/>
/// A Document is a set of fields. Each field has a name and a textual value.
/// A field may be stored (<see cref="IIndexableFieldType.IsStored"/>) with the document, in which
/// case it is returned with search hits on the document. Thus each document
/// should typically contain one or more stored fields which uniquely identify
/// it.
/// <para/>
/// Note that fields which are <i>not</i> <see cref="Lucene.Net.Index.IIndexableFieldType.IsStored"/> are
/// <i>not</i> available in documents retrieved from the index, e.g. with
/// <see cref="Search.ScoreDoc.Doc"/> or <see cref="IndexReader.Document(int)"/>.
/// </summary>
public sealed class Document : IEnumerable<IIndexableField>, IFormattable
{
private readonly List<IIndexableField> fields = new List<IIndexableField>();
/// <summary>
/// Constructs a new document with no fields. </summary>
public Document()
{
}
public IEnumerator<IIndexableField> GetEnumerator()
{
return fields.GetEnumerator();
}
IEnumerator IEnumerable.GetEnumerator()
{
return GetEnumerator();
}
/// <summary>
/// <para>Adds a field to a document. Several fields may be added with
/// the same name. In this case, if the fields are indexed, their text is
/// treated as though appended for the purposes of search.</para>
/// <para> Note that add like the <see cref="RemoveField(string)"/> and <see cref="RemoveFields(string)"/> methods only makes sense
/// prior to adding a document to an index. These methods cannot
/// be used to change the content of an existing index! In order to achieve this,
/// a document has to be deleted from an index and a new changed version of that
/// document has to be added.</para>
/// </summary>
public void Add(IIndexableField field)
{
fields.Add(field);
}
/// <summary>
/// <para>Removes field with the specified name from the document.
/// If multiple fields exist with this name, this method removes the first field that has been added.
/// If there is no field with the specified name, the document remains unchanged.</para>
/// <para> Note that the <see cref="RemoveField(string)"/> and <see cref="RemoveFields(string)"/> methods like the add method only make sense
/// prior to adding a document to an index. These methods cannot
/// be used to change the content of an existing index! In order to achieve this,
/// a document has to be deleted from an index and a new changed version of that
/// document has to be added.</para>
/// </summary>
public void RemoveField(string name)
{
for (int i = 0; i < fields.Count; i++)
{
IIndexableField field = fields[i];
if (field.Name.Equals(name, StringComparison.Ordinal))
{
fields.Remove(field);
return;
}
}
}
/// <summary>
/// <para>Removes all fields with the given name from the document.
/// If there is no field with the specified name, the document remains unchanged.</para>
/// <para> Note that the <see cref="RemoveField(string)"/> and <see cref="RemoveFields(string)"/> methods like the add method only make sense
/// prior to adding a document to an index. These methods cannot
/// be used to change the content of an existing index! In order to achieve this,
/// a document has to be deleted from an index and a new changed version of that
/// document has to be added.</para>
/// </summary>
public void RemoveFields(string name)
{
for (int i = fields.Count - 1; i >= 0; i--)
{
IIndexableField field = fields[i];
if (field.Name.Equals(name, StringComparison.Ordinal))
{
fields.Remove(field);
}
}
}
/// <summary>
/// Returns an array of byte arrays for of the fields that have the name specified
/// as the method parameter. This method returns an empty
/// array when there are no matching fields. It never
/// returns <c>null</c>.
/// </summary>
/// <param name="name"> the name of the field </param>
/// <returns> a <see cref="T:BytesRef[]"/> of binary field values </returns>
public BytesRef[] GetBinaryValues(string name)
{
var result = new List<BytesRef>();
foreach (IIndexableField field in fields)
{
if (field.Name.Equals(name, StringComparison.Ordinal))
{
BytesRef bytes = field.GetBinaryValue();
if (bytes != null)
{
result.Add(bytes);
}
}
}
return result.ToArray();
}
/// <summary>
/// Returns an array of bytes for the first (or only) field that has the name
/// specified as the method parameter. this method will return <c>null</c>
/// if no binary fields with the specified name are available.
/// There may be non-binary fields with the same name.
/// </summary>
/// <param name="name"> the name of the field. </param>
/// <returns> a <see cref="BytesRef"/> containing the binary field value or <c>null</c> </returns>
public BytesRef GetBinaryValue(string name)
{
foreach (IIndexableField field in fields)
{
if (field.Name.Equals(name, StringComparison.Ordinal))
{
BytesRef bytes = field.GetBinaryValue();
if (bytes != null)
{
return bytes;
}
}
}
return null;
}
/// <summary>
/// Returns a field with the given name if any exist in this document, or
/// <c>null</c>. If multiple fields exists with this name, this method returns the
/// first value added.
/// </summary>
public IIndexableField GetField(string name)
{
foreach (IIndexableField field in fields)
{
if (field.Name.Equals(name, StringComparison.Ordinal))
{
return field;
}
}
return null;
}
/// <summary>
/// Returns an array of <see cref="IIndexableField"/>s with the given name.
/// This method returns an empty array when there are no
/// matching fields. It never returns <c>null</c>.
/// </summary>
/// <param name="name"> the name of the field </param>
/// <returns> a <see cref="T:IndexableField[]"/> array </returns>
public IIndexableField[] GetFields(string name)
{
var result = new List<IIndexableField>();
foreach (IIndexableField field in fields)
{
if (field.Name.Equals(name, StringComparison.Ordinal))
{
result.Add(field);
}
}
return result.ToArray();
}
/// <summary>
/// Returns a List of all the fields in a document.
/// <para>Note that fields which are <i>not</i> stored are
/// <i>not</i> available in documents retrieved from the
/// index, e.g. <see cref="Search.IndexSearcher.Doc(int)"/> or
/// <see cref="IndexReader.Document(int)"/>.
/// </para>
/// </summary>
public IList<IIndexableField> Fields => fields;
private static readonly string[] NO_STRINGS = Arrays.Empty<string>();
/// <summary>
/// Returns an array of values of the field specified as the method parameter.
/// This method returns an empty array when there are no
/// matching fields. It never returns <c>null</c>.
/// For <see cref="Int32Field"/>, <see cref="Int64Field"/>,
/// <see cref="SingleField"/> and <seealso cref="DoubleField"/> it returns the string value of the number. If you want
/// the actual numeric field instances back, use <see cref="GetFields(string)"/>. </summary>
/// <param name="name"> the name of the field </param>
/// <returns> a <see cref="T:string[]"/> of field values </returns>
public string[] GetValues(string name)
{
var result = new List<string>();
foreach (IIndexableField field in fields)
{
string fieldStringValue;
if (field.Name.Equals(name, StringComparison.Ordinal) && (fieldStringValue = field.GetStringValue()) != null)
{
result.Add(fieldStringValue);
}
}
if (result.Count == 0)
{
return NO_STRINGS;
}
return result.ToArray();
}
/// <summary>
/// Returns an array of values of the field specified as the method parameter.
/// This method returns an empty array when there are no
/// matching fields. It never returns <c>null</c>.
/// For <see cref="Int32Field"/>, <see cref="Int64Field"/>,
/// <see cref="SingleField"/> and <seealso cref="DoubleField"/> it returns the string value of the number. If you want
/// the actual numeric field instances back, use <see cref="GetFields(string)"/>. </summary>
/// <param name="name"> the name of the field </param>
/// <param name="format">A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.</param>
/// <returns> a <see cref="T:string[]"/> of field values </returns>
// LUCENENET specific - method added for better .NET compatibility
public string[] GetValues(string name, string format)
{
var result = new List<string>();
foreach (IIndexableField field in fields)
{
string fieldStringValue;
if (field.Name.Equals(name, StringComparison.Ordinal) && (fieldStringValue = field.GetStringValue(format)) != null)
{
result.Add(fieldStringValue);
}
}
if (result.Count == 0)
{
return NO_STRINGS;
}
return result.ToArray();
}
/// <summary>
/// Returns an array of values of the field specified as the method parameter.
/// This method returns an empty array when there are no
/// matching fields. It never returns <c>null</c>.
/// For <see cref="Int32Field"/>, <see cref="Int64Field"/>,
/// <see cref="SingleField"/> and <seealso cref="DoubleField"/> it returns the string value of the number. If you want
/// the actual numeric field instances back, use <see cref="GetFields(string)"/>. </summary>
/// <param name="name"> the name of the field </param>
/// <param name = "provider" > An object that supplies culture-specific formatting information.This parameter has no effect if this field is non-numeric.</param>
/// <returns> a <see cref="T:string[]"/> of field values </returns>
// LUCENENET specific - method added for better .NET compatibility
public string[] GetValues(string name, IFormatProvider provider)
{
var result = new List<string>();
foreach (IIndexableField field in fields)
{
string fieldStringValue;
if (field.Name.Equals(name, StringComparison.Ordinal) && (fieldStringValue = field.GetStringValue(provider)) != null)
{
result.Add(fieldStringValue);
}
}
if (result.Count == 0)
{
return NO_STRINGS;
}
return result.ToArray();
}
/// <summary>
/// Returns an array of values of the field specified as the method parameter.
/// This method returns an empty array when there are no
/// matching fields. It never returns <c>null</c>.
/// For <see cref="Int32Field"/>, <see cref="Int64Field"/>,
/// <see cref="SingleField"/> and <seealso cref="DoubleField"/> it returns the string value of the number. If you want
/// the actual numeric field instances back, use <see cref="GetFields(string)"/>. </summary>
/// <param name="name"> the name of the field </param>
/// <param name="format">A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.</param>
/// <param name="provider">An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.</param>
/// <returns> a <see cref="T:string[]"/> of field values </returns>
// LUCENENET specific - method added for better .NET compatibility
public string[] GetValues(string name, string format, IFormatProvider provider)
{
var result = new List<string>();
foreach (IIndexableField field in fields)
{
string fieldStringValue;
if (field.Name.Equals(name, StringComparison.Ordinal) && (fieldStringValue = field.GetStringValue(format, provider)) != null)
{
result.Add(fieldStringValue);
}
}
if (result.Count == 0)
{
return NO_STRINGS;
}
return result.ToArray();
}
/// <summary>
/// Returns the string value of the field with the given name if any exist in
/// this document, or <c>null</c>. If multiple fields exist with this name, this
/// method returns the first value added. If only binary fields with this name
/// exist, returns <c>null</c>.
/// For <see cref="Int32Field"/>, <see cref="Int64Field"/>,
/// <see cref="SingleField"/> and <seealso cref="DoubleField"/> it returns the string value of the number. If you want
/// the actual numeric field instance back, use <see cref="GetField(string)"/>.
/// </summary>
public string Get(string name)
{
foreach (IIndexableField field in fields)
{
string fieldStringValue;
if (field.Name.Equals(name, StringComparison.Ordinal) && (fieldStringValue = field.GetStringValue()) != null)
{
return fieldStringValue;
}
}
return null;
}
/// <summary>
/// Returns the string value of the field with the given name if any exist in
/// this document, or <c>null</c>. If multiple fields exist with this name, this
/// method returns the first value added. If only binary fields with this name
/// exist, returns <c>null</c>.
/// For <see cref="Int32Field"/>, <see cref="Int64Field"/>,
/// <see cref="SingleField"/> and <seealso cref="DoubleField"/> it returns the string value of the number. If you want
/// the actual numeric field instance back, use <see cref="GetField(string)"/>.
/// </summary>
/// <param name="format">A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.</param>
// LUCENENET specific - method added for better .NET compatibility
public string Get(string name, string format)
{
foreach (IIndexableField field in fields)
{
string fieldStringValue;
if (field.Name.Equals(name, StringComparison.Ordinal) && (fieldStringValue = field.GetStringValue(format)) != null)
{
return fieldStringValue;
}
}
return null;
}
/// <summary>
/// Returns the string value of the field with the given name if any exist in
/// this document, or <c>null</c>. If multiple fields exist with this name, this
/// method returns the first value added. If only binary fields with this name
/// exist, returns <c>null</c>.
/// For <see cref="Int32Field"/>, <see cref="Int64Field"/>,
/// <see cref="SingleField"/> and <seealso cref="DoubleField"/> it returns the string value of the number. If you want
/// the actual numeric field instance back, use <see cref="GetField(string)"/>.
/// </summary>
/// <param name="provider">An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.</param>
// LUCENENET specific - method added for better .NET compatibility
public string Get(string name, IFormatProvider provider)
{
foreach (IIndexableField field in fields)
{
string fieldStringValue;
if (field.Name.Equals(name, StringComparison.Ordinal) && (fieldStringValue = field.GetStringValue(provider)) != null)
{
return fieldStringValue;
}
}
return null;
}
/// <summary>
/// Returns the string value of the field with the given name if any exist in
/// this document, or <c>null</c>. If multiple fields exist with this name, this
/// method returns the first value added. If only binary fields with this name
/// exist, returns <c>null</c>.
/// For <see cref="Int32Field"/>, <see cref="Int64Field"/>,
/// <see cref="SingleField"/> and <seealso cref="DoubleField"/> it returns the string value of the number. If you want
/// the actual numeric field instance back, use <see cref="GetField(string)"/>.
/// </summary>
/// <param name="format">A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.</param>
/// <param name="provider">An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.</param>
// LUCENENET specific - method added for better .NET compatibility
public string Get(string name, string format, IFormatProvider provider)
{
foreach (IIndexableField field in fields)
{
string fieldStringValue;
if (field.Name.Equals(name, StringComparison.Ordinal) && (fieldStringValue = field.GetStringValue(format, provider)) != null)
{
return fieldStringValue;
}
}
return null;
}
/// <summary>
/// Prints the fields of a document for human consumption. </summary>
public override string ToString()
{
return ToString(null, J2N.Text.StringFormatter.CurrentCulture);
}
/// <summary>
/// Prints the fields of a document for human consumption.
/// </summary>
/// <param name="provider">An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.</param>
// LUCENENET specific - method added for better .NET compatibility
public string ToString(IFormatProvider provider)
{
return ToString(null, provider);
}
/// <summary>
/// Prints the fields of a document for human consumption.
/// </summary>
/// <param name="format">A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.</param>
/// <param name="provider">An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.</param>
// LUCENENET specific - method added for better .NET compatibility
private string ToString(string format, IFormatProvider provider)
{
var buffer = new StringBuilder();
buffer.Append("Document<");
for (int i = 0; i < fields.Count; i++)
{
IIndexableField field = fields[i];
if (field is IFormattable formattable)
{
buffer.Append(formattable.ToString(format, provider));
}
else
{
buffer.Append(field.ToString());
}
if (i != fields.Count - 1)
{
buffer.Append(" ");
}
}
buffer.Append(">");
return buffer.ToString();
}
/// <summary>
/// Prints the fields of a document for human consumption.
/// </summary>
/// <param name="format">A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.</param>
/// <param name="provider">An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.</param>
// LUCENENET specific - method added for better .NET compatibility
string IFormattable.ToString(string format, IFormatProvider provider)
{
return ToString(format, provider);
}
}
}