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 notIsStored are not available in documents retrieved from the index, e.g. with Doc or Document(int).Inherited Members
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.dll
Syntax
public sealed class Document : IEnumerable<IIndexableField>, IEnumerable, IFormattableConstructors
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(int) or Document(int).
Declaration
public IList<IIndexableField> Fields { get; }Property Value
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | name |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | name | |
| IFormatProvider | provider | An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric. |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | name | |
| string | format | A standard or custom numeric format string. This parameter has no effect if this field is non-numeric. |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | name | |
| string | format | A standard or custom numeric format string. This parameter has no effect if this field is non-numeric. |
| IFormatProvider | provider | An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric. |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | name | the name of the field. |
Returns
| Type | Description |
|---|---|
| BytesRef | a BytesRef containing the binary field value or |
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 |
|---|---|---|
| string | name | the name of the field |
Returns
| Type | Description |
|---|---|
| BytesRef[] | a BytesRef[] of binary field values |
GetEnumerator()
Returns an enumerator that iterates through the collection.
Declaration
public IEnumerator<IIndexableField> GetEnumerator()Returns
| Type | Description |
|---|---|
| IEnumerator<IIndexableField> | An enumerator that can be used to iterate through the collection. |
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 |
|---|---|---|
| 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 |
|---|---|---|
| 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 |
|---|---|---|
| string | name | the name of the field |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | name | the name of the field |
| IFormatProvider | provider | An object that supplies culture-specific formatting information.This parameter has no effect if this field is non-numeric. |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | name | the name of the field |
| string | format | A standard or custom numeric format string. This parameter has no effect if this field is non-numeric. |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| string | name | the name of the field |
| string | format | A standard or custom numeric format string. This parameter has no effect if this field is non-numeric. |
| IFormatProvider | provider | An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric. |
Returns
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| 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 |
|---|---|---|
| string | name |
ToString()
Prints the fields of a document for human consumption.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string |
Overrides
ToString(IFormatProvider)
Prints the fields of a document for human consumption.
Declaration
public string ToString(IFormatProvider provider)Parameters
| Type | Name | Description |
|---|---|---|
| IFormatProvider | provider | An object that supplies culture-specific formatting information. This parameter has no effect if this field is non-numeric. |
Returns
| Type | Description |
|---|---|
| string |