Class: Blacklight::Solr::FacetPaginator

Inherits:
FacetPaginator show all
Defined in:
lib/blacklight/solr/facet_paginator.rb

Overview

Pagination for facet values – works by setting the limit to max displayable. You have to ask Solr for limit+1, to get enough results to see if ‘more’ are available’. That is, the all_facet_values arg in constructor should be the result of asking solr for limit+1 values. This is a workaround for the fact that Solr itself can’t compute the total values for a given facet field, so we cannot know how many “pages” there are.

Instance Attribute Summary

Attributes inherited from FacetPaginator

#limit, #offset, #prefix, #sort

Instance Method Summary collapse

Methods inherited from FacetPaginator

#as_json, #current_page, #first_page?, #items, #last_page?, #next_page, #params_for_resort_url, #prev_page, #total_count, #total_pages

Constructor Details

#initialize(all_facet_values, arguments = {}) ⇒ FacetPaginator

all_facet_values is a list of facet value objects returned by solr, asking solr for n+1 facet values. options: :limit => number to display per page, or (default) nil. Nil means

display all with no previous or next.

:offset => current item offset, default 0 :sort => ‘count’ or ‘index’, solr tokens for facet value sorting, default ‘count’.



21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/blacklight/solr/facet_paginator.rb', line 21

def initialize(all_facet_values, arguments = {})
  super

  @sort = arguments[:sort].keys.first.to_s if arguments[:sort].is_a? Hash

  # count is solr's default
  @sort ||= if @limit.to_i > 0
              'count'
            else
              'index'
            end
end