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

Class PageProviderDefinitionBuilder.PageProviderDefinitionImpl

java.lang.Object

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

All Implemented Interfaces:

PageProviderDefinition, Descriptor

Enclosing class:

PageProviderDefinitionBuilder

protected static class PageProviderDefinitionBuilder.PageProviderDefinitionImpl
extends Object
implements PageProviderDefinition

Field Summary

Fields

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

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
PageProviderDefinitionImpl(PageProviderDefinitionBuilder builder)

Method Summary

Modifier and Type	Method	Description
PageProviderDefinition	clone()
List<AggregateDefinition>	getAggregates()
boolean	getEscapePatternParameters()
Long	getMaxPageSize()
String	getName()
long	getPageSize()
String	getPageSizeBinding()
List<Long>	getPageSizeOptions()	Returns the list of page size options to present to users.
String	getPattern()
Map<String,String>	getProperties()
String[]	getQueryParameters()
List<QuickFilter>	getQuickFilters()
boolean	getQuotePatternParameters()
String	getSearchDocumentType()	Returns the search document type used for wher clause, aggregates and named parameters.
List<SortInfo>	getSortInfos()
String	getSortInfosBinding()
WhereClauseDefinition	getWhereClause()
boolean	isEnabled()
boolean	isSortable()
boolean	isUsageTrackingEnabled()
void	setEnabled(boolean enabled)
void	setName(String name)
void	setPattern(String pattern)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

copy, doesRemove, getCopyId, merge

Methods inherited from interface org.nuxeo.ecm.platform.query.api.PageProviderDefinition

builder, getId

Field Details

name

protected final String name

enabled

protected final boolean enabled

properties

protected final Map<String,String> properties

queryParameters

protected final String[] queryParameters

quotePatternParameters

protected final boolean quotePatternParameters

escapePatternParameters

protected final boolean escapePatternParameters

pattern

protected final String pattern

whereClause

protected final WhereClauseDefinition whereClause

searchDocumentType

protected final String searchDocumentType

sortable

protected final boolean sortable

sortInfos

protected final List<SortInfo> sortInfos

sortInfosBinding

protected final String sortInfosBinding

pageSize

protected final long pageSize

pageSizeBinding

protected final String pageSizeBinding

maxPageSize

protected final Long maxPageSize

pageSizeOptions

protected final List<Long> pageSizeOptions

aggregates

protected final List<AggregateDefinition> aggregates

usageTrackingEnabled

protected final boolean usageTrackingEnabled

quickFilters

protected final List<QuickFilter> quickFilters

Constructor Details

PageProviderDefinitionImpl

public PageProviderDefinitionImpl(PageProviderDefinitionBuilder builder)

Method Details

getName

public String getName()

Specified by:

getName in interface PageProviderDefinition

setName

public void setName(String name)

Specified by:

setName in interface PageProviderDefinition

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface PageProviderDefinition

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface PageProviderDefinition

getProperties

public Map<String,String> getProperties()

Specified by:

getProperties in interface PageProviderDefinition

getQueryParameters

public String[] getQueryParameters()

Specified by:

getQueryParameters in interface PageProviderDefinition

getQuotePatternParameters

public boolean getQuotePatternParameters()

Specified by:

getQuotePatternParameters in interface PageProviderDefinition

getEscapePatternParameters

public boolean getEscapePatternParameters()

Specified by:

getEscapePatternParameters in interface PageProviderDefinition

setPattern

public void setPattern(String pattern)

Specified by:

setPattern in interface PageProviderDefinition

getPattern

public String getPattern()

Specified by:

getPattern in interface PageProviderDefinition

getWhereClause

public WhereClauseDefinition getWhereClause()

Specified by:

getWhereClause in interface PageProviderDefinition

getSearchDocumentType

public String getSearchDocumentType()

Description copied from interface: PageProviderDefinition

Returns the search document type used for wher clause, aggregates and named parameters.

Specified by:

getSearchDocumentType in interface PageProviderDefinition

isSortable

public boolean isSortable()

Specified by:

isSortable in interface PageProviderDefinition

getSortInfos

public List<SortInfo> getSortInfos()

Specified by:

getSortInfos in interface PageProviderDefinition

getSortInfosBinding

public String getSortInfosBinding()

Specified by:

getSortInfosBinding in interface PageProviderDefinition

getPageSize

public long getPageSize()

Specified by:

getPageSize in interface PageProviderDefinition

getPageSizeBinding

public String getPageSizeBinding()

Specified by:

getPageSizeBinding in interface PageProviderDefinition

getMaxPageSize

public Long getMaxPageSize()

Specified by:

getMaxPageSize in interface PageProviderDefinition

getPageSizeOptions

public List<Long> getPageSizeOptions()

Description copied from interface: PageProviderDefinition

Returns the list of page size options to present to users.

Uses an hardcoded list of values, and adds up the page provider initial page size to it.

Specified by:

getPageSizeOptions in interface PageProviderDefinition

clone

public PageProviderDefinition clone()

Specified by:

clone in interface PageProviderDefinition

Overrides:

clone in class Object

getAggregates

public List<AggregateDefinition> getAggregates()

Specified by:

getAggregates in interface PageProviderDefinition

isUsageTrackingEnabled

public boolean isUsageTrackingEnabled()

Specified by:

isUsageTrackingEnabled in interface PageProviderDefinition

getQuickFilters

public List<QuickFilter> getQuickFilters()

Specified by:

getQuickFilters in interface PageProviderDefinition