elasticmagic-query-filters/dev.evo.elasticmagic.qf/PageFilter

PageFilter

class PageFilter(name: String? = null, val availablePageSizes: List<Int> = DEFAULT_AVAILABLE_PAGE_SIZES, defaultPageSize: Int? = null, val maxHits: Int = DEFAULT_MAX_HITS) : Filter<PageFilterResult>

PageFilter allows to paginate search query results.

Parameters

name
availablePageSizes

  • list of available of per page variants

defaultPageSize

  • default number of hits per page

maxHits

  • maximum number of hits to available for a pagination

Constructors

Link copied to clipboard
constructor(name: String? = null, availablePageSizes: List<Int> = DEFAULT_AVAILABLE_PAGE_SIZES, defaultPageSize: Int? = null, maxHits: Int = DEFAULT_MAX_HITS)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val maxHits: Int
Link copied to clipboard
val name: String?

Functions

Link copied to clipboard
fun prepare(name: String, params: QueryFilterParams): PreparedFilter<PageFilterResult>

open override fun prepare(name: String, paramName: String, params: QueryFilterParams): PreparedPageFilter

Parses params and prepares the PageFilter for applying.

Link copied to clipboard