Class FacetField

Add an instance of this to your Lucene.Net.Documents.Document for every facet label.

NOTE: you must call Build(Document) before you add the document to Lucene.Net.Index.IndexWriter.

Inheritance

System.Object

Lucene.Net.Documents.Field

FacetField

Implements

Lucene.Net.Index.IIndexableField

System.IFormattable

Inherited Members

Lucene.Net.Documents.Field.m_type

Lucene.Net.Documents.Field.m_name

Lucene.Net.Documents.Field.FieldsData

Lucene.Net.Documents.Field.m_tokenStream

Lucene.Net.Documents.Field.m_boost

Lucene.Net.Documents.Field.GetStringValue()

Field.GetStringValue(IFormatProvider)

Field.GetStringValue(String)

Field.GetStringValue(String, IFormatProvider)

Lucene.Net.Documents.Field.GetReaderValue()

Lucene.Net.Documents.Field.GetTokenStreamValue()

Field.SetStringValue(String)

Field.SetReaderValue(TextReader)

Lucene.Net.Documents.Field.SetBytesValue(Lucene.Net.Util.BytesRef)

Field.SetBytesValue(Byte[])

Field.SetByteValue(Byte)

Field.SetInt16Value(Int16)

Field.SetInt32Value(Int32)

Field.SetInt64Value(Int64)

Field.SetSingleValue(Single)

Field.SetDoubleValue(Double)

Lucene.Net.Documents.Field.SetTokenStream(Lucene.Net.Analysis.TokenStream)

Lucene.Net.Documents.Field.Name

Lucene.Net.Documents.Field.Boost

Lucene.Net.Documents.Field.GetNumericValue()

Lucene.Net.Documents.Field.NumericType

Lucene.Net.Documents.Field.GetByteValue()

Lucene.Net.Documents.Field.GetInt16Value()

Lucene.Net.Documents.Field.GetInt32Value()

Lucene.Net.Documents.Field.GetInt64Value()

Lucene.Net.Documents.Field.GetSingleValue()

Lucene.Net.Documents.Field.GetDoubleValue()

Lucene.Net.Documents.Field.GetBinaryValue()

Field.ToString(String)

Field.ToString(IFormatProvider)

Field.ToString(String, IFormatProvider)

Lucene.Net.Documents.Field.FieldType

Lucene.Net.Documents.Field.IndexableFieldType

Lucene.Net.Documents.Field.GetTokenStream(Lucene.Net.Analysis.Analyzer)

Lucene.Net.Documents.Field.TranslateFieldType(Lucene.Net.Documents.Field.Store, Lucene.Net.Documents.Field.Index, Lucene.Net.Documents.Field.TermVector)

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

Assembly: Lucene.Net.Facet.dll

Syntax

public class FacetField : Field, IIndexableField, IFormattable

Constructors

FacetField(String, String[])

Creates the this from dim and path.

Declaration

public FacetField(string dim, params string[] path)

Parameters

Type	Name	Description
System.String	dim
System.String[]	path

Properties

Dim

Dimension for this field.

Declaration

public string Dim { get; }

Property Value

Type	Description
System.String

Path

Path for this field.

Declaration

public string[] Path { get; }

Property Value

Type	Description
System.String[]

Methods

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

Lucene.Net.Documents.Field.ToString()

VerifyLabel(String)

Verifies the label is not null or empty string.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration

public static void VerifyLabel(string label)

Parameters

Type	Name	Description
System.String	label

Implements

Lucene.Net.Index.IIndexableField

System.IFormattable