Uses of Class
com.yahoo.bard.webservice.web.util.PaginationParameters

Packages that use PaginationParameters

Package	Description
com.yahoo.bard.webservice.data.dimension
com.yahoo.bard.webservice.data.dimension.impl
com.yahoo.bard.webservice.data.metric.mappers
com.yahoo.bard.webservice.util
com.yahoo.bard.webservice.web.apirequest
com.yahoo.bard.webservice.web.endpoints
com.yahoo.bard.webservice.web.util

Uses of PaginationParameters in com.yahoo.bard.webservice.data.dimension

Methods in com.yahoo.bard.webservice.data.dimension with parameters of type PaginationParameters

Modifier and Type	Method and Description
Pagination<DimensionRow>	SearchProvider.findAllDimensionRowsPaged(PaginationParameters paginationParameters) Return the desired page of dimension rows.
Pagination<DimensionRow>	SearchProvider.findFilteredDimensionRowsPaged(Set<ApiFilter> filters, PaginationParameters paginationParameters) Return the desired page of dimension rows that match the specified filters.

Uses of PaginationParameters in com.yahoo.bard.webservice.data.dimension.impl

Methods in com.yahoo.bard.webservice.data.dimension.impl with parameters of type PaginationParameters

Modifier and Type	Method and Description
Pagination<DimensionRow>	NoOpSearchProvider.findAllDimensionRowsPaged(PaginationParameters paginationParameters)
Pagination<DimensionRow>	LuceneSearchProvider.findAllDimensionRowsPaged(PaginationParameters paginationParameters)
Pagination<DimensionRow>	ScanSearchProvider.findAllDimensionRowsPaged(PaginationParameters paginationParameters)
Pagination<DimensionRow>	NoOpSearchProvider.findFilteredDimensionRowsPaged(Set<ApiFilter> filters, PaginationParameters paginationParameters)
Pagination<DimensionRow>	LuceneSearchProvider.findFilteredDimensionRowsPaged(Set<ApiFilter> filters, PaginationParameters paginationParameters)
Pagination<DimensionRow>	ScanSearchProvider.findFilteredDimensionRowsPaged(Set<ApiFilter> filters, PaginationParameters paginationParameters)

Uses of PaginationParameters in com.yahoo.bard.webservice.data.metric.mappers

Constructors in com.yahoo.bard.webservice.data.metric.mappers with parameters of type PaginationParameters

Constructor and Description
PaginationMapper(PaginationParameters paginationParameters, MappingResponseProcessor responseProcessor, javax.ws.rs.core.UriBuilder uriBuilder) Constructor.

Uses of PaginationParameters in com.yahoo.bard.webservice.util

Constructors in com.yahoo.bard.webservice.util with parameters of type PaginationParameters

Constructor and Description
AllPagesPagination(Collection<T> entireCollection, PaginationParameters paginationParameters) Constructor.
SinglePagePagination(List<T> entirePage, PaginationParameters paginationParameters, int totalMatch) Constructor.

Uses of PaginationParameters in com.yahoo.bard.webservice.web.apirequest

Fields in com.yahoo.bard.webservice.web.apirequest with type parameters of type PaginationParameters

Modifier and Type	Field and Description
protected Optional<PaginationParameters>	ApiRequestImpl.paginationParameters

Methods in com.yahoo.bard.webservice.web.apirequest that return PaginationParameters

Modifier and Type	Method and Description
PaginationParameters	ApiRequest.getDefaultPagination() Get the default pagination parameters for this type of API request.
PaginationParameters	ApiRequestImpl.getDefaultPagination()

Methods in com.yahoo.bard.webservice.web.apirequest that return types with arguments of type PaginationParameters

Modifier and Type	Method and Description
protected Optional<PaginationParameters>	ApiRequestImpl.generatePaginationParameters(String perPage, String page) Builds the paginationParameters object, if the request provides both a perPage and page field.
Optional<PaginationParameters>	ApiRequest.getPaginationParameters() Get the requested pagination parameters.
Optional<PaginationParameters>	ApiRequestImpl.getPaginationParameters()

Methods in com.yahoo.bard.webservice.web.apirequest with parameters of type PaginationParameters

Modifier and Type	Method and Description
<T> Function<Collection<T>,AllPagesPagination<T>>	ApiRequestImpl.getAllPagesPaginationFactory(PaginationParameters paginationParameters) This method returns a Function that can basically take a Collection and return an instance of AllPagesPagination.

Method parameters in com.yahoo.bard.webservice.web.apirequest with type arguments of type PaginationParameters

Modifier and Type	Method and Description
DataApiRequestImpl	DataApiRequest.withPaginationParameters(Optional<PaginationParameters> paginationParameters)
TablesApiRequest	TablesApiRequest.withPaginationParameters(Optional<PaginationParameters> paginationParameters)
DataApiRequestImpl	DataApiRequestImpl.withPaginationParameters(Optional<PaginationParameters> paginationParameters)
DimensionsApiRequest	DimensionsApiRequestImpl.withPaginationParameters(Optional<PaginationParameters> paginationParameters)
TablesApiRequest	TablesApiRequestImpl.withPaginationParameters(Optional<PaginationParameters> paginationParameters)
DimensionsApiRequest	DimensionsApiRequest.withPaginationParameters(Optional<PaginationParameters> paginationParameters)

Constructor parameters in com.yahoo.bard.webservice.web.apirequest with type arguments of type PaginationParameters

Constructor and Description
ApiRequestImpl(ResponseFormatType format, long asyncAfter, Optional<PaginationParameters> paginationParameters, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Response.ResponseBuilder builder) All argument constructor, meant to be used for rewriting apiRequest.
DataApiRequestImpl(ResponseFormatType format, Optional<PaginationParameters> paginationParameters, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Response.ResponseBuilder builder, LogicalTable table, Granularity granularity, Set<Dimension> dimensions, LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> perDimensionFields, Set<LogicalMetric> logicalMetrics, Set<org.joda.time.Interval> intervals, ApiFilters apiFilters, Map<LogicalMetric,Set<ApiHaving>> havings, Having having, LinkedHashSet<OrderByColumn> sorts, int count, int topN, long asyncAfter, org.joda.time.DateTimeZone timeZone, DruidFilterBuilder filterBuilder, HavingGenerator havingApiGenerator, Optional<OrderByColumn> dateTimeSort) All argument constructor, meant to be used for rewriting apiRequest.

Uses of PaginationParameters in com.yahoo.bard.webservice.web.endpoints

Method parameters in com.yahoo.bard.webservice.web.endpoints with type arguments of type PaginationParameters

Modifier and Type	Method and Description
protected rx.Observable<PreResponse>	JobsServlet.handlePreResponseWithError(PreResponse preResponse, javax.ws.rs.core.UriInfo uriInfo, Optional<PaginationParameters> paginationParameters) Check whether the PreResponse contains an error and if it does, return an Observable wrapping the error else return an Observable wrapping the PreResponse as is.

Uses of PaginationParameters in com.yahoo.bard.webservice.web.util

Fields in com.yahoo.bard.webservice.web.util declared as PaginationParameters

Modifier and Type	Field and Description
static PaginationParameters	PaginationParameters.EVERYTHING_IN_ONE_PAGE The common pagination parameter object used by non-paginating method in search providers.
static PaginationParameters	PaginationParameters.ONE_RESULT Return only the first result.

Methods in com.yahoo.bard.webservice.web.util that return PaginationParameters

Modifier and Type	Method and Description
PaginationParameters	PaginationParameters.withPage(String page) Returns a new PaginationParameters object with the specified page value.
PaginationParameters	PaginationParameters.withPerPage(String perPage) Returns a new PaginationParameters object with the specified perPage value.