Working with the FacetTrail Object

The FacetTrail object stores information about the facets in its facetValues property, which holds an array of atg.repository.search.refinement.FacetValue objects. Each FacetValue object represents a single entry in the facet trail – a facet and its value. To render the facet trail on a page, you will typically need to access the following properties of the FacetValue objects:

facet
An object of class atg.repository.search.refinement.Facet. This is an abstract base class whose subclasses represent various types of refinement elements. A Facet object has id and label properties that hold the ID of the refinement element and some associated text. For standard facets, these value are the repository ID and the display name of the refinementElement in the Refinement Repository. For the special SRCH search text facet, id is SRCH and label defaults to Search. See Incorporating Search Text as a Facet.

value
The facet selection value. Depending on the facet type, this can be text or numeric, and either a single value or a range. If the facet has multiple selection values, then this property is an array of values or ranges.

matchingDocsCount
The number of items with this facet value or in this range.

The examples in the Rendering the Facets section illustrate using these properties in JSPs.