Class LuceneFacetLabel

Namespace

Examine.Lucene.Search

Assembly

Examine.Lucene.dll

Lucene Facet Label

public class LuceneFacetLabel : IFacetLabel, IComparable<IFacetLabel>

Inheritance

object

LuceneFacetLabel

Implements

IFacetLabel

IComparable<IFacetLabel>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LuceneFacetLabel(FacetLabel)

Constructor

public LuceneFacetLabel(FacetLabel facetLabel)

Parameters

facetLabel FacetLabel

Lucene Facet Label

Properties

Components

The components of this IFacetLabel.

public string[] Components { get; }

Property Value

string[]

Length

The number of components of this IFacetLabel.

public int Length { get; }

Property Value

int

Methods

CompareTo(IFacetLabel?)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

public int CompareTo(IFacetLabel? other)

Parameters

other IFacetLabel

An object to compare with this instance.

Returns

int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance precedes other in the sort order.
Zero	This instance occurs in the same position in the sort order as other.
Greater than zero	This instance follows other in the sort order.

Subpath(int)

Returns a sub-path of this path up to length components.

public IFacetLabel Subpath(int length)

Parameters

length int

Returns

IFacetLabel