SaaS CMS has officially launched! Learn more now.

Interface IFacetManager

Stores a faceting request description, exposes the resulting processed facet requests, and builds a response from the returned facet counts.

Namespace: Mediachase.Search.Providers.Solr35
Assembly: Mediachase.Search.Solr35SearchProvider.dll
Version: 11.8.3
Syntax
public interface IFacetManager

Properties

FacetFields

An enumeration of fields to facet on.

Declaration
IEnumerable<string> FacetFields { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

FacetQueries

An enumeration of queries to facet on.

Declaration
IEnumerable<string> FacetQueries { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

Methods

BuildResponse(IEnumerable<IFacetFieldResponse>, IEnumerable<IFacetQueryResponse>, String, Boolean)

Builds a facet response suitable for inclusion in a ISearchResults object.

Declaration
IEnumerable<ISearchFacetGroup> BuildResponse(IEnumerable<IFacetFieldResponse> fieldCounts, IEnumerable<IFacetQueryResponse> queryCounts, string locale, bool specifiedValuesOnly)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IFacetFieldResponse> fieldCounts

An enumeration of counts for field facets.

System.Collections.Generic.IEnumerable<IFacetQueryResponse> queryCounts

An enumeration of counts for query facets.

System.String locale

The locale that the search was requested for.

System.Boolean specifiedValuesOnly

If true, only values explicitly included for field facets will be included in the response. If false, field facets will return all values with a count greater than 0.

Returns
Type Description
System.Collections.Generic.IEnumerable<ISearchFacetGroup>

An enumeration of ISearchFacetGroup object representing the facet results.