org.apache.olingo.server.tecsvc.processor.queryoptions.options

Class ServerSidePagingHandler

java.lang.Object

org.apache.olingo.server.tecsvc.processor.queryoptions.options.ServerSidePagingHandler

public class ServerSidePagingHandler
extends Object

Constructor Summary

Constructors

Constructor and Description
ServerSidePagingHandler()

Method Summary

Methods

Modifier and Type	Method and Description
static Integer	applyServerSidePaging(SkipTokenOption skipTokenOption, EntityCollection entityCollection, EdmEntitySet edmEntitySet, String rawRequestUri, Integer preferredPageSize) Applies server-side paging to the given entity collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerSidePagingHandler

public ServerSidePagingHandler()

Method Detail

applyServerSidePaging

public static Integer applyServerSidePaging(SkipTokenOption skipTokenOption,
                            EntityCollection entityCollection,
                            EdmEntitySet edmEntitySet,
                            String rawRequestUri,
                            Integer preferredPageSize)
                                     throws ODataApplicationException

Applies server-side paging to the given entity collection.

The next link is constructed and set in the data. It must support client-specified page sizes. Therefore, the format page*pageSize (with a literal asterisk) has been chosen for the skiptoken.

Parameters:

skipTokenOption - the current skiptoken option (from a previous response's next link)

entityCollection - the data

edmEntitySet - the EDM entity set to decide whether paging must be done

rawRequestUri - the request URI (used to construct the next link)

preferredPageSize - the client's preference for page size

Returns:

the chosen page size (or null if no paging has been done); could be used in the Preference-Applied HTTP header

Throws:

ODataApplicationException