Class DocumentExtensions
LUCENENET specific extensions to the Lucene.Net.Documents.Document class.
Inheritance
Inherited Members
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.Facet.dll
Syntax
public static class DocumentExtensions
Methods
| Improve this Doc View SourceAddAssociationFacetField(Document, BytesRef, String, String[])
Adds a new AssociationFacetField using dim
and path
and an
association.
Declaration
public static AssociationFacetField AddAssociationFacetField(this Document document, BytesRef assoc, string dim, params string[] path)
Parameters
Type | Name | Description |
---|---|---|
Lucene.Net.Documents.Document | document | This Lucene.Net.Documents.Document. |
Lucene.Net.Util.BytesRef | assoc | Associated value. |
System.String | dim | Dimension for this field. |
System.String[] | path | Facet path for this field. |
Returns
Type | Description |
---|---|
AssociationFacetField | The field that was added to this Lucene.Net.Documents.Document. |
AddFacetField(Document, String, String[])
Adds a new FacetField with the specified dim
and
path
.
Declaration
public static FacetField AddFacetField(this Document document, string dim, params string[] path)
Parameters
Type | Name | Description |
---|---|---|
Lucene.Net.Documents.Document | document | This Lucene.Net.Documents.Document. |
System.String | dim | Dimension for this field. |
System.String[] | path | Facet path for this field. |
Returns
Type | Description |
---|---|
FacetField | The field that was added to this Lucene.Net.Documents.Document. |
AddInt32AssociationFacetField(Document, Int32, String, String[])
Adds a new Int32AssociationFacetField using dim
and path
and an
System.Int32 association.
Declaration
public static Int32AssociationFacetField AddInt32AssociationFacetField(this Document document, int assoc, string dim, params string[] path)
Parameters
Type | Name | Description |
---|---|---|
Lucene.Net.Documents.Document | document | This Lucene.Net.Documents.Document. |
System.Int32 | assoc | Associated value. |
System.String | dim | Dimension for this field. |
System.String[] | path | Facet path for this field. |
Returns
Type | Description |
---|---|
Int32AssociationFacetField | The field that was added to this Lucene.Net.Documents.Document. |
AddSingleAssociationFacetField(Document, Single, String, String[])
Adds a new SingleAssociationFacetField using dim
and path
and a
System.Single association.
Declaration
public static SingleAssociationFacetField AddSingleAssociationFacetField(this Document document, float assoc, string dim, params string[] path)
Parameters
Type | Name | Description |
---|---|---|
Lucene.Net.Documents.Document | document | This Lucene.Net.Documents.Document. |
System.Single | assoc | Associated value. |
System.String | dim | Dimension for this field. |
System.String[] | path | Facet path for this field. |
Returns
Type | Description |
---|---|
SingleAssociationFacetField | The field that was added to this Lucene.Net.Documents.Document. |
AddSortedSetDocValuesFacetField(Document, String, String)
Adds a new SortedSetDocValuesFacetField.
Declaration
public static SortedSetDocValuesFacetField AddSortedSetDocValuesFacetField(this Document document, string dim, string label)
Parameters
Type | Name | Description |
---|---|---|
Lucene.Net.Documents.Document | document | This Lucene.Net.Documents.Document. |
System.String | dim | Dimension for this field. |
System.String | label | Label for this field. |
Returns
Type | Description |
---|---|
SortedSetDocValuesFacetField | The field that was added to this Lucene.Net.Documents.Document. |
Remarks
Add a SortedSetDocValuesFacetField to your Lucene.Net.Documents.Document for every facet label to be indexed via Lucene.Net.Index.SortedSetDocValues.