Class DocumentExtensions

LUCENENET specific extensions to the Lucene.Net.Documents.Document class.

Inheritance

object

DocumentExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Documents.Extensions

Assembly: Lucene.Net.ICU.dll

Syntax

public static class DocumentExtensions

Methods

AddICUCollationDocValuesField(Document, string, Collator)

Adds a new ICUCollationDocValuesField.

NOTE: you should not create a new one for each document, instead just make one and reuse it during your indexing process, setting the value via SetStringValue(string).

Declaration

public static ICUCollationDocValuesField AddICUCollationDocValuesField(this Document document, string name, Collator collator)

Parameters

Type	Name	Description
Document	document	This Lucene.Net.Documents.Document.
string	name	Field name.
Collator	collator	Collator for generating collation keys.

Returns

Type	Description
ICUCollationDocValuesField	The field that was added to this Lucene.Net.Documents.Document.

Exceptions

Type	Condition
ArgumentNullException	This document, name or collator is null.