Facets Component - BloomReach Experience - Open Source CMS

This article covers a Hippo CMS version 11. There's an updated version available that covers our most recent release.

04-07-2016

Facets Component

Class Name

The Facets Component is implemented by the class

org.onehippo.cms7.essentials.components.EssentialsFacetsComponent

Purpose

Hippo CMS has built-in support for faceted navigation. Faceted navigation makes use of a set of facets (properties) of your documents to filter and narrow-down search results. For example: show all news documents from the current month, which cover the topic "weather".

In Hippo's repository, a set of documents and facets are represented by a virtual facet navigation node tree. The Facets component provides the rendering template with a HippoFacetNavigationBean, which can be used to render the available facet navigation filtering options.

Component Parameters

Name Description
facetPath Mandatory repository path, relative to the site's root folder. The Facets component first looks at the current request URL and site map. If the corresponding repository node is a facet navigation node, the component makes the corresponding HippoFacetNavigationBean available. This typically happens when the site visitor selects one or more facet navigation filters. If the corresponding repository node is not a facet navigation node, this parameter is used to find the desired HippoFacetNavigationBean. Typically, facetPath points to the root node of a facet navigation tree.
query Free-text query string to use. Which document fields are searched for the query string depends on your indexing configuration. This parameter may be overruled by the request parameter.

Request Parameters

Name
query Free-text query string. Doesn't currently work when querying with a facet navigation scope. Overrules component parameter.

Rendering Attributes

Name Type Description
facets org.hippoecm.hst.content.beans.standard.HippoFacetNavigationBean A bean (or null) representing the current location inside a facet navigation tree. The rendering template can construct a list of filters and filter values from this bean.
query java.lang.String Normalized free-text query string, originating from the request or component parameter.
Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?