Delivery Tier Search Queries - BloomReach Experience - Open Source CMS

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

24-07-2017

Delivery Tier Search Queries

Introduction

Goal

Construct and execute search queries and render the results in Hippo's delivery tier.

Background

Hippo's delivery tier (HST) provides a Java API to create and execute searches. When a query is executed, an HstQuery object is translated into a JCR XPath query, which is executed in the Hippo Repository. The Repository returns JCR Nodes as hits, which are mapped to HippoBeans in an HstQueryResult object.

Delivery Tier Search APIs

Hippo's delivery tier provides two APIs for constructing and executing search queries:

  • Fluent Search API
    This API is available since BloomReach Experience Manager 11.1 and provides a way to construct queries that is intuitive and results in robust and readable code. This is the recommended search API for new implementation projects.
  • Legacy Search API
    This was the only available search API until the release of BloomReach Experience Manager 11.1. Future releases of BloomReach Experience Manager will continue to support this API and existing projects using this API can continue to do so.

Both APIs provide equivalent functionality. The only differences between them are the improved robustness and readability of the Fluent Search API.

Render a Search Query Result

Regardless of the API used, the result of a search query is provided as an HstQueryResult object. Therefore, rendering a search query result is the same for both APIs. Example JSP and Freemarker templates are provided at the following page:

 

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?