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

Class PageProviderDefinitionBuilder

java.lang.Object

org.nuxeo.ecm.platform.query.api.PageProviderDefinitionBuilder

public class PageProviderDefinitionBuilder
extends Object

Since:

2025.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PageProviderDefinitionBuilder.PageProviderDefinitionImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AggregateDefinition>	aggregates
protected boolean	enabled
protected boolean	escapePatternParameters
protected Long	maxPageSize
protected String	name
protected long	pageSize
protected String	pageSizeBinding
protected List<Long>	pageSizeOptions
protected String	pattern
protected Map<String,String>	properties
protected String[]	queryParameters
protected List<QuickFilter>	quickFilters
protected boolean	quotePatternParameters
protected String	searchDocumentType
protected boolean	sortable
protected List<SortInfo>	sortInfos
protected String	sortInfosBinding
protected boolean	usageTrackingEnabled
protected WhereClauseDefinition	whereClause

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PageProviderDefinitionBuilder(PageProviderDefinition pageProviderDefinition)

Method Summary

Modifier and Type	Method	Description
PageProviderDefinition	build()
PageProviderDefinitionBuilder	quickFilters(List<QuickFilter> quickFilters)
PageProviderDefinitionBuilder	sortInfos(List<SortInfo> sortInfos)
PageProviderDefinitionBuilder	whereClause(UnaryOperator<WhereClauseDefinition> whereClauseOperator)	Method that allows to edit the current WhereClauseDefinition whereClause by calling the given operator.
PageProviderDefinitionBuilder	whereClause(WhereClauseDefinition whereClause)

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

enabled

protected boolean enabled

properties

protected Map<String,String> properties

queryParameters

protected String[] queryParameters

quotePatternParameters

protected boolean quotePatternParameters

escapePatternParameters

protected boolean escapePatternParameters

pattern

protected String pattern

whereClause

protected WhereClauseDefinition whereClause

searchDocumentType

protected String searchDocumentType

sortable

protected boolean sortable

sortInfos

protected List<SortInfo> sortInfos

sortInfosBinding

protected String sortInfosBinding

pageSize

protected long pageSize

pageSizeBinding

protected String pageSizeBinding

maxPageSize

protected Long maxPageSize

pageSizeOptions

protected List<Long> pageSizeOptions

aggregates

protected List<AggregateDefinition> aggregates

usageTrackingEnabled

protected boolean usageTrackingEnabled

quickFilters

protected List<QuickFilter> quickFilters

Constructor Details

PageProviderDefinitionBuilder

protected PageProviderDefinitionBuilder(PageProviderDefinition pageProviderDefinition)

Method Details

whereClause

public PageProviderDefinitionBuilder whereClause(WhereClauseDefinition whereClause)

whereClause

public PageProviderDefinitionBuilder whereClause(UnaryOperator<WhereClauseDefinition> whereClauseOperator)

Method that allows to edit the current WhereClauseDefinition whereClause by calling the given operator.

The operator will receive the current whereClause and its returned value will be set to this builder.

Returns:

this builder

sortInfos

public PageProviderDefinitionBuilder sortInfos(List<SortInfo> sortInfos)

quickFilters

public PageProviderDefinitionBuilder quickFilters(List<QuickFilter> quickFilters)

build

public PageProviderDefinition build()