org.jahia.services.search

Class SearchUtils

java.lang.Object

org.jahia.services.search.SearchUtils

public final class SearchUtils
extends Object

Search related utility methods.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
SearchUtils()

Method Summary

Modifier and Type	Method and Description
static SearchResponse.FacetedResult	getFacetedResult(String facetDefinitionId, RenderContext ctx) Retrieves the faceted result, which corresponds to the supplied facet definition ID.
static SearchResponse	getSearchResponse(RenderContext ctx) Obtains the search response object for the current search, performing a search if not yet done for current request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchUtils

public SearchUtils()

Method Detail

getFacetedResult

public static SearchResponse.FacetedResult getFacetedResult(String facetDefinitionId,
                                                            RenderContext ctx)

Retrieves the faceted result, which corresponds to the supplied facet definition ID. This call also executes the search, if it was not executed in this request yet and the request contains the search criteria.

Parameters:

facetDefinitionId - the facet definition ID to retrieve results for

ctx - current rendering context

Returns:

faceted result, which corresponds to the supplied facet definition ID, or null if there is no information about that facet (or no result for that facet is present)

getSearchResponse

public static SearchResponse getSearchResponse(RenderContext ctx)

Obtains the search response object for the current search, performing a search if not yet done for current request. If no search criteria is found in current request parameters, null is returned.

Parameters:

ctx - current rendering context

Returns:

the search response object or null if there are no search criteria in the current request