Class Facets
Common base class for all facets implementations.
Note
This API is experimental and might change in incompatible ways in the next release.
Inherited Members
Namespace: Lucene.Net.Facet
Assembly: Lucene.Net.Facet.dll
Syntax
public abstract class FacetsConstructors
Facets()
Default constructor.
Declaration
protected Facets()Methods
GetAllDims(int)
Returns topN labels for any dimension that had hits, sorted by the number of hits that dimension matched; this is used for "sparse" faceting, where many different dimensions were indexed, for example depending on the type of document.
Declaration
public abstract IList<FacetResult> GetAllDims(int topN)Parameters
| Type | Name | Description |
|---|---|---|
| int | topN |
Returns
| Type | Description |
|---|---|
| IList<FacetResult> |
GetSpecificValue(string, params string[])
Return the count or value for a specific path. Returns -1 if this path doesn't exist, else the count.
Declaration
public abstract float GetSpecificValue(string dim, params string[] path)Parameters
| Type | Name | Description |
|---|---|---|
| string | dim | |
| string[] | path |
Returns
| Type | Description |
|---|---|
| float |
GetTopChildren(int, string, params string[])
Returns the topN child labels under the specified path. Returns null if the specified path doesn't exist or if this dimension was never seen.
Declaration
public abstract FacetResult GetTopChildren(int topN, string dim, params string[] path)Parameters
| Type | Name | Description |
|---|---|---|
| int | topN | |
| string | dim | |
| string[] | path |
Returns
| Type | Description |
|---|---|
| FacetResult |