com.yahoo.bard.webservice.data.metric.mappers

Class PaginationMapper

java.lang.Object

com.yahoo.bard.webservice.data.metric.mappers.ResultSetMapper

com.yahoo.bard.webservice.data.metric.mappers.PaginationMapper

public class PaginationMapper
extends ResultSetMapper

Extracts the requested page of data from the Druid results. Behavior is undefined if the page requested is less than 1, or the requested number of results on each page is less than 1.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Result	map(Result result, ResultSetSchema schema) Returns a transformed result row, or null if the row is removed.
ResultSet	map(ResultSet resultSet) Cuts the result set down to just the page requested.
protected ResultSetSchema	map(ResultSetSchema schema) Returns a transformed schema.

Methods inherited from class com.yahoo.bard.webservice.data.metric.mappers.ResultSetMapper

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginationMapper

public PaginationMapper(PaginationParameters paginationParameters,
                        MappingResponseProcessor responseProcessor,
                        javax.ws.rs.core.UriBuilder uriBuilder)

Constructor.

Parameters:

paginationParameters - The parameters needed for pagination

responseProcessor - The API response to which we can add the header links.

uriBuilder - The builder for creating the pagination links.

Method Detail

map

public ResultSet map(ResultSet resultSet)

Cuts the result set down to just the page requested.

Overrides:

map in class ResultSetMapper

Parameters:

resultSet - The result set to be cut down.

Returns:

The page of results desired.

map

protected Result map(Result result,
                     ResultSetSchema schema)

Description copied from class: ResultSetMapper

Returns a transformed result row, or null if the row is removed.

Specified by:

map in class ResultSetMapper

Parameters:

result - The result row being transformed

schema - The schema for that result

Returns:

The result row, a modified copy, or null (if row is eliminated)

map

protected ResultSetSchema map(ResultSetSchema schema)

Description copied from class: ResultSetMapper

Returns a transformed schema.

Specified by:

map in class ResultSetMapper

Parameters:

schema - The schema being mapped

Returns:

The same schema or a new (altered) one