Package org.nuxeo.ecm.platform.query.api

Class PageProviderSpec.Builder

java.lang.Object

org.nuxeo.ecm.platform.query.api.PageProviderSpec.Builder

Enclosing class:

PageProviderSpec

public static class PageProviderSpec.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	currentPage
protected Long	currentPageOffset
protected final PageProviderDefinition	definition
protected Collection<String>	highlights
protected final String	name
protected Long	pageSize
protected final List<Object>	parameters
protected final Map<String,Serializable>	properties
protected Collection<QuickFilter>	quickFilters
protected DocumentModel	searchDocument
protected Collection<SortInfo>	sortInfos

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(String name, PageProviderDefinition definition)

Method Summary

Modifier and Type	Method	Description
PageProviderSpec	build()
PageProviderSpec.Builder	currentPage(Long currentPage)
PageProviderSpec.Builder	currentPageOffset(Long currentPageOffset)
PageProviderSpec.Builder	highlight(String highlight)	Appends the given highlight to this builder's highlights.
PageProviderSpec.Builder	highlights(Collection<String> highlights)	Sets the given highlights to this builder's highlights.
PageProviderSpec.Builder	pageSize(Long pageSize)
PageProviderSpec.Builder	parameter(Object parameter)	Appends the given parameter to this builder's parameters.
PageProviderSpec.Builder	parameters(Object... parameters)	Appends the given parameters to this builder's parameters.
PageProviderSpec.Builder	parameters(Collection<?> parameters)	Appends the given parameters to this builder's parameters.
PageProviderSpec.Builder	properties(Map<String,Serializable> properties)	Puts all the given properties into this builder's properties.
PageProviderSpec.Builder	property(String key, Serializable value)	Puts the given key/value pair into this builder's properties.
PageProviderSpec.Builder	quickFilter(QuickFilter quickFilter)	Appends the given quickFilter to this builder's quick filters.
PageProviderSpec.Builder	quickFilters(Collection<QuickFilter> quickFilters)	Sets the given quickFilters to this builder's quick filters.
PageProviderSpec.Builder	quickFiltersByNames(List<String> quickFilterNames)	Resolves and appends the given quickFilterNames to this builder's quick filters by looking them up on the page provider definition.
PageProviderSpec.Builder	searchDocument(DocumentModel searchDocument)
PageProviderSpec.Builder	sortInfo(SortInfo sortInfo)	Appends the given sortInfo to this builder's sort information.
PageProviderSpec.Builder	sortInfos(Collection<SortInfo> sortInfos)	Sets the given sortInfos to this builder's sort information.
PageProviderSpec.Builder	sortInfosByFieldsAndOrders(List<String> sortBy, List<String> sortOrder)	Appends sort information built from parallel sortBy and sortOrder lists.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

protected final String name

definition

protected final PageProviderDefinition definition

properties

protected final Map<String,Serializable> properties

parameters

protected final List<Object> parameters

searchDocument

protected DocumentModel searchDocument

sortInfos

protected Collection<SortInfo> sortInfos

pageSize

protected Long pageSize

currentPage

protected Long currentPage

currentPageOffset

protected Long currentPageOffset

highlights

protected Collection<String> highlights

quickFilters

protected Collection<QuickFilter> quickFilters

Constructor Details

Builder

protected Builder(String name,
 PageProviderDefinition definition)

Method Details

searchDocument

public PageProviderSpec.Builder searchDocument(DocumentModel searchDocument)

sortInfos

public PageProviderSpec.Builder sortInfos(Collection<SortInfo> sortInfos)

Sets the given sortInfos to this builder's sort information.

sortInfo

public PageProviderSpec.Builder sortInfo(SortInfo sortInfo)

Appends the given sortInfo to this builder's sort information.

sortInfosByFieldsAndOrders

public PageProviderSpec.Builder sortInfosByFieldsAndOrders(List<String> sortBy,
 List<String> sortOrder)

Appends sort information built from parallel sortBy and sortOrder lists. Entries in sortBy are field paths; the matching entry in sortOrder is matched case-insensitively against "asc" (any other value, including null or a missing entry, is treated as descending). Blank sortBy entries are skipped.

pageSize

public PageProviderSpec.Builder pageSize(Long pageSize)

currentPage

public PageProviderSpec.Builder currentPage(Long currentPage)

currentPageOffset

public PageProviderSpec.Builder currentPageOffset(Long currentPageOffset)

properties

public PageProviderSpec.Builder properties(Map<String,Serializable> properties)

Puts all the given properties into this builder's properties.

property

public PageProviderSpec.Builder property(String key,
 Serializable value)

Puts the given key/value pair into this builder's properties.

highlights

public PageProviderSpec.Builder highlights(Collection<String> highlights)

Sets the given highlights to this builder's highlights.

highlight

public PageProviderSpec.Builder highlight(String highlight)

Appends the given highlight to this builder's highlights.

quickFilters

public PageProviderSpec.Builder quickFilters(Collection<QuickFilter> quickFilters)

Sets the given quickFilters to this builder's quick filters.

quickFilter

public PageProviderSpec.Builder quickFilter(QuickFilter quickFilter)

Appends the given quickFilter to this builder's quick filters.

quickFiltersByNames

public PageProviderSpec.Builder quickFiltersByNames(List<String> quickFilterNames)

Resolves and appends the given quickFilterNames to this builder's quick filters by looking them up on the page provider definition. Names that don't match any declared quick filter are silently skipped.

The argument may be null, in which case this is a no-op.

Since:

2025.20

parameters

public PageProviderSpec.Builder parameters(Object... parameters)

Appends the given parameters to this builder's parameters.

parameters

public PageProviderSpec.Builder parameters(Collection<?> parameters)

Appends the given parameters to this builder's parameters.

parameter

public PageProviderSpec.Builder parameter(Object parameter)

Appends the given parameter to this builder's parameters.

build

public PageProviderSpec build()