org.nuxeo.ecm.restapi.server.jaxrs.adapters

Class PaginableAdapter<T>

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<org.nuxeo.ecm.webengine.model.impl.ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultAdapter

org.nuxeo.ecm.restapi.server.jaxrs.adapters.PaginableAdapter<T>

All Implemented Interfaces:

org.nuxeo.ecm.webengine.model.AdapterResource, org.nuxeo.ecm.webengine.model.Resource, Adaptable

Direct Known Subclasses:

AuditAdapter, DocumentModelListPaginableAdapter

public abstract class PaginableAdapter<T>
extends org.nuxeo.ecm.webengine.model.impl.DefaultAdapter

Abstract adapter to be used when one want to contribute an adapter base on PageProviders.

In order to use it, just override the getPageProviderDefinition() and getParams()

Since:

5.7.2

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	currentPageIndex
protected String	maxResults
protected Long	pageSize
protected String	sortBy Sort by parameters (can be a list of sorts, separated by commas).
protected String	sortOrder Sort order parameters (can be a list of sorts orders, separated by commas, matched by index to corresponding sort by parameters).

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor and Description
PaginableAdapter()

Method Summary

Modifier and Type	Method and Description
protected Long	extractLongParam(javax.servlet.http.HttpServletRequest request, String paramName, Long defaultValue)
<A> A	getAdapter(Class<A> adapter)
protected abstract org.nuxeo.ecm.platform.query.api.PageProviderDefinition	getPageProviderDefinition()
org.nuxeo.ecm.automation.core.util.Paginable<T>	getPaginableEntries()
protected org.nuxeo.ecm.automation.core.util.Paginable<T>	getPaginableEntries(org.nuxeo.ecm.platform.query.api.PageProvider<T> pageProvider)
protected Object[]	getParams()
protected org.nuxeo.ecm.core.api.DocumentModel	getSearchDocument()
protected void	initialize(Object... args)

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultAdapter

disptachAdapter, getTarget, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.webengine.model.Resource

checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot

Field Detail

currentPageIndex

protected Long currentPageIndex

pageSize

protected Long pageSize

maxResults

protected String maxResults

sortBy

protected String sortBy

Sort by parameters (can be a list of sorts, separated by commas).

Exp: dc:title,dc:modified.

Since:

5.9.4

sortOrder

protected String sortOrder

Sort order parameters (can be a list of sorts orders, separated by commas, matched by index to corresponding sort by parameters).

Exp: asc,desc, or ASC,DESC. When empty, defaults to 'desc'.

Since:

5.9.4

Constructor Detail

PaginableAdapter

public PaginableAdapter()

Method Detail

initialize

protected void initialize(Object... args)

Overrides:

initialize in class org.nuxeo.ecm.webengine.model.impl.AbstractResource<org.nuxeo.ecm.webengine.model.impl.ResourceTypeImpl>

getAdapter

public <A> A getAdapter(Class<A> adapter)

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class org.nuxeo.ecm.webengine.model.impl.AbstractResource<org.nuxeo.ecm.webengine.model.impl.ResourceTypeImpl>

getPageProviderDefinition

protected abstract org.nuxeo.ecm.platform.query.api.PageProviderDefinition getPageProviderDefinition()

getParams

protected Object[] getParams()

getSearchDocument

protected org.nuxeo.ecm.core.api.DocumentModel getSearchDocument()
                                                          throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getPaginableEntries

public org.nuxeo.ecm.automation.core.util.Paginable<T> getPaginableEntries()
                                                                    throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getPaginableEntries

protected org.nuxeo.ecm.automation.core.util.Paginable<T> getPaginableEntries(org.nuxeo.ecm.platform.query.api.PageProvider<T> pageProvider)

extractLongParam

protected Long extractLongParam(javax.servlet.http.HttpServletRequest request,
                                String paramName,
                                Long defaultValue)