org.jahia.services.search

Class SearchResponse

java.lang.Object

org.jahia.services.search.SearchResponse

public class SearchResponse
extends Object

SearchResponse returned by the Jahia search service.

Author:

Benjamin Papez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchResponse.Facet Information about particular search facet result, including its value (term) and aggregated count.
static class	SearchResponse.FacetedResult Results, corresponding to a specific search facet.

Constructor Summary

Constructors

Constructor and Description
SearchResponse() Initializes an instance of this class.
SearchResponse(List<Hit<?>> results) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
long	getApproxCount()
SearchResponse.FacetedResult	getFacetedResult(String facetDefinitionId) Retrieves the faceted result, which corresponds to the supplied facet definition ID.
Collection<SearchResponse.FacetedResult>	getFacetedResults()
long	getLimit()
long	getOffset()
List<Hit<?>>	getResults() Holds a list of Hit objects matching the search criteria.
boolean	hasMore()
void	setApproxCount(long approxCount)
void	setFacetedResults(Collection<SearchResponse.FacetedResult> facetedResults)
void	setHasMore(boolean hasMore)
void	setLimit(long limit)
void	setOffset(long offset)
void	setResults(List<Hit<?>> results) Sets a list of Hits objects matching the search criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResponse

public SearchResponse()

Initializes an instance of this class.

SearchResponse

public SearchResponse(List<Hit<?>> results)

Initializes an instance of this class.

Parameters:

results - the search result list

Method Detail

getResults

public List<Hit<?>> getResults()

Holds a list of Hit objects matching the search criteria.

Returns:

list of Hit objects

setResults

public void setResults(List<Hit<?>> results)

Sets a list of Hits objects matching the search criteria. This setter is being used by the Jahia search service.

Parameters:

results - List of Hit objects

getFacetedResults

public Collection<SearchResponse.FacetedResult> getFacetedResults()

Returns:

Faceted results corresponding to facet definitions passed as a part of the search criteria if any, null otherwise

getFacetedResult

public SearchResponse.FacetedResult getFacetedResult(String facetDefinitionId)

Retrieves the faceted result, which corresponds to the supplied facet definition ID.

Parameters:

facetDefinitionId - the facet definition ID to retrieve results for

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)

setFacetedResults

public void setFacetedResults(Collection<SearchResponse.FacetedResult> facetedResults)

Parameters:

facetedResults - Faceted results corresponding to facet definitions passed as a part of the search criteria (if any)

getOffset

public long getOffset()

setOffset

public void setOffset(long offset)

getLimit

public long getLimit()

setLimit

public void setLimit(long limit)

hasMore

public boolean hasMore()

setHasMore

public void setHasMore(boolean hasMore)

getApproxCount

public long getApproxCount()

setApproxCount

public void setApproxCount(long approxCount)