io.sphere.sdk.search

Interface PagedSearchResult<T>

All Superinterfaces:

PagedResult<T>

public interface PagedSearchResult<T>
extends PagedResult<T>

Method Summary

Modifier and Type	Method and Description
static <T> io.sphere.sdk.search.PagedSearchResultImpl<T>	empty() Creates a {@link PagedSearchResult} for search with no matching values.
FilteredFacetResult	getFacetResult(FilteredFacetExpression<T> facetExpression) Obtains the FilteredFacetResult of the facet with the given facet expression.
RangeFacetResult	getFacetResult(RangeFacetedSearchExpression<T> facetedSearchExpression) Obtains the RangeFacetResult of the facet with the given facet search expression.
RangeFacetResult	getFacetResult(RangeFacetExpression<T> facetExpression) Obtains the RangeFacetResult of the facet with the given facet expression.
FacetResult	getFacetResult(String facetResultPath) Obtains the FacetResult of the facet with the given result path.
TermFacetResult	getFacetResult(TermFacetedSearchExpression<T> facetedSearchExpression) Obtains the TermFacetResult of the facet with the given facet search expression.
TermFacetResult	getFacetResult(TermFacetExpression<T> facetExpression) Obtains the TermFacetResult of the facet with the given facet expression.
Map<String,FacetResult>	getFacetsResults()
FilteredFacetResult	getFilteredFacetResult(String facetResultPath) Obtains the FilteredFacetResult of the facet with the given facet expression.
Long	getOffset() The offset supplied by the client or the server default.
RangeFacetResult	getRangeFacetResult(String facetResultPath) Obtains the RangeFacetResult of the facet with the given facet expression.
SimpleRangeStats	getRangeStatsOfAllRanges(RangeFacetedSearchExpression<T> facetedSearchExpression) Obtains the SimpleRangeStats of the range facet.
SimpleRangeStats	getRangeStatsOfAllRanges(RangeFacetExpression<T> facetExpression) Obtains the SimpleRangeStats of the range facet.
List<T>	getResults() List of results.
TermFacetResult	getTermFacetResult(String facetResultPath) Obtains the TermFacetResult of the facet with the given facet expression.
Long	getTotal() The total number of results matching the request.

Methods inherited from interface io.sphere.sdk.queries.PagedResult

getCount, getLimit, getPageIndex, getTotalPages, head, isFirst, isLast, size

Method Detail

getFacetsResults

Map<String,FacetResult> getFacetsResults()

empty

static <T> io.sphere.sdk.search.PagedSearchResultImpl<T> empty()

Creates a {@link PagedSearchResult} for search with no matching values.

Type Parameters:

T - the type of the underlying model

Returns:

an empty PagedSearchResult

getFacetResult

@Nullable
FacetResult getFacetResult(String facetResultPath)

Obtains the FacetResult of the facet with the given result path.

Parameters:

facetResultPath - the facet result path, which is either the attribute path or the alias

Returns:

the facet result for the given facet or null

getFacetResult

@Nullable
TermFacetResult getFacetResult(TermFacetExpression<T> facetExpression)

Obtains the TermFacetResult of the facet with the given facet expression.

Parameters:

facetExpression - the facet expression

Returns:

the facet result for the given facet or null

getFacetResult

@Nullable
RangeFacetResult getFacetResult(RangeFacetExpression<T> facetExpression)

Obtains the RangeFacetResult of the facet with the given facet expression.

Parameters:

facetExpression - the facet expression

Returns:

the facet result for the given facet or null

getFacetResult

@Nullable
FilteredFacetResult getFacetResult(FilteredFacetExpression<T> facetExpression)

Obtains the FilteredFacetResult of the facet with the given facet expression.

Parameters:

facetExpression - the facet expression

Returns:

the facet result for the given facet or null

getFacetResult

@Nullable
TermFacetResult getFacetResult(TermFacetedSearchExpression<T> facetedSearchExpression)

Obtains the TermFacetResult of the facet with the given facet search expression.

Parameters:

facetedSearchExpression - the facet search expression

Returns:

the facet result for the given facet or null

getFacetResult

@Nullable
RangeFacetResult getFacetResult(RangeFacetedSearchExpression<T> facetedSearchExpression)

Obtains the RangeFacetResult of the facet with the given facet search expression.

Parameters:

facetedSearchExpression - the facet search expression

Returns:

the facet result for the given facet or null

getRangeStatsOfAllRanges

SimpleRangeStats getRangeStatsOfAllRanges(RangeFacetExpression<T> facetExpression)

Obtains the SimpleRangeStats of the range facet. This method should only be used when the range facet has the form (* to "0"),("0" to *), which is obtained when calling RangeTermFacetedSearchSearchModel.allRanges().

Parameters:

facetExpression - the range facet expression

Returns:

a SimpleRangeStats for the given range facet

Throws:

IllegalArgumentException - if the given range facet has an invalid form

getRangeStatsOfAllRanges

SimpleRangeStats getRangeStatsOfAllRanges(RangeFacetedSearchExpression<T> facetedSearchExpression)

Obtains the SimpleRangeStats of the range facet. This method should only be used when the range facet has the form (* to "0"),("0" to *), which is obtained when calling RangeTermFacetedSearchSearchModel.allRanges().

Parameters:

facetedSearchExpression - the range facet search expression

Returns:

a SimpleRangeStats for the given range facet

Throws:

IllegalArgumentException - if the given range facet has an invalid form

getTermFacetResult

@Nullable
TermFacetResult getTermFacetResult(String facetResultPath)

Obtains the TermFacetResult of the facet with the given facet expression.

Parameters:

facetResultPath - the facet result path

Returns:

the facet result for the given facet or null

getRangeFacetResult

@Nullable
RangeFacetResult getRangeFacetResult(String facetResultPath)

Obtains the RangeFacetResult of the facet with the given facet expression.

Parameters:

facetResultPath - the facet result path

Returns:

the facet result for the given facet or null

getFilteredFacetResult

@Nullable
FilteredFacetResult getFilteredFacetResult(String facetResultPath)

Obtains the FilteredFacetResult of the facet with the given facet expression.

Parameters:

facetResultPath - the facet result path

Returns:

the facet result for the given facet or null

getResults

List<T> getResults()

Description copied from interface: PagedResult

List of results. If PagedResult.getCount() is not equal to PagedResult.getTotal() the container contains only a subset of all elements that match the request.

Specified by:

getResults in interface PagedResult<T>

Returns:

PagedResult.getCount() elements matching the request

getOffset

Long getOffset()

Description copied from interface: PagedResult

The offset supplied by the client or the server default.

Specified by:

getOffset in interface PagedResult<T>

Returns:

the amount of items (not pages) skipped

getTotal

Long getTotal()

Description copied from interface: PagedResult

The total number of results matching the request. Total is greater or equal to count.

Specified by:

getTotal in interface PagedResult<T>

Returns:

the number of elements that can be fetched matching the criteria