Class FacetLabel

Holds a sequence of string components, specifying the hierarchical name of a category.

This is a Lucene.NET INTERNAL API, use at your own risk
Inheritance
System.Object
FacetLabel
Implements
System.IComparable<FacetLabel>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Facet.Taxonomy
Assembly: Lucene.Net.Facet.dll
Syntax
public class FacetLabel : IComparable<FacetLabel>

Constructors

| Improve this Doc View Source

FacetLabel(String, String[])

Construct from the dimension plus the given path components.

Declaration
public FacetLabel(string dim, string[] path)
Parameters
Type Name Description
System.String dim
System.String[] path
| Improve this Doc View Source

FacetLabel(String[])

Construct from the given path components.

Declaration
public FacetLabel(params string[] components)
Parameters
Type Name Description
System.String[] components

Fields

| Improve this Doc View Source

MAX_CATEGORY_PATH_LENGTH

The maximum number of characters a FacetLabel can have.

Declaration
public static readonly int MAX_CATEGORY_PATH_LENGTH
Field Value
Type Description
System.Int32

Properties

| Improve this Doc View Source

Components

The components of this FacetLabel. Note that this array may be shared with other FacetLabel instances, e.g. as a result of Subpath(Int32), therefore you should traverse the array up to Length for this path's components.

Declaration
public string[] Components { get; }
Property Value
Type Description
System.String[]
| Improve this Doc View Source

Length

The number of components of this FacetLabel.

Declaration
public int Length { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

CompareTo(FacetLabel)

Compares this path with another FacetLabel for lexicographic order.

Declaration
public virtual int CompareTo(FacetLabel other)
Parameters
Type Name Description
FacetLabel other
Returns
Type Description
System.Int32
| Improve this Doc View Source

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()
| Improve this Doc View Source

Int64HashCode()

Calculate a 64-bit hash function for this path. This is necessary for NameHashInt32CacheLru (the default cache impl for LruTaxonomyWriterCache) to reduce the chance of "silent but deadly" collisions.

NOTE: This was longHashCode() in Lucene

Declaration
public virtual long Int64HashCode()
Returns
Type Description
System.Int64
| Improve this Doc View Source

Subpath(Int32)

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

Declaration
public virtual FacetLabel Subpath(int length)
Parameters
Type Name Description
System.Int32 length
Returns
Type Description
FacetLabel
| Improve this Doc View Source

ToString()

Returns a string representation of the path.

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Operators

| Improve this Doc View Source

Equality(FacetLabel, FacetLabel)

Declaration
public static bool operator ==(FacetLabel left, FacetLabel right)
Parameters
Type Name Description
FacetLabel left
FacetLabel right
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterThan(FacetLabel, FacetLabel)

Declaration
public static bool operator>(FacetLabel left, FacetLabel right)
Parameters
Type Name Description
FacetLabel left
FacetLabel right
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GreaterThanOrEqual(FacetLabel, FacetLabel)

Declaration
public static bool operator >=(FacetLabel left, FacetLabel right)
Parameters
Type Name Description
FacetLabel left
FacetLabel right
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Inequality(FacetLabel, FacetLabel)

Declaration
public static bool operator !=(FacetLabel left, FacetLabel right)
Parameters
Type Name Description
FacetLabel left
FacetLabel right
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessThan(FacetLabel, FacetLabel)

Declaration
public static bool operator <(FacetLabel left, FacetLabel right)
Parameters
Type Name Description
FacetLabel left
FacetLabel right
Returns
Type Description
System.Boolean
| Improve this Doc View Source

LessThanOrEqual(FacetLabel, FacetLabel)

Declaration
public static bool operator <=(FacetLabel left, FacetLabel right)
Parameters
Type Name Description
FacetLabel left
FacetLabel right
Returns
Type Description
System.Boolean

Implements

System.IComparable<T>