com.yahoo.bard.webservice.web.apirequest

Interface DataApiRequest

All Superinterfaces:

ApiRequest

All Known Implementing Classes:

DataApiRequestImpl

public interface DataApiRequest
extends ApiRequest

DataApiRequest Request binds, validates, and models the parts of a request to the data endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_TIME_STRING
static String	RATIO_METRIC_CATEGORY
static String	REQUEST_MAPPER_NAMESPACE

Fields inherited from interface com.yahoo.bard.webservice.web.apirequest.ApiRequest

ASYNCHRONOUS_ASYNC_AFTER_VALUE, SYNCHRONOUS_ASYNC_AFTER_VALUE

Method Summary

Modifier and Type	Method and Description
Map<Dimension,Set<ApiFilter>>	generateFilters(String filterQuery, LogicalTable table, DimensionDictionary dimensionDictionary) Generates filter objects on the based on the filter query in the api request.
ApiFilters	getApiFilters() The filters for this ApiRequest, grouped by dimensions.
OptionalInt	getCount() An optional limit of records returned.
Optional<OrderByColumn>	getDateTimeSort() An optional sorting predicate for the time column.
LinkedHashMap<Dimension,LinkedHashSet<DimensionField>>	getDimensionFields() A map of dimension fields specified for the output schema.
Set<Dimension>	getDimensions() The set of grouping dimensions on this ApiRequest.
Filter	getDruidFilter() Builds and returns the Druid filters from this request's ApiFilters.
DruidFilterBuilder	getFilterBuilder() A filter builder (remove).
Set<Dimension>	getFilterDimensions() Get the dimensions used in filters on this request.
Granularity	getGranularity() The grain to group the results of this request.
Having	getHaving() The fact model having (should probably remove this).
Map<LogicalMetric,Set<ApiHaving>>	getHavings() The having constraints for this request, grouped by logical metrics.
Set<org.joda.time.Interval>	getIntervals() The intervals for this query.
Set<LogicalMetric>	getLogicalMetrics() The logical metrics requested in this query.
LinkedHashSet<OrderByColumn>	getSorts() A prioritized list of sort columns.
LogicalTable	getTable() The logical table for this request.
org.joda.time.DateTimeZone	getTimeZone() The date time zone to apply to the dateTime parameter and to express the response and granularity in.
OptionalInt	getTopN() The limit per time bucket for a top n query.
DataApiRequestImpl	withAsyncAfter(long asyncAfter)
DataApiRequestImpl	withBuilder(javax.ws.rs.core.Response.ResponseBuilder builder)
DataApiRequestImpl	withCount(int count)
DataApiRequestImpl	withDimensions(Set<Dimension> dimensions)
DataApiRequestImpl	withFilterBuilder(DruidFilterBuilder filterBuilder)
DataApiRequestImpl	withFilters(ApiFilters filters)
DataApiRequestImpl	withFormat(ResponseFormatType format)
DataApiRequestImpl	withGranularity(Granularity granularity)
DataApiRequestImpl	withHaving(Having having)
DataApiRequestImpl	withHavings(Map<LogicalMetric,Set<ApiHaving>> havings)
DataApiRequestImpl	withIntervals(Set<org.joda.time.Interval> intervals)
DataApiRequestImpl	withLogicalMetrics(Set<LogicalMetric> logicalMetrics)
DataApiRequestImpl	withPaginationParameters(Optional<PaginationParameters> paginationParameters)
DataApiRequestImpl	withPerDimensionFields(LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> perDimensionFields)
DataApiRequestImpl	withSorts(LinkedHashSet<OrderByColumn> sorts)
DataApiRequestImpl	withTable(LogicalTable table)
DataApiRequestImpl	withTimeZone(org.joda.time.DateTimeZone timeZone)
DataApiRequestImpl	withTopN(int topN)
DataApiRequestImpl	withUriInfo(javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from interface com.yahoo.bard.webservice.web.apirequest.ApiRequest

generateDateTimeFormatter, getAsyncAfter, getBuilder, getDefaultPagination, getFormat, getPage, getPage, getPagination, getPaginationParameters, getUriInfo

Field Detail

REQUEST_MAPPER_NAMESPACE

static final String REQUEST_MAPPER_NAMESPACE

See Also:

Constant Field Values

RATIO_METRIC_CATEGORY

static final String RATIO_METRIC_CATEGORY

See Also:

Constant Field Values

DATE_TIME_STRING

static final String DATE_TIME_STRING

See Also:

Constant Field Values

Method Detail

getDruidFilter

Filter getDruidFilter()

Builds and returns the Druid filters from this request's ApiFilters.

The Druid filters are built (an expensive operation) every time this method is called. Use it judiciously.

Returns:

the Druid filter

getHavings

Map<LogicalMetric,Set<ApiHaving>> getHavings()

The having constraints for this request, grouped by logical metrics.

Returns:

a map of havings by metrics.

getHaving

Having getHaving()

The fact model having (should probably remove this).

Returns:

A fact model having

getSorts

LinkedHashSet<OrderByColumn> getSorts()

A prioritized list of sort columns.

Returns:

sort columns.

getCount

OptionalInt getCount()

An optional limit of records returned.

Returns:

An optional integer.

getTopN

OptionalInt getTopN()

The limit per time bucket for a top n query.

Returns:

The number of values per bucket.

getTimeZone

org.joda.time.DateTimeZone getTimeZone()

The date time zone to apply to the dateTime parameter and to express the response and granularity in.

Returns:

A time zone

getFilterBuilder

DruidFilterBuilder getFilterBuilder()

A filter builder (remove).

Returns:

a filter builder.

getDateTimeSort

Optional<OrderByColumn> getDateTimeSort()

An optional sorting predicate for the time column.

Returns:

The sort direction

getFilterDimensions

Set<Dimension> getFilterDimensions()

Get the dimensions used in filters on this request.

Returns:

A set of dimensions

getTable

LogicalTable getTable()

The logical table for this request.

Returns:

A logical table

getGranularity

Granularity getGranularity()

The grain to group the results of this request.

Returns:

a granularity

getDimensions

Set<Dimension> getDimensions()

The set of grouping dimensions on this ApiRequest.

Returns:

a set of dimensions

getDimensionFields

LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> getDimensionFields()

A map of dimension fields specified for the output schema.

Returns:

The dimension fields for output grouped by their dimension

getLogicalMetrics

Set<LogicalMetric> getLogicalMetrics()

The logical metrics requested in this query.

Returns:

A set of logical metrics

getIntervals

Set<org.joda.time.Interval> getIntervals()

The intervals for this query.

Returns:

A set of intervals

getApiFilters

ApiFilters getApiFilters()

The filters for this ApiRequest, grouped by dimensions.

Returns:

a map of filters by dimension

generateFilters

Map<Dimension,Set<ApiFilter>> generateFilters(String filterQuery,
                                              LogicalTable table,
                                              DimensionDictionary dimensionDictionary)

Generates filter objects on the based on the filter query in the api request.

Parameters:

filterQuery - Expects a URL filter query String in the format: (dimension name).(fieldname)-(operation):[?(value or comma separated values)]?

table - The logical table for the data request

dimensionDictionary - DimensionDictionary

Returns:

Set of filter objects.

withFormat

DataApiRequestImpl withFormat(ResponseFormatType format)

withPaginationParameters

DataApiRequestImpl withPaginationParameters(Optional<PaginationParameters> paginationParameters)

withUriInfo

DataApiRequestImpl withUriInfo(javax.ws.rs.core.UriInfo uriInfo)

withBuilder

DataApiRequestImpl withBuilder(javax.ws.rs.core.Response.ResponseBuilder builder)

withTable

DataApiRequestImpl withTable(LogicalTable table)

withGranularity

DataApiRequestImpl withGranularity(Granularity granularity)

withDimensions

DataApiRequestImpl withDimensions(Set<Dimension> dimensions)

withPerDimensionFields

DataApiRequestImpl withPerDimensionFields(LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> perDimensionFields)

withLogicalMetrics

DataApiRequestImpl withLogicalMetrics(Set<LogicalMetric> logicalMetrics)

withIntervals

DataApiRequestImpl withIntervals(Set<org.joda.time.Interval> intervals)

withFilters

DataApiRequestImpl withFilters(ApiFilters filters)

withHavings

DataApiRequestImpl withHavings(Map<LogicalMetric,Set<ApiHaving>> havings)

withHaving

DataApiRequestImpl withHaving(Having having)

withSorts

DataApiRequestImpl withSorts(LinkedHashSet<OrderByColumn> sorts)

withCount

DataApiRequestImpl withCount(int count)

withTopN

DataApiRequestImpl withTopN(int topN)

withAsyncAfter

DataApiRequestImpl withAsyncAfter(long asyncAfter)

withTimeZone

DataApiRequestImpl withTimeZone(org.joda.time.DateTimeZone timeZone)

withFilterBuilder

DataApiRequestImpl withFilterBuilder(DruidFilterBuilder filterBuilder)