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

Implements

System.Collections.Generic.IEnumerable<IIndexableField>

System.Collections.IEnumerable

System.IFormattable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Lucene.Net.Documents

Assembly: Lucene.Net.dll

Syntax

public sealed class Document : IEnumerable<IIndexableField>, IEnumerable, IFormattable

Constructors

Document()

Constructs a new document with no fields.

Declaration

public Document()

Properties

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
System.Collections.Generic.IList<IIndexableField>

Methods

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

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

Get(String, IFormatProvider)

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, IFormatProvider provider)

Parameters

Type	Name	Description
System.String	name
System.IFormatProvider	provider	An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.

Returns

Type	Description
System.String

Get(String, 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, string format)

Parameters

Type	Name	Description
System.String	name
System.String	format	A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.

Returns

Type	Description
System.String

Get(String, String, IFormatProvider)

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, string format, IFormatProvider provider)

Parameters

Type	Name	Description
System.String	name
System.String	format	A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.
System.IFormatProvider	provider	An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.

Returns

Type	Description
System.String

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

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

GetEnumerator()

Declaration

public IEnumerator<IIndexableField> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<IIndexableField>

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

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

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

GetValues(String, IFormatProvider)

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, IFormatProvider provider)

Parameters

Type	Name	Description
System.String	name	the name of the field
System.IFormatProvider	provider	An object that supplies culture-specific formatting information.This parameter has no effect if this field is non-numeric.

Returns

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

GetValues(String, 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, string format)

Parameters

Type	Name	Description
System.String	name	the name of the field
System.String	format	A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.

Returns

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

GetValues(String, String, IFormatProvider)

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, string format, IFormatProvider provider)

Parameters

Type	Name	Description
System.String	name	the name of the field
System.String	format	A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.
System.IFormatProvider	provider	An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.

Returns

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

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.

Declaration

public void RemoveField(string name)

Parameters

Type	Name	Description
System.String	name

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(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.

Declaration

public void RemoveFields(string name)

Parameters

Type	Name	Description
System.String	name

ToString()

Prints the fields of a document for human consumption.

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

ToString(IFormatProvider)

Prints the fields of a document for human consumption.

Declaration

public string ToString(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider	An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.

Returns

Type	Description
System.String

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator

IFormattable.ToString(String, IFormatProvider)

Prints the fields of a document for human consumption.

Declaration

string IFormattable.ToString(string format, IFormatProvider provider)

Parameters

Type	Name	Description
System.String	format	A standard or custom numeric format string. This parameter has no effect if this field is non-numeric.
System.IFormatProvider	provider	An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric.

Returns

Type	Description
System.String

Implements

System.Collections.Generic.IEnumerable<T>

System.Collections.IEnumerable

System.IFormattable

Extension Methods

DocumentExtensions.GetField<T>(Document, String)

DocumentExtensions.GetFields<T>(Document, String)

DocumentExtensions.AddBinaryDocValuesField(Document, String, BytesRef)

DocumentExtensions.AddDoubleDocValuesField(Document, String, Double)

DocumentExtensions.AddDoubleField(Document, String, Double, Field.Store)

DocumentExtensions.AddDoubleField(Document, String, Double, FieldType)

DocumentExtensions.AddSingleDocValuesField(Document, String, Single)

DocumentExtensions.AddSingleField(Document, String, Single, Field.Store)

DocumentExtensions.AddSingleField(Document, String, Single, FieldType)

DocumentExtensions.AddInt32Field(Document, String, Int32, Field.Store)

DocumentExtensions.AddInt32Field(Document, String, Int32, FieldType)

DocumentExtensions.AddInt64Field(Document, String, Int64, Field.Store)

DocumentExtensions.AddInt64Field(Document, String, Int64, FieldType)

DocumentExtensions.AddNumericDocValuesField(Document, String, Int64)

DocumentExtensions.AddSortedDocValuesField(Document, String, BytesRef)

DocumentExtensions.AddSortedSetDocValuesField(Document, String, BytesRef)

DocumentExtensions.AddStoredField(Document, String, Byte[])

DocumentExtensions.AddStoredField(Document, String, Byte[], Int32, Int32)

DocumentExtensions.AddStoredField(Document, String, BytesRef)

DocumentExtensions.AddStoredField(Document, String, String)

DocumentExtensions.AddStoredField(Document, String, Int32)

DocumentExtensions.AddStoredField(Document, String, Single)

DocumentExtensions.AddStoredField(Document, String, Int64)

DocumentExtensions.AddStoredField(Document, String, Double)

DocumentExtensions.AddStringField(Document, String, String, Field.Store)

DocumentExtensions.AddTextField(Document, String, TextReader)

DocumentExtensions.AddTextField(Document, String, String, Field.Store)

DocumentExtensions.AddTextField(Document, String, TokenStream)