org.jahia.services.search

Class SearchResponse.FacetedResult

java.lang.Object

org.jahia.services.search.SearchResponse.FacetedResult

Enclosing class:

SearchResponse

public static class SearchResponse.FacetedResult
extends Object

Results, corresponding to a specific search facet.

Constructor Summary

Constructors

Constructor and Description
FacetedResult(String id, List<SearchResponse.Facet> facets)

Method Summary

Modifier and Type	Method and Description
SearchResponse.Facet	getFacet(String valueAsString) Facet, requested by its string value.
List<SearchResponse.Facet>	getFacets() A list of facets.
String	getId() Returns identifier of the corresponding facet definition to match this faceted result to.
boolean	isResultEmpty() Checks that the faceted result is empty, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetedResult

public FacetedResult(String id,
                     List<SearchResponse.Facet> facets)

Method Detail

getId

public String getId()

Returns identifier of the corresponding facet definition to match this faceted result to.

Returns:

identifier of the corresponding facet definition to match this faceted result to

getFacet

public SearchResponse.Facet getFacet(String valueAsString)

Facet, requested by its string value.

Parameters:

valueAsString - the facet string value to retrieve facet for

Returns:

Facet, requested by its string value, or null if there is no corresponding facet

getFacets

public List<SearchResponse.Facet> getFacets()

A list of facets.

Returns:

a list of of facets

isResultEmpty

public boolean isResultEmpty()

Checks that the faceted result is empty, i.e. either it has no facets or all facets have empty values.

Returns:

true if the faceted result is considered as empty; false otherwise