com.yahoo.bard.webservice.web.apirequest

Class DataApiRequestImpl

java.lang.Object

com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

com.yahoo.bard.webservice.web.apirequest.DataApiRequestImpl

All Implemented Interfaces:

ApiRequest, DataApiRequest

public class DataApiRequestImpl
extends ApiRequestImpl
implements DataApiRequest

Data API Request Implementation binds, validates, and models the parts of a request to the data endpoint.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

asyncAfter, builder, COMMA_AFTER_BRACKET_PATTERN, format, pagination, paginationParameters, uriInfo

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

DATE_TIME_STRING, RATIO_METRIC_CATEGORY, REQUEST_MAPPER_NAMESPACE

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

ASYNCHRONOUS_ASYNC_AFTER_VALUE, SYNCHRONOUS_ASYNC_AFTER_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	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.
	DataApiRequestImpl(String tableName, String granularity, List<javax.ws.rs.core.PathSegment> dimensions, String logicalMetrics, String intervals, String apiFilters, String havings, String sorts, String count, String topN, String format, String timeZoneId, String asyncAfter, String perPage, String page, javax.ws.rs.core.UriInfo uriInfo, BardConfigResources bardConfigResources) Parses the API request URL and generates the Api Request object.
	DataApiRequestImpl(String tableName, String granularity, List<javax.ws.rs.core.PathSegment> dimensions, String logicalMetrics, String intervals, String apiFilters, String havings, String sorts, String count, String topN, String format, String timeZoneId, String asyncAfter, String perPage, String page, javax.ws.rs.core.UriInfo uriInfo, DimensionDictionary dimensionDictionary, MetricDictionary metricDictionary, LogicalTableDictionary logicalTableDictionary, org.joda.time.DateTimeZone systemTimeZone, GranularityParser granularityParser, DruidFilterBuilder druidFilterBuilder, HavingGenerator havingGenerator) Parses the API request URL and generates the Api Request object.

Method Summary

Modifier and Type	Method and Description
protected Optional<OrderByColumn>	generateDateTimeSortColumn(LinkedHashMap<String,SortDirection> sortColumns) Method to generate DateTime sort column from the map of columns and its direction.
protected LinkedHashMap<Dimension,LinkedHashSet<DimensionField>>	generateDimensionFields(List<javax.ws.rs.core.PathSegment> apiDimensionPathSegments, DimensionDictionary dimensionDictionary) Extracts the list of dimensions from the url dimension path segments and "show" matrix params and generates a map of dimension to dimension fields which needs to be annotated on the response.
protected int	generateInteger(String value, String parameterName) Parses the requested input String by converting it to an integer, while treating null as zero.
protected LinkedHashSet<LogicalMetric>	generateLogicalMetrics(String apiMetricQuery, MetricDictionary metricDictionary, DimensionDictionary dimensionDictionary, LogicalTable table) Extracts the list of metrics from the url metric query string and generates a set of LogicalMetrics.
protected LinkedHashSet<OrderByColumn>	generateSortColumns(Map<String,SortDirection> sortDirectionMap, Set<LogicalMetric> logicalMetrics, MetricDictionary metricDictionary) Generates a Set of OrderByColumn.
protected LinkedHashMap<String,SortDirection>	generateSortColumns(String sorts) Method to convert sort list to column and direction map.
ApiFilters	getApiFilters() The filters for this ApiRequest, grouped by dimensions.
OptionalInt	getCount() An optional limit of records returned.
protected org.joda.time.DateTime	getCurrentDate(org.joda.time.DateTime dateTime, TimeGrain timeGrain) Generate current date based on granularity.
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() Gets the filter dimensions form the given set of filter objects.
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.
protected SortDirection	getSortDirection(List<String> columnWithDirection) Extract valid sort direction.
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.
protected Boolean	isDateTimeFirstSortField(LinkedHashMap<String,SortDirection> sortColumns) To check whether dateTime column request is first one in the sort list or not.
static Predicate<ApiFilter>	isNonAggregatableInFilter() Validity rules for non-aggregatable dimensions that are only referenced in filters.
protected Map<String,SortDirection>	removeDateTimeSortColumn(Map<String,SortDirection> sortColumns) Method to remove the dateTime column from map of columns and its direction.
protected void	validateAggregatability(Set<Dimension> apiDimensions, Map<Dimension,Set<ApiFilter>> apiFilters) Validate that the request references any non-aggregatable dimensions in a valid way.
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 apiFilters)
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 class com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

addPageLink, addPageLink, generateAcceptFormat, generateAsyncAfter, generateDimensions, generateFilters, generateGranularity, generateGranularity, generateIntervals, generateIntervals, generateLogicalMetrics, generateMetricName, generatePaginationParameters, generateTable, generateTimeZone, getAllPagesPaginationFactory, getAsDateTime, getAsyncAfter, getBuilder, getDefaultPagination, getFormat, getPage, getPage, getPagination, getPaginationParameters, getUriInfo, validateMetrics, validateRequestDimensions, validateTimeAlignment

Methods inherited from class java.lang.Object

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

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

generateFilters

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

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

Constructor Detail

DataApiRequestImpl

public DataApiRequestImpl(String tableName,
                          String granularity,
                          List<javax.ws.rs.core.PathSegment> dimensions,
                          String logicalMetrics,
                          String intervals,
                          String apiFilters,
                          String havings,
                          String sorts,
                          String count,
                          String topN,
                          String format,
                          String timeZoneId,
                          String asyncAfter,
                          @NotNull
                          String perPage,
                          @NotNull
                          String page,
                          javax.ws.rs.core.UriInfo uriInfo,
                          BardConfigResources bardConfigResources)
                   throws BadApiRequestException

Parses the API request URL and generates the Api Request object.

Parameters:

tableName - logical table corresponding to the table name specified in the URL

granularity - string time granularity in URL

dimensions - single dimension or multiple dimensions separated by '/' in URL

logicalMetrics - URL logical metric query string in the format:

 single metric or multiple logical metrics separated by ',' 

intervals - URL intervals query string in the format:

 single interval in ISO 8601 format, multiple values separated by ',' 

apiFilters - URL filter query String in the format:

 ((field name and operation):((multiple values bounded by [])or(single value))))(followed by , or end of string)
 

havings - URL having query String in the format:

 
 ((metric name)-(operation)((values bounded by [])))(followed by , or end of string)
 

sorts - string of sort columns along with sort direction in the format:

  (metricName or dimensionName)|(sortDirection) eg: pageViews|asc 

count - count of number of records to be returned in the response

topN - number of first records per time bucket to be returned in the response

format - response data format JSON or CSV. Default is JSON.

timeZoneId - a joda time zone id

asyncAfter - How long the user is willing to wait for a synchronous request in milliseconds

perPage - number of rows to display per page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

page - desired page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

uriInfo - The URI of the request object.

bardConfigResources - The configuration resources used to build this api request

Throws:

BadApiRequestException - in the following scenarios:

1. Null or empty table name in the API request.
2. Invalid time grain in the API request.
3. Invalid dimension in the API request.
4. Invalid logical metric in the API request.
5. Invalid interval in the API request.
6. Invalid filter syntax in the API request.
7. Invalid filter dimensions in the API request.
8. Invalid having syntax in the API request.
9. Invalid having metrics in the API request.
10. Pagination parameters in the API request that are not positive integers.

DataApiRequestImpl

public DataApiRequestImpl(String tableName,
                          String granularity,
                          List<javax.ws.rs.core.PathSegment> dimensions,
                          String logicalMetrics,
                          String intervals,
                          String apiFilters,
                          String havings,
                          String sorts,
                          String count,
                          String topN,
                          String format,
                          String timeZoneId,
                          String asyncAfter,
                          @NotNull
                          String perPage,
                          @NotNull
                          String page,
                          javax.ws.rs.core.UriInfo uriInfo,
                          DimensionDictionary dimensionDictionary,
                          MetricDictionary metricDictionary,
                          LogicalTableDictionary logicalTableDictionary,
                          org.joda.time.DateTimeZone systemTimeZone,
                          GranularityParser granularityParser,
                          DruidFilterBuilder druidFilterBuilder,
                          HavingGenerator havingGenerator)
                   throws BadApiRequestException

Parses the API request URL and generates the Api Request object.

Parameters:

tableName - logical table corresponding to the table name specified in the URL

granularity - string time granularity in URL

dimensions - single dimension or multiple dimensions separated by '/' in URL

logicalMetrics - URL logical metric query string in the format:

 single metric or multiple logical metrics separated by ',' 

intervals - URL intervals query string in the format:

 single interval in ISO 8601 format, multiple values separated by ',' 

apiFilters - URL filter query String in the format:

 ((field name and operation):((multiple values bounded by [])or(single value))))(followed by , or end of string)
 

havings - URL having query String in the format:

 
 ((metric name)-(operation)((values bounded by [])))(followed by , or end of string)
 

sorts - string of sort columns along with sort direction in the format:

  (metricName or dimensionName)|(sortDirection) eg: pageViews|asc 

count - count of number of records to be returned in the response

topN - number of first records per time bucket to be returned in the response

format - response data format JSON or CSV. Default is JSON.

timeZoneId - a joda time zone id

asyncAfter - How long the user is willing to wait for a synchronous request in milliseconds

perPage - number of rows to display per page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

page - desired page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

uriInfo - The URI of the request object.

dimensionDictionary - The dimension dictionary for binding dimensions

metricDictionary - The metric dictionary for binding metrics

logicalTableDictionary - The table dictionary for binding logical tables

systemTimeZone - The default time zone for the system

granularityParser - A tool to process granularities

druidFilterBuilder - A function to build druid filters from Api Filters

havingGenerator - A function to create havings

Throws:

BadApiRequestException - in the following scenarios:

1. Null or empty table name in the API request.
2. Invalid time grain in the API request.
3. Invalid dimension in the API request.
4. Invalid logical metric in the API request.
5. Invalid interval in the API request.
6. Invalid filter syntax in the API request.
7. Invalid filter dimensions in the API request.
8. Invalid having syntax in the API request.
9. Invalid having metrics in the API request.
10. Pagination parameters in the API request that are not positive integers.

DataApiRequestImpl

protected 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.

Parameters:

format - Format for the response

paginationParameters - Pagination info

uriInfo - The URI info

builder - A response builder

table - Logical table requested

granularity - Granularity of the request

dimensions - Grouping dimensions of the request

perDimensionFields - Fields for each of the grouped dimensions

logicalMetrics - Metrics requested

intervals - Intervals requested

apiFilters - Global filters

havings - Top-level Having caluses for the request

having - Single global Druid Having

sorts - Sorting info for the request

count - Global limit for the request

topN - Count of per-bucket limit (TopN) for the request

asyncAfter - How long in milliseconds the user is willing to wait for a synchronous response

timeZone - TimeZone for the request

filterBuilder - A builder to use when building filters for the request

havingApiGenerator - A generator to generate havings map for the request

dateTimeSort - A dateTime sort column with its direction

Method Detail

isDateTimeFirstSortField

protected Boolean isDateTimeFirstSortField(LinkedHashMap<String,SortDirection> sortColumns)

To check whether dateTime column request is first one in the sort list or not.

Parameters:

sortColumns - LinkedHashMap of columns and its direction. Using LinkedHashMap to preserve the order

Returns:

True if dateTime column is first one in the sort list. False otherwise

removeDateTimeSortColumn

protected Map<String,SortDirection> removeDateTimeSortColumn(Map<String,SortDirection> sortColumns)

Method to remove the dateTime column from map of columns and its direction.

Parameters:

sortColumns - map of columns and its direction

Returns:

Map of columns and its direction without dateTime sort column

generateDateTimeSortColumn

protected Optional<OrderByColumn> generateDateTimeSortColumn(LinkedHashMap<String,SortDirection> sortColumns)

Method to generate DateTime sort column from the map of columns and its direction.

Parameters:

sortColumns - LinkedHashMap of columns and its direction. Using LinkedHashMap to preserve the order

Returns:

Instance of OrderByColumn for dateTime

generateSortColumns

protected LinkedHashMap<String,SortDirection> generateSortColumns(String sorts)

Method to convert sort list to column and direction map.

Parameters:

sorts - String of sort columns

Returns:

LinkedHashMap of columns and their direction. Using LinkedHashMap to preserve the order

generateDimensionFields

protected LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> generateDimensionFields(@NotNull
                                                                                         List<javax.ws.rs.core.PathSegment> apiDimensionPathSegments,
                                                                                         @NotNull
                                                                                         DimensionDictionary dimensionDictionary)

Extracts the list of dimensions from the url dimension path segments and "show" matrix params and generates a map of dimension to dimension fields which needs to be annotated on the response.

If no "show" matrix param has been set, it returns the default dimension fields configured for the dimension.

Parameters:

apiDimensionPathSegments - Path segments for the dimensions

dimensionDictionary - Dimension dictionary to look the dimensions up in

Returns:

A map of dimension to requested dimension fields

validateAggregatability

protected void validateAggregatability(Set<Dimension> apiDimensions,
                                       Map<Dimension,Set<ApiFilter>> apiFilters)
                                throws BadApiRequestException

Validate that the request references any non-aggregatable dimensions in a valid way.

Parameters:

apiDimensions - the set of group by dimensions.

apiFilters - the set of api filters.

Throws:

BadApiRequestException - if a the request violates aggregatability constraints of dimensions.

isNonAggregatableInFilter

public static Predicate<ApiFilter> isNonAggregatableInFilter()

Validity rules for non-aggregatable dimensions that are only referenced in filters. A query that references a non-aggregatable dimension in a filter without grouping by this dimension, is valid only if the requested dimension field is a key for this dimension and only a single value is requested with an inclusive operator ('in' or 'eq').

Returns:

A predicate that determines a given dimension is non aggregatable and also not constrained to one row per result

generateLogicalMetrics

protected LinkedHashSet<LogicalMetric> generateLogicalMetrics(String apiMetricQuery,
                                                              MetricDictionary metricDictionary,
                                                              DimensionDictionary dimensionDictionary,
                                                              LogicalTable table)
                                                       throws BadApiRequestException

Extracts the list of metrics from the url metric query string and generates a set of LogicalMetrics.

Parameters:

apiMetricQuery - URL query string containing the metrics separated by ','.

metricDictionary - Metric dictionary contains the map of valid metric names and logical metric objects.

dimensionDictionary - Dimension dictionary to look the dimension up in

table - The logical table for the data request

Returns:

set of metric objects

Throws:

BadApiRequestException - if the metric dictionary returns a null or if the apiMetricQuery is invalid.

getCurrentDate

protected org.joda.time.DateTime getCurrentDate(org.joda.time.DateTime dateTime,
                                                TimeGrain timeGrain)

Generate current date based on granularity.

Parameters:

dateTime - The current moment as a DateTime

timeGrain - The time grain used to round the date time

Returns:

truncated current date based on granularity

getSortDirection

protected SortDirection getSortDirection(List<String> columnWithDirection)

Extract valid sort direction.

Parameters:

columnWithDirection - Column and its sorting direction

Returns:

Sorting direction. If no direction provided then the default one will be DESC

generateSortColumns

protected LinkedHashSet<OrderByColumn> generateSortColumns(Map<String,SortDirection> sortDirectionMap,
                                                           Set<LogicalMetric> logicalMetrics,
                                                           MetricDictionary metricDictionary)
                                                    throws BadApiRequestException

Generates a Set of OrderByColumn.

Parameters:

sortDirectionMap - Map of columns and their direction

logicalMetrics - Set of LogicalMetrics in the query

metricDictionary - Metric dictionary contains the map of valid metric names and logical metric objects.

Returns:

a Set of OrderByColumn

Throws:

BadApiRequestException - if the sort clause is invalid.

generateInteger

protected int generateInteger(String value,
                              String parameterName)
                       throws BadApiRequestException

Parses the requested input String by converting it to an integer, while treating null as zero.

Parameters:

value - The requested integer value as String.

parameterName - The parameter name that corresponds to the requested integer value.

Returns:

The integer corresponding to value or zero if value is null.

Throws:

BadApiRequestException - if the input String can not be parsed as an integer.

withFormat

public DataApiRequestImpl withFormat(ResponseFormatType format)

Specified by:

withFormat in interface DataApiRequest

withPaginationParameters

public DataApiRequestImpl withPaginationParameters(Optional<PaginationParameters> paginationParameters)

Specified by:

withPaginationParameters in interface DataApiRequest

withUriInfo

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

Specified by:

withUriInfo in interface DataApiRequest

withBuilder

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

Specified by:

withBuilder in interface DataApiRequest

withTable

public DataApiRequestImpl withTable(LogicalTable table)

Specified by:

withTable in interface DataApiRequest

withGranularity

public DataApiRequestImpl withGranularity(Granularity granularity)

Specified by:

withGranularity in interface DataApiRequest

withDimensions

public DataApiRequestImpl withDimensions(Set<Dimension> dimensions)

Specified by:

withDimensions in interface DataApiRequest

withPerDimensionFields

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

Specified by:

withPerDimensionFields in interface DataApiRequest

withLogicalMetrics

public DataApiRequestImpl withLogicalMetrics(Set<LogicalMetric> logicalMetrics)

Specified by:

withLogicalMetrics in interface DataApiRequest

withIntervals

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

Specified by:

withIntervals in interface DataApiRequest

withFilters

public DataApiRequestImpl withFilters(ApiFilters apiFilters)

Specified by:

withFilters in interface DataApiRequest

withHavings

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

Specified by:

withHavings in interface DataApiRequest

withHaving

public DataApiRequestImpl withHaving(Having having)

Specified by:

withHaving in interface DataApiRequest

withSorts

public DataApiRequestImpl withSorts(LinkedHashSet<OrderByColumn> sorts)

Specified by:

withSorts in interface DataApiRequest

withCount

public DataApiRequestImpl withCount(int count)

Specified by:

withCount in interface DataApiRequest

withTopN

public DataApiRequestImpl withTopN(int topN)

Specified by:

withTopN in interface DataApiRequest

withAsyncAfter

public DataApiRequestImpl withAsyncAfter(long asyncAfter)

Specified by:

withAsyncAfter in interface DataApiRequest

withTimeZone

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

Specified by:

withTimeZone in interface DataApiRequest

withFilterBuilder

public DataApiRequestImpl withFilterBuilder(DruidFilterBuilder filterBuilder)

Specified by:

withFilterBuilder in interface DataApiRequest

getFilterDimensions

public Set<Dimension> getFilterDimensions()

Gets the filter dimensions form the given set of filter objects.

Specified by:

getFilterDimensions in interface DataApiRequest

Returns:

Set of filter dimensions.

getTable

public LogicalTable getTable()

Description copied from interface: DataApiRequest

The logical table for this request.

Specified by:

getTable in interface DataApiRequest

Returns:

A logical table

getGranularity

public Granularity getGranularity()

Description copied from interface: DataApiRequest

The grain to group the results of this request.

Specified by:

getGranularity in interface DataApiRequest

Returns:

a granularity

getDimensions

public Set<Dimension> getDimensions()

Description copied from interface: DataApiRequest

The set of grouping dimensions on this ApiRequest.

Specified by:

getDimensions in interface DataApiRequest

Returns:

a set of dimensions

getDimensionFields

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

Description copied from interface: DataApiRequest

A map of dimension fields specified for the output schema.

Specified by:

getDimensionFields in interface DataApiRequest

Returns:

The dimension fields for output grouped by their dimension

getLogicalMetrics

public Set<LogicalMetric> getLogicalMetrics()

Description copied from interface: DataApiRequest

The logical metrics requested in this query.

Specified by:

getLogicalMetrics in interface DataApiRequest

Returns:

A set of logical metrics

getIntervals

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

Description copied from interface: DataApiRequest

The intervals for this query.

Specified by:

getIntervals in interface DataApiRequest

Returns:

A set of intervals

getApiFilters

public ApiFilters getApiFilters()

Description copied from interface: DataApiRequest

The filters for this ApiRequest, grouped by dimensions.

Specified by:

getApiFilters in interface DataApiRequest

Returns:

a map of filters by dimension

getDruidFilter

public 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.

Specified by:

getDruidFilter in interface DataApiRequest

Returns:

the Druid filter

getHavings

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

Description copied from interface: DataApiRequest

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

Specified by:

getHavings in interface DataApiRequest

Returns:

a map of havings by metrics.

getHaving

public Having getHaving()

Description copied from interface: DataApiRequest

The fact model having (should probably remove this).

Specified by:

getHaving in interface DataApiRequest

Returns:

A fact model having

getSorts

public LinkedHashSet<OrderByColumn> getSorts()

Description copied from interface: DataApiRequest

A prioritized list of sort columns.

Specified by:

getSorts in interface DataApiRequest

Returns:

sort columns.

getCount

public OptionalInt getCount()

Description copied from interface: DataApiRequest

An optional limit of records returned.

Specified by:

getCount in interface DataApiRequest

Returns:

An optional integer.

getTopN

public OptionalInt getTopN()

Description copied from interface: DataApiRequest

The limit per time bucket for a top n query.

Specified by:

getTopN in interface DataApiRequest

Returns:

The number of values per bucket.

getTimeZone

public org.joda.time.DateTimeZone getTimeZone()

Description copied from interface: DataApiRequest

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

Specified by:

getTimeZone in interface DataApiRequest

Returns:

A time zone

getFilterBuilder

public DruidFilterBuilder getFilterBuilder()

Description copied from interface: DataApiRequest

A filter builder (remove).

Specified by:

getFilterBuilder in interface DataApiRequest

Returns:

a filter builder.

getDateTimeSort

public Optional<OrderByColumn> getDateTimeSort()

Description copied from interface: DataApiRequest

An optional sorting predicate for the time column.

Specified by:

getDateTimeSort in interface DataApiRequest

Returns:

The sort direction