Class Document
Documents are the unit of indexing and search.
A Document is a set of fields. Each field has a name and a textual value. A field may be 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.
Note that fields which are not IsStored are not available in documents retrieved from the index, e.g. with Doc, Doc(Int32) or Document(Int32).
Inheritance
Namespace:
Assembly: Lucene.Net.NetCore.dll
Syntax
public sealed class Document : objectConstructors
| Name | Description |
|---|---|
| Document() | Constructs a new document with no fields. |
Properties
| Name | Description |
|---|---|
| Boost | Gets or sets, at indexing time, the boost factor. The default is 1.0 Note that once a document is indexed this value is no longer available from the index. At search time, for retrieved documents, this method always returns 1. This however does not mean that the boost value set at indexing time was ignored - it was just combined with other indexing time factors and stored elsewhere, for better indexing and search performance. (For more information see the "norm(t,d)" part of the scoring formula in Similarity.) |
| fields_ForNUnit |
Methods
| Name | Description |
|---|---|
| Add(IFieldable) | 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.
Note that add like the removeField(s) 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.
|
| Get(String) | Returns the string value of the field with the given name if any exist in this document, or null. If multiple fields exist with this name, this method returns the first value added. If only binary fields with this name exist, returns null. |
| GetBinaryValue(String) | Returns an array of bytes for the first (or only) field that has the name
specified as the method parameter. This method will return |
| GetBinaryValues(String) | 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 null. |
| GetField(String) | Returns a field with the given name if any exist in this document, or null. If multiple fields exists with this name, this method returns the first value added. Do not use this method with lazy loaded fields. |
| GetFieldable(String) | Returns a field with the given name if any exist in this document, or null. If multiple fields exists with this name, this method returns the first value added. |
| GetFieldables(String) | Returns an array of IFieldables with the given name. This method returns an empty array when there are no matching fields. It never returns null. |
| GetFields() | Returns a List of all the fields in a document. Note that fields which are not IsStored are not available in documents retrieved from the index, e.g. Doc(Int32) or Document(Int32). |
| GetFields(String) | Returns an array of Fields with the given name. Do not use with lazy loaded fields. This method returns an empty array when there are no matching fields. It never returns null. |
| GetValues(String) | 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 null. |
| RemoveField(String) | 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.
Note that the removeField(s) 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.
|
| RemoveFields(String) | Removes all fields with the given name from the document. If there is no field with the specified name, the document remains unchanged.
Note that the removeField(s) 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.
|
| ToString() | Prints the fields of a document for human consumption. |