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 stored (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 or Document(Int32).

Inheritance

System.Object

Document

Namespace: Lucene.Net.Documents

Assembly: Lucene.Net.dll

Syntax

public sealed class Document : IEnumerable<IIndexableField>

Constructors

| Improve this Doc View Source

Document()

Constructs a new document with no fields.

Declaration

public Document()

Properties

| Improve this Doc View Source

Fields

Returns a List of all the fields in a document.

Note that fields which are not stored are not available in documents retrieved from the index, e.g. Doc(Int32) or Document(Int32).

Declaration

public IList<IIndexableField> Fields { get; }

Property Value

Type	Description
IList<IIndexableField>

Methods

| Improve this Doc View Source

Add(IIndexableField)

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(String) and 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.

Declaration

public void Add(IIndexableField field)

Parameters

Type	Name	Description
IIndexableField	field

| Improve this Doc View Source

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. For Int32Field, Int64Field, SingleField and DoubleField it returns the string value of the number. If you want the actual numeric field instance back, use GetField(String).

Declaration

public string Get(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.String

| Improve this Doc View Source

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 null if no binary fields with the specified name are available. There may be non-binary fields with the same name.

Declaration

public BytesRef GetBinaryValue(string name)

Parameters

Type	Name	Description
System.String	name	the name of the field.

Returns

Type	Description
BytesRef	a BytesRef containing the binary field value or `null`

| Improve this Doc View Source

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.

Declaration

public BytesRef[] GetBinaryValues(string name)

Parameters

Type	Name	Description
System.String	name	the name of the field

Returns

Type	Description
BytesRef[]	a BytesRef[] of binary field values

| Improve this Doc View Source

GetEnumerator()

Declaration

public IEnumerator<IIndexableField> GetEnumerator()

Returns

Type	Description
IEnumerator<IIndexableField>

| Improve this Doc View Source

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.

Declaration

public IIndexableField GetField(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
IIndexableField

| Improve this Doc View Source

GetFields(String)

Returns an array of IIndexableFields with the given name. This method returns an empty array when there are no matching fields. It never returns null.

Declaration

public IIndexableField[] GetFields(string name)

Parameters

Type	Name	Description
System.String	name	the name of the field

Returns

Type	Description
IIndexableField[]	a IndexableField[] array

| Improve this Doc View Source

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. For Int32Field, Int64Field, SingleField and DoubleField it returns the string value of the number. If you want the actual numeric field instances back, use GetFields(String).

Declaration

public string[] GetValues(string name)

Parameters

Type	Name	Description
System.String	name	the name of the field

Returns

Type	Description
System.String[]	a string[] of field values

| Improve this Doc View Source

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(String) and 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.