Spring Data Solr

org.springframework.data.solr.core.query.result
Interface FacetPage<T>

Type Parameters:
T -
All Superinterfaces:
Iterable<T>, Page<T>
All Known Implementing Classes:
SolrResultPage

public interface FacetPage<T>
extends Page<T>

FacetPage holds a page for each field targeted by the facet query as well as the page values returned by facet.query

Author:
Christoph Strobl, Francisco Spaeth

Method Summary
 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<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.
 
Methods inherited from interface org.springframework.data.domain.Page
getContent, getNumber, getNumberOfElements, getSize, getSort, getTotalElements, getTotalPages, hasContent, hasNextPage, hasPreviousPage, isFirstPage, isLastPage, iterator, nextPageable, previousPageable
 

Method Detail

getFacetResultPage

Page<FacetFieldEntry> getFacetResultPage(String fieldname)
Get Facet results for field with given name

Parameters:
fieldname - must not be null
Returns:

getFacetResultPage

Page<FacetFieldEntry> getFacetResultPage(Field field)
Get Facet results for field with given field

Parameters:
field -
Returns:

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<Page<FacetFieldEntry>> getFacetResultPages()
Returns:
Collection holding faceting result pages

getFacetQueryResult

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<Page<? extends FacetEntry>> getAllFacets()
Returns:
empty collection if not available

Spring Data Solr

Copyright © 2011-2014-2014 Pivotal. All Rights Reserved.