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

Interface FacetQueryResult<T>

Type Parameters:

T -

All Known Subinterfaces:

FacetAndHighlightPage<T>, FacetPage<T>

All Known Implementing Classes:

SolrResultPage

public interface FacetQueryResult<T>

Hold the results of a solr facet query.

Since:

2.1.0

Author:

David Webb

Method Summary

Modifier and Type	Method and Description
Collection<org.springframework.data.domain.Page<? extends FacetEntry>>	getAllFacets()
Collection<Field>	getFacetFields() Get Fields contained in Result.
Collection<PivotField>	getFacetPivotFields() Get Pivot Fields contained in Result.
org.springframework.data.domain.Page<FacetQueryEntry>	getFacetQueryResult()
org.springframework.data.domain.Page<FacetFieldEntry>	getFacetResultPage(Field field) Get Facet results for field with given field
org.springframework.data.domain.Page<FacetFieldEntry>	getFacetResultPage(String fieldname) Get Facet results for field with given name
Collection<org.springframework.data.domain.Page<FacetFieldEntry>>	getFacetResultPages()
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.
org.springframework.data.domain.Page<FacetFieldEntry>	getRangeFacetResultPage(Field field) Get Range Facet results for a given field with given name
org.springframework.data.domain.Page<FacetFieldEntry>	getRangeFacetResultPage(String fieldname) Get Range Facet results for field with given name

Method Detail

getFacetResultPage

org.springframework.data.domain.Page<FacetFieldEntry> getFacetResultPage(String fieldname)

Get Facet results for field with given name

Parameters:

fieldname - must not be null.

Returns:

getFacetResultPage

org.springframework.data.domain.Page<FacetFieldEntry> getFacetResultPage(Field field)

Get Facet results for field with given field

Parameters:

field -

Returns:

getRangeFacetResultPage

org.springframework.data.domain.Page<FacetFieldEntry> getRangeFacetResultPage(String fieldname)

Get Range Facet results for field with given name

Parameters:

fieldname - field name (must not be null)

Returns:

facet range for the field name provided

Since:

1.5

getRangeFacetResultPage

org.springframework.data.domain.Page<FacetFieldEntry> getRangeFacetResultPage(Field field)

Get Range Facet results for a given field with given name

Parameters:

field -

Returns:

facet range page for the field provided

Since:

1.5

getPivot

List<FacetPivotFieldEntry> getPivot(String fieldName)

Get Facet Pivot results for fields with given fields.

Parameters:

fields - pivot field name

Returns:

getPivot

List<FacetPivotFieldEntry> getPivot(PivotField field)

Get Facet Pivot results for fields with given fields.

Parameters:

fields - pivot field

Returns:

getFacetResultPages

Collection<org.springframework.data.domain.Page<FacetFieldEntry>> getFacetResultPages()

Returns:

Collection holding faceting result pages

getFacetQueryResult

org.springframework.data.domain.Page<FacetQueryEntry> getFacetQueryResult()

Returns:

empty collection if not set

getFacetFields

Collection<Field> getFacetFields()

Get Fields contained in Result.

Returns:

getFacetPivotFields

Collection<PivotField> getFacetPivotFields()

Get Pivot Fields contained in Result.

Returns:

getAllFacets

Collection<org.springframework.data.domain.Page<? extends FacetEntry>> getAllFacets()

Returns:

empty collection if not available