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>, Supplier<Stream<T>>, Page<T>, Slice<T>, FacetAndHighlightPage<T>, FacetPage<T>, FacetQueryResult<T>, GroupPage<T>, HighlightPage<T>, HighlightQueryResult<T>, ScoredPage<T>, SpellcheckedPage<T>, SpellcheckQueryResult, StatsPage<T>, Streamable<T>

public class SolrResultPage<T>
extends PageImpl<T>
implements FacetPage<T>, HighlightPage<T>, FacetAndHighlightPage<T>, ScoredPage<T>, GroupPage<T>, StatsPage<T>, SpellcheckedPage<T>

Base implementation of page holding solr response entities.

Author:

Christoph Strobl, Francisco Spaeth, David Webb, Petar Tahchiev

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.solr.core.query.result.SpellcheckQueryResult

SpellcheckQueryResult.Alternative

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	addAllRangeFacetFieldResultPages(Map<Field,Page<FacetFieldEntry>> pageMap)
void	addFacetPivotResultPage(List<FacetPivotFieldEntry> result, PivotField field)
void	addFacetResultPage(Page<FacetFieldEntry> page, Field field)
void	addRangeFacetResultPage(Page<FacetFieldEntry> page, Field field)
void	addSuggestions(String term, List<SpellcheckQueryResult.Alternative> suggestions)
Collection<Page<? extends FacetEntry>>	getAllFacets()
Collection<SpellcheckQueryResult.Alternative>	getAlternatives() Get all SpellcheckQueryResult.Alternatives;
Collection<SpellcheckQueryResult.Alternative>	getAlternatives(String term) Get the SpellcheckQueryResult.Alternatives for a given term.
protected <U> List<U>	getConvertedContent(Function<? super T,? extends U> arg0)
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()
FieldStatsResult	getFieldStatsResult(Field field) Get the stats result done for the given Field.
FieldStatsResult	getFieldStatsResult(String fieldName) Get the stats result done for the field with the given fieldName.
Map<String,FieldStatsResult>	getFieldStatsResults() Get all field stats results for this page.
GroupResult<T>	getGroupResult(Field field) Get a group result done for the given Field.
GroupResult<T>	getGroupResult(Function function) Get a group result done for the given Function.
GroupResult<T>	getGroupResult(Query query) Get a group result done for the given Query.
GroupResult<T>	getGroupResult(String name) Get a group result with the given name.
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.
Page<FacetFieldEntry>	getRangeFacetResultPage(Field field) Get Range Facet results for a given field with given name
Page<FacetFieldEntry>	getRangeFacetResultPage(String fieldname) Get Range Facet results for field with given name
Collection<String>	getSuggestions() Get all suggestions.
Collection<String>	getSuggestions(String term) Get the suggestions for a given term.
void	setFacetQueryResultPage(List<FacetQueryEntry> facetQueryResult)
void	setFieldStatsResults(Map<String,FieldStatsResult> fieldStatsResults)
void	setGroupResults(Map<Object,GroupResult<T>> groupResults)
void	setHighlighted(List<HighlightEntry<T>> highlighted)

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

equals, getTotalElements, getTotalPages, hashCode, hasNext, isLast, map, 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

empty, empty, getTotalElements, getTotalPages, map

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

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

Methods inherited from interface org.springframework.data.util.Streamable

and, filter, flatMap, get, isEmpty, of, of, of, stream

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,
                      @Nullable
                      Float maxScore)

Method Detail

getFacetResultPage

public final Page<FacetFieldEntry> getFacetResultPage(String fieldname)

Description copied from interface: FacetQueryResult

Get Facet results for field with given name

Specified by:

getFacetResultPage in interface FacetQueryResult<T>

Parameters:

fieldname - must not be null.

Returns:

getRangeFacetResultPage

public final Page<FacetFieldEntry> getRangeFacetResultPage(String fieldname)

Description copied from interface: FacetQueryResult

Get Range Facet results for field with given name

Specified by:

getRangeFacetResultPage in interface FacetQueryResult<T>

Parameters:

fieldname - field name (must not be null)

Returns:

facet range for the field name provided

getFacetResultPage

public final Page<FacetFieldEntry> getFacetResultPage(Field field)

Description copied from interface: FacetQueryResult

Get Facet results for field with given field

Specified by:

getFacetResultPage in interface FacetQueryResult<T>

Returns:

getRangeFacetResultPage

public final Page<FacetFieldEntry> getRangeFacetResultPage(Field field)

Description copied from interface: FacetQueryResult

Get Range Facet results for a given field with given name

Specified by:

getRangeFacetResultPage in interface FacetQueryResult<T>

Returns:

facet range page for the field provided

getPivot

public List<FacetPivotFieldEntry> getPivot(String fieldName)

Description copied from interface: FacetQueryResult

Get Facet Pivot results for fields with given fields.

Specified by:

getPivot in interface FacetQueryResult<T>

Returns:

getPivot

public List<FacetPivotFieldEntry> getPivot(PivotField field)

Description copied from interface: FacetQueryResult

Get Facet Pivot results for fields with given fields.

Specified by:

getPivot in interface FacetQueryResult<T>

Returns:

addFacetResultPage

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

addRangeFacetResultPage

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

Parameters:

page -

field -

Since:

1.5

addFacetPivotResultPage

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

addAllFacetFieldResultPages

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

addAllRangeFacetFieldResultPages

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

Parameters:

pageMap -

Since:

1.5

addAllFacetPivotFieldResult

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

getFacetResultPages

public Collection<Page<FacetFieldEntry>> getFacetResultPages()

Specified by:

getFacetResultPages in interface FacetQueryResult<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 FacetQueryResult<T>

Returns:

empty collection if not set

getFacetFields

public Collection<Field> getFacetFields()

Description copied from interface: FacetQueryResult

Get Fields contained in Result.

Specified by:

getFacetFields in interface FacetQueryResult<T>

Returns:

getFacetPivotFields

public Collection<PivotField> getFacetPivotFields()

Description copied from interface: FacetQueryResult

Get Pivot Fields contained in Result.

Specified by:

getFacetPivotFields in interface FacetQueryResult<T>

Returns:

getAllFacets

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

Specified by:

getAllFacets in interface FacetQueryResult<T>

Returns:

empty collection if not available

getHighlighted

public List<HighlightEntry<T>> getHighlighted()

Specified by:

getHighlighted in interface HighlightQueryResult<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 HighlightQueryResult<T>

Returns:

empty list if none found

setGroupResults

public void setGroupResults(Map<Object,GroupResult<T>> groupResults)

Parameters:

groupResults -

Since:

1.4

getMaxScore

@Nullable
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:

getGroupResult

public GroupResult<T> getGroupResult(Field field)

Description copied from interface: GroupPage

Get a group result done for the given Field.

Specified by:

getGroupResult in interface GroupPage<T>

Returns:

getGroupResult

public GroupResult<T> getGroupResult(Function function)

Description copied from interface: GroupPage

Get a group result done for the given Function.

Specified by:

getGroupResult in interface GroupPage<T>

Returns:

getGroupResult

public GroupResult<T> getGroupResult(Query query)

Description copied from interface: GroupPage

Get a group result done for the given Query.

Specified by:

getGroupResult in interface GroupPage<T>

Returns:

getGroupResult

public GroupResult<T> getGroupResult(String name)

Description copied from interface: GroupPage

Get a group result with the given name.

Specified by:

getGroupResult in interface GroupPage<T>

Returns:

setFieldStatsResults

public void setFieldStatsResults(Map<String,FieldStatsResult> fieldStatsResults)

Since:

1.4

getFieldStatsResult

public FieldStatsResult getFieldStatsResult(Field field)

Description copied from interface: StatsPage

Get the stats result done for the given Field.

Specified by:

getFieldStatsResult in interface StatsPage<T>

Returns:

getFieldStatsResult

public FieldStatsResult getFieldStatsResult(String fieldName)

Description copied from interface: StatsPage

Get the stats result done for the field with the given fieldName.

Specified by:

getFieldStatsResult in interface StatsPage<T>

Returns:

getFieldStatsResults

public Map<String,FieldStatsResult> getFieldStatsResults()

Description copied from interface: StatsPage

Get all field stats results for this page.

Specified by:

getFieldStatsResults in interface StatsPage<T>

Returns:

getSuggestions

public Collection<String> getSuggestions(String term)

Description copied from interface: SpellcheckQueryResult

Get the suggestions for a given term.

Specified by:

getSuggestions in interface SpellcheckQueryResult

Parameters:

term - must not be null.

Returns:

never null.

getSuggestions

public Collection<String> getSuggestions()

Description copied from interface: SpellcheckQueryResult

Get all suggestions.

Specified by:

getSuggestions in interface SpellcheckQueryResult

Returns:

never null.

addSuggestions

public void addSuggestions(String term,
                           List<SpellcheckQueryResult.Alternative> suggestions)

Specified by:

addSuggestions in interface SpellcheckQueryResult

getAlternatives

public Collection<SpellcheckQueryResult.Alternative> getAlternatives()

Description copied from interface: SpellcheckQueryResult

Get all SpellcheckQueryResult.Alternatives;

Specified by:

getAlternatives in interface SpellcheckQueryResult

Returns:

never null.

getAlternatives

public Collection<SpellcheckQueryResult.Alternative> getAlternatives(String term)

Description copied from interface: SpellcheckQueryResult

Get the SpellcheckQueryResult.Alternatives for a given term.

Specified by:

getAlternatives in interface SpellcheckQueryResult

Parameters:

term - must not be null.

Returns:

never null.

getConvertedContent

protected <U> List<U> getConvertedContent(Function<? super T,? extends U> arg0)