org.springframework.data.solr.core.query.result

Class SolrResultPage<T>

java.lang.Object

org.springframework.data.domain.PageImpl<T>

org.springframework.data.solr.core.query.result.SolrResultPage<T>

All Implemented Interfaces:

Serializable, Iterable<T>, Page<T>, Slice<T>, FacetPage<T>, HighlightPage<T>, ScoredPage<T>

public class SolrResultPage<T>
extends PageImpl<T>
implements FacetPage<T>, HighlightPage<T>, ScoredPage<T>

Base implementation of page holding solr response entities.

Author:

Christoph Strobl, Francisco Spaeth

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SolrResultPage(List<T> content)
SolrResultPage(List<T> content, Pageable pageable, long total, Float maxScore)

Method Summary

Modifier and Type	Method and Description
void	addAllFacetFieldResultPages(Map<Field,Page<FacetFieldEntry>> pageMap)
void	addAllFacetPivotFieldResult(Map<PivotField,List<FacetPivotFieldEntry>> resultMap)
void	addFacetPivotResultPage(List<FacetPivotFieldEntry> result, PivotField field)
void	addFacetResultPage(Page<FacetFieldEntry> page, Field field)
Collection<Page<? extends FacetEntry>>	getAllFacets()
Collection<Field>	getFacetFields() Get Fields contained in Result.
Collection<PivotField>	getFacetPivotFields() Get Pivot Fields contained in Result.
Page<FacetQueryEntry>	getFacetQueryResult()
Page<FacetFieldEntry>	getFacetResultPage(Field field) Get Facet results for field with given field
Page<FacetFieldEntry>	getFacetResultPage(String fieldname) Get Facet results for field with given name
Collection<Page<FacetFieldEntry>>	getFacetResultPages()
List<HighlightEntry<T>>	getHighlighted()
List<HighlightEntry.Highlight>	getHighlights(T entity)
Float	getMaxScore() Returns the scoring of the topmost document (max score).
List<FacetPivotFieldEntry>	getPivot(PivotField field) Get Facet Pivot results for fields with given fields.
List<FacetPivotFieldEntry>	getPivot(String fieldName) Get Facet Pivot results for fields with given fields.
void	setFacetQueryResultPage(List<FacetQueryEntry> facetQueryResult)
void	setHighlighted(List<HighlightEntry<T>> highlighted)

Methods inherited from class org.springframework.data.domain.PageImpl

equals, getTotalElements, getTotalPages, hashCode, hasNext, isLast, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.domain.Page

getTotalElements, getTotalPages

Methods inherited from interface org.springframework.data.domain.Slice

getContent, getNumber, getNumberOfElements, getSize, getSort, hasContent, hasNext, hasPrevious, isFirst, isLast, nextPageable, previousPageable

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

SolrResultPage

public SolrResultPage(List<T> content)

SolrResultPage

public SolrResultPage(List<T> content,
                      Pageable pageable,
                      long total,
                      Float maxScore)

Method Detail

getFacetResultPage

public final Page<FacetFieldEntry> getFacetResultPage(String fieldname)

Description copied from interface: FacetPage

Get Facet results for field with given name

Specified by:

getFacetResultPage in interface FacetPage<T>

Parameters:

fieldname - must not be null

Returns:

getFacetResultPage

public final Page<FacetFieldEntry> getFacetResultPage(Field field)

Description copied from interface: FacetPage

Get Facet results for field with given field

Specified by:

getFacetResultPage in interface FacetPage<T>

Returns:

getPivot

public List<FacetPivotFieldEntry> getPivot(String fieldName)

Description copied from interface: FacetPage

Get Facet Pivot results for fields with given fields.

Specified by:

getPivot in interface FacetPage<T>

Returns:

getPivot

public List<FacetPivotFieldEntry> getPivot(PivotField field)

Description copied from interface: FacetPage

Get Facet Pivot results for fields with given fields.

Specified by:

getPivot in interface FacetPage<T>

Returns:

addFacetResultPage

public final void addFacetResultPage(Page<FacetFieldEntry> page,
                                     Field field)

addFacetPivotResultPage

public final void addFacetPivotResultPage(List<FacetPivotFieldEntry> result,
                                          PivotField field)

addAllFacetFieldResultPages

public void addAllFacetFieldResultPages(Map<Field,Page<FacetFieldEntry>> pageMap)

addAllFacetPivotFieldResult

public void addAllFacetPivotFieldResult(Map<PivotField,List<FacetPivotFieldEntry>> resultMap)

getFacetResultPages

public Collection<Page<FacetFieldEntry>> getFacetResultPages()

Specified by:

getFacetResultPages in interface FacetPage<T>

Returns:

Collection holding faceting result pages

setFacetQueryResultPage

public final void setFacetQueryResultPage(List<FacetQueryEntry> facetQueryResult)

getFacetQueryResult

public Page<FacetQueryEntry> getFacetQueryResult()

Specified by:

getFacetQueryResult in interface FacetPage<T>

Returns:

empty collection if not set

getFacetFields

public Collection<Field> getFacetFields()

Description copied from interface: FacetPage

Get Fields contained in Result.

Specified by:

getFacetFields in interface FacetPage<T>

Returns:

getFacetPivotFields

public Collection<PivotField> getFacetPivotFields()

Description copied from interface: FacetPage

Get Pivot Fields contained in Result.

Specified by:

getFacetPivotFields in interface FacetPage<T>

Returns:

getAllFacets

public Collection<Page<? extends FacetEntry>> getAllFacets()

Specified by:

getAllFacets in interface FacetPage<T>

Returns:

empty collection if not available

getHighlighted

public List<HighlightEntry<T>> getHighlighted()

Specified by:

getHighlighted in interface HighlightPage<T>

Returns:

empty list of not set

setHighlighted

public void setHighlighted(List<HighlightEntry<T>> highlighted)

getHighlights

public List<HighlightEntry.Highlight> getHighlights(T entity)

Specified by:

getHighlights in interface HighlightPage<T>

Returns:

empty list if none found

getMaxScore

public Float getMaxScore()

Description copied from interface: ScoredPage

Returns the scoring of the topmost document (max score).

Specified by:

getMaxScore in interface ScoredPage<T>

Returns: