com.yahoo.bard.webservice.druid.model.query

Class LookbackQuery

java.lang.Object

com.yahoo.bard.webservice.druid.model.query.AbstractDruidQuery<Q>

com.yahoo.bard.webservice.druid.model.query.AbstractDruidFactQuery<Q>

com.yahoo.bard.webservice.druid.model.query.AbstractDruidAggregationQuery<LookbackQuery>

com.yahoo.bard.webservice.druid.model.query.LookbackQuery

All Implemented Interfaces:

DruidAggregationQuery<LookbackQuery>, DruidFactQuery<LookbackQuery>, DruidQuery<LookbackQuery>

public class LookbackQuery
extends AbstractDruidAggregationQuery<LookbackQuery>

Druid lookback query.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LookbackQuery.LookbackQueryRequestedIntervalsFunction The function to get requestedIntervals from a LookbackQuery.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.druid.model.query.AbstractDruidAggregationQuery

aggregations, dimensions, postAggregations

Fields inherited from class com.yahoo.bard.webservice.druid.model.query.AbstractDruidFactQuery

filter, granularity, intervals

Fields inherited from class com.yahoo.bard.webservice.druid.model.query.AbstractDruidQuery

context, dataSource, queryType

Constructor Summary

Constructors

Constructor and Description
LookbackQuery(DataSource dataSource, Collection<PostAggregation> postAggregations, QueryContext context, Collection<org.joda.time.Period> lookbackOffsets, Collection<String> lookbackPrefixes, Having having, LimitSpec limitSpec) Constructor.

Method Summary

Modifier and Type	Method and Description
Set<Aggregation>	getAggregations() Returns the aggregations of the query.
Collection<Dimension>	getDimensions() Returns the dimensions of the query if any.
Filter	getFilter() Returns the filter object of the query.
Granularity	getGranularity() Returns the time grain (granularity) of the query.
Having	getHaving()
Optional<? extends DruidAggregationQuery>	getInnerQuery() If this query is nestable, and has a nested query return it.
List<org.joda.time.Interval>	getIntervals() Returns the intervals of the query.
LimitSpec	getLimitSpec()
List<String>	getlookbackOffsets() Get the collection of lookback offsets.
Collection<org.joda.time.Period>	getLookbackOffsets()
Collection<PostAggregation>	getLookbackPostAggregations()
Collection<String>	getLookbackPrefixes()
Collection<PostAggregation>	getPostAggregations() Returns the post-aggregations of the query.
LookbackQuery	withAggregations(Collection<Aggregation> aggregations) Returns a copy of this query with the specified aggregations.
LookbackQuery	withAllIntervals(Collection<org.joda.time.Interval> intervals) Returns a copy of this query with the specified intervals set in this and all inner queries.
LookbackQuery	withContext(QueryContext context) Returns a copy of this query with the specified context.
LookbackQuery	withDataSource(DataSource dataSource) Returns a copy of this query with the specified data source.
LookbackQuery	withFilter(Filter filter) Returns a copy of this query with the specified filter.
LookbackQuery	withGranularity(Granularity granularity) Returns a copy of this query with the specified time grain.
LookbackQuery	withHaving(Having having)
LookbackQuery	withInnermostDataSource(DataSource dataSource) Returns a copy of this query with the specified data source on the innermost query.
LookbackQuery	withInnerQueryPostAggregations(Collection<PostAggregation> postAggregations) Update the postAggregations of the nested inner query.
LookbackQuery	withIntervals(Collection<org.joda.time.Interval> intervals) Returns a copy of this query with the specified intervals.
LookbackQuery	withLookbackOffsets(List<org.joda.time.Period> lookbackOffsets)
LookbackQuery	withLookbackPrefix(List<String> lookbackPrefixes)
LookbackQuery	withLookbackQueryPostAggregations(Collection<PostAggregation> postAggregations) Update the postAggregations of the LookbackQuery(outer query).
LookbackQuery	withOrderBy(LimitSpec limitSpec)
LookbackQuery	withPostAggregations(Collection<PostAggregation> postAggregations) Returns a copy of this query with the specified post aggregations.

Methods inherited from class com.yahoo.bard.webservice.druid.model.query.AbstractDruidQuery

getContext, getDataSource, getQueryType

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.druid.model.query.DruidAggregationQuery

buildSchemaColumns, getDependentFieldNames, getInnermostQuery, getMetricDimensions

Methods inherited from interface com.yahoo.bard.webservice.druid.model.query.DruidQuery

getContext, getDataSource, getQueryType

Constructor Detail

LookbackQuery

public LookbackQuery(DataSource dataSource,
                     Collection<PostAggregation> postAggregations,
                     QueryContext context,
                     Collection<org.joda.time.Period> lookbackOffsets,
                     Collection<String> lookbackPrefixes,
                     Having having,
                     LimitSpec limitSpec)

Constructor.

Parameters:

dataSource - DataSource for the query

postAggregations - Post-aggregation operation trees for the query

context - Query context

lookbackOffsets - Set of period offsets

lookbackPrefixes - Set of prefixes for the lookback queries (should match the lookbackOffsets)

having - Having clause to apply to the result query

limitSpec - Limit spec to apply to the result query

Method Detail

getInnerQuery

public Optional<? extends DruidAggregationQuery> getInnerQuery()

Description copied from interface: DruidQuery

If this query is nestable, and has a nested query return it.

Returns:

the nested query or empty if there is no nested query

getHaving

public Having getHaving()

getLimitSpec

public LimitSpec getLimitSpec()

getLookbackPrefixes

public Collection<String> getLookbackPrefixes()

getLookbackOffsets

public Collection<org.joda.time.Period> getLookbackOffsets()

getlookbackOffsets

public List<String> getlookbackOffsets()

Get the collection of lookback offsets.

Returns:

The collection of lookback offsets.

getGranularity

public Granularity getGranularity()

Description copied from interface: DruidFactQuery

Returns the time grain (granularity) of the query.

Specified by:

getGranularity in interface DruidFactQuery<LookbackQuery>

Overrides:

getGranularity in class AbstractDruidFactQuery<LookbackQuery>

Returns:

the query time grain

getAggregations

public Set<Aggregation> getAggregations()

Description copied from interface: DruidAggregationQuery

Returns the aggregations of the query.

Specified by:

getAggregations in interface DruidAggregationQuery<LookbackQuery>

Overrides:

getAggregations in class AbstractDruidAggregationQuery<LookbackQuery>

Returns:

the query aggregations

getFilter

public Filter getFilter()

Description copied from interface: DruidFactQuery

Returns the filter object of the query.

Specified by:

getFilter in interface DruidFactQuery<LookbackQuery>

Overrides:

getFilter in class AbstractDruidFactQuery<LookbackQuery>

Returns:

the query filter object

getIntervals

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

Description copied from interface: DruidFactQuery

Returns the intervals of the query.

Specified by:

getIntervals in interface DruidFactQuery<LookbackQuery>

Overrides:

getIntervals in class AbstractDruidFactQuery<LookbackQuery>

Returns:

the query intervals

getDimensions

public Collection<Dimension> getDimensions()

Description copied from interface: DruidAggregationQuery

Returns the dimensions of the query if any.

Specified by:

getDimensions in interface DruidAggregationQuery<LookbackQuery>

Overrides:

getDimensions in class AbstractDruidAggregationQuery<LookbackQuery>

Returns:

the query dimensions

getLookbackPostAggregations

public Collection<PostAggregation> getLookbackPostAggregations()

getPostAggregations

public Collection<PostAggregation> getPostAggregations()

Description copied from interface: DruidAggregationQuery

Returns the post-aggregations of the query.

Specified by:

getPostAggregations in interface DruidAggregationQuery<LookbackQuery>

Overrides:

getPostAggregations in class AbstractDruidAggregationQuery<LookbackQuery>

Returns:

the query post-aggregations

withAggregations

public LookbackQuery withAggregations(Collection<Aggregation> aggregations)

Description copied from interface: DruidAggregationQuery

Returns a copy of this query with the specified aggregations.

Parameters:

aggregations - the new aggregations

Returns:

the query copy

withPostAggregations

public LookbackQuery withPostAggregations(Collection<PostAggregation> postAggregations)

Description copied from interface: DruidAggregationQuery

Returns a copy of this query with the specified post aggregations.

Parameters:

postAggregations - the new post aggregations

Returns:

the query copy

withInnerQueryPostAggregations

public LookbackQuery withInnerQueryPostAggregations(Collection<PostAggregation> postAggregations)

Update the postAggregations of the nested inner query. The PostAggregations of the LookbackQuery(outer query) remain unchanged

Parameters:

postAggregations - A Collection of PostAggregations

Returns:

A LookbackQuery whose datasource is built using the provided postAggregations

withLookbackQueryPostAggregations

public LookbackQuery withLookbackQueryPostAggregations(Collection<PostAggregation> postAggregations)

Update the postAggregations of the LookbackQuery(outer query).

Parameters:

postAggregations - A Collection of PostAggregations

Returns:

A LookbackQuery built using the provided postAggregations

withGranularity

public LookbackQuery withGranularity(Granularity granularity)

Description copied from interface: DruidFactQuery

Returns a copy of this query with the specified time grain.

Parameters:

granularity - the new time grain

Returns:

the query copy

withFilter

public LookbackQuery withFilter(Filter filter)

Description copied from interface: DruidFactQuery

Returns a copy of this query with the specified filter.

Parameters:

filter - the new filter

Returns:

the query copy

withIntervals

public LookbackQuery withIntervals(Collection<org.joda.time.Interval> intervals)

Description copied from interface: DruidFactQuery

Returns a copy of this query with the specified intervals.

Parameters:

intervals - the new intervals

Returns:

the query copy

withAllIntervals

public LookbackQuery withAllIntervals(Collection<org.joda.time.Interval> intervals)

Description copied from interface: DruidFactQuery

Returns a copy of this query with the specified intervals set in this and all inner queries.

All nested queries are copies of themselves with the specified intervals set.

Parameters:

intervals - the new intervals

Returns:

the query copy

withDataSource

public LookbackQuery withDataSource(DataSource dataSource)

Description copied from interface: DruidQuery

Returns a copy of this query with the specified data source.

Parameters:

dataSource - the new data source

Returns:

the query copy

withInnermostDataSource

public LookbackQuery withInnermostDataSource(DataSource dataSource)

Description copied from interface: DruidQuery

Returns a copy of this query with the specified data source on the innermost query.

Parameters:

dataSource - the new data source

Returns:

the query copy

withContext

public LookbackQuery withContext(QueryContext context)

Description copied from interface: DruidQuery

Returns a copy of this query with the specified context.

Parameters:

context - the new context

Returns:

the query copy

withOrderBy

public LookbackQuery withOrderBy(LimitSpec limitSpec)

withHaving

public LookbackQuery withHaving(Having having)

withLookbackPrefix

public LookbackQuery withLookbackPrefix(List<String> lookbackPrefixes)

withLookbackOffsets

public LookbackQuery withLookbackOffsets(List<org.joda.time.Period> lookbackOffsets)