com.yahoo.bard.webservice.data.metric

Class TemplateDruidQuery

java.lang.Object

com.yahoo.bard.webservice.data.metric.TemplateDruidQuery

All Implemented Interfaces:

DruidAggregationQuery<TemplateDruidQuery>, DruidFactQuery<TemplateDruidQuery>, DruidQuery<TemplateDruidQuery>

public class TemplateDruidQuery
extends Object
implements DruidAggregationQuery<TemplateDruidQuery>

Template Druid Query. This class is immutable.

Constructor Summary

Constructors

Constructor and Description
TemplateDruidQuery(Collection<Aggregation> aggregations, Collection<PostAggregation> postAggregations) Template Query constructor for a non nested template query.
TemplateDruidQuery(Collection<Aggregation> aggregations, Collection<PostAggregation> postAggregations, TemplateDruidQuery nestedQuery) Template Query constructor for a nested template query.
TemplateDruidQuery(Collection<Aggregation> aggregations, Collection<PostAggregation> postAggregations, TemplateDruidQuery nestedQuery, ZonelessTimeGrain timeGrain) Template Query constructor for a nested template query with a bound time grain.
TemplateDruidQuery(Collection<Aggregation> aggregations, Collection<PostAggregation> postAggregations, ZonelessTimeGrain timeGrain) Template Query constructor for a non nested template query with a bound time grain.

Method Summary

Modifier and Type	Method and Description
int	depth() Returns the depth of the query nesting.
boolean	equals(Object o)
Set<Aggregation>	getAggregations() Returns the aggregations of the query.
QueryContext	getContext() Returns the context of the query.
DataSource	getDataSource() Returns the data source 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.
TemplateDruidQuery	getInnermostQuery() If this structure is part of a query stack, return the lowest element.
Optional<TemplateDruidQuery>	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.
MetricField	getMetricField(String name) Get the field by name.
Set<PostAggregation>	getPostAggregations() Returns the post-aggregations of the query.
QueryType	getQueryType() Returns the type of the query.
ZonelessTimeGrain	getTimeGrain()
int	hashCode()
boolean	isNested() Checks if the template druid query is nested.
boolean	isTimeGrainValid() Check if outer TimeGrain is compatible with inner TimeGrain.
TemplateDruidQuery	merge(TemplateDruidQuery sibling) Merges two template queries into one.
TemplateDruidQuery	nest() Transforms a N-pass query into a (N+1)-pass query.
String	toString()
TemplateDruidQuery	withAggregations(Collection<Aggregation> newAggregations) Makes a copy of the template query and any sub query(s), changing aggregations.
TemplateDruidQuery	withAllIntervals(Collection<org.joda.time.Interval> intervals) Returns a copy of this query with the specified intervals set in this and all inner queries.
TemplateDruidQuery	withContext(QueryContext context) Returns a copy of this query with the specified context.
TemplateDruidQuery	withDataSource(DataSource dataSource) Returns a copy of this query with the specified data source.
TemplateDruidQuery	withFilter(Filter filter) Returns a copy of this query with the specified filter.
TemplateDruidQuery	withGranularity(Granularity granularity) With granularity is partially implemented because TemplateDruidQuery supports only ZonelessTimeGrains.
TemplateDruidQuery	withGranularity(ZonelessTimeGrain newTimeGrain) Makes a copy of the template query and any sub query(s), changing time grain on the outermost level only.
TemplateDruidQuery	withInnermostDataSource(DataSource dataSource) Returns a copy of this query with the specified data source on the innermost query.
TemplateDruidQuery	withInnerQuery(TemplateDruidQuery newNestedQuery) Makes a copy of the template query, changing nested query.
TemplateDruidQuery	withIntervals(Collection<org.joda.time.Interval> intervals) Returns a copy of this query with the specified intervals.
TemplateDruidQuery	withPostAggregations(Collection<PostAggregation> newPostAggregations) Makes a copy of the template query and any sub query(s), changing post-aggregations.

Methods inherited from class java.lang.Object

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

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

buildSchemaColumns, getDependentFieldNames, getMetricDimensions

Constructor Detail

TemplateDruidQuery

public TemplateDruidQuery(Collection<Aggregation> aggregations,
                          Collection<PostAggregation> postAggregations)

Template Query constructor for a non nested template query. For a non nested query (i.e. last node in the link), it does not have any nested query

Parameters:

aggregations - aggregations for this query template

postAggregations - post aggregations for this query template

TemplateDruidQuery

public TemplateDruidQuery(Collection<Aggregation> aggregations,
                          Collection<PostAggregation> postAggregations,
                          ZonelessTimeGrain timeGrain)

Template Query constructor for a non nested template query with a bound time grain.

Parameters:

aggregations - aggregations for this query template

postAggregations - post aggregations for this query template

timeGrain - The time grain constraint

TemplateDruidQuery

public TemplateDruidQuery(Collection<Aggregation> aggregations,
                          Collection<PostAggregation> postAggregations,
                          TemplateDruidQuery nestedQuery)

Template Query constructor for a nested template query.

Parameters:

aggregations - aggregations for this query template

postAggregations - post aggregations for this template query

nestedQuery - A query which this query uses as a data source

TemplateDruidQuery

public TemplateDruidQuery(Collection<Aggregation> aggregations,
                          Collection<PostAggregation> postAggregations,
                          TemplateDruidQuery nestedQuery,
                          ZonelessTimeGrain timeGrain)

Template Query constructor for a nested template query with a bound time grain.

Parameters:

aggregations - aggregations for this query template

postAggregations - post aggregations for this query template

nestedQuery - A query which this query uses as a data source

timeGrain - The time grain constraint on the query if any

Method Detail

nest

public TemplateDruidQuery nest()

Transforms a N-pass query into a (N+1)-pass query. The original query is not mutated.

Returns:

nested query

isTimeGrainValid

public boolean isTimeGrainValid()

Check if outer TimeGrain is compatible with inner TimeGrain.

Returns:

false if outer TimeGrain cannot be composed by the inner time grain

merge

public TemplateDruidQuery merge(TemplateDruidQuery sibling)

Merges two template queries into one. The original queries are not mutated.

Parameters:

sibling - the query to merge.

Returns:

merged query

toString

public String toString()

Overrides:

toString in class Object

getQueryType

public QueryType getQueryType()

Description copied from interface: DruidQuery

Returns the type of the query.

Specified by:

getQueryType in interface DruidQuery<TemplateDruidQuery>

Returns:

the query type

getDataSource

public DataSource getDataSource()

Description copied from interface: DruidQuery

Returns the data source of the query.

Specified by:

getDataSource in interface DruidQuery<TemplateDruidQuery>

Returns:

the data source

getContext

public QueryContext getContext()

Description copied from interface: DruidQuery

Returns the context of the query. If the context is uninitialized it returns an initialized empty context

Specified by:

getContext in interface DruidQuery<TemplateDruidQuery>

Returns:

the query context

getGranularity

public Granularity getGranularity()

Description copied from interface: DruidFactQuery

Returns the time grain (granularity) of the query.

Specified by:

getGranularity in interface DruidFactQuery<TemplateDruidQuery>

Returns:

the query time grain

getFilter

public Filter getFilter()

Description copied from interface: DruidFactQuery

Returns the filter object of the query.

Specified by:

getFilter in interface DruidFactQuery<TemplateDruidQuery>

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<TemplateDruidQuery>

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<TemplateDruidQuery>

Returns:

the query dimensions

getAggregations

public Set<Aggregation> getAggregations()

Description copied from interface: DruidAggregationQuery

Returns the aggregations of the query.

Specified by:

getAggregations in interface DruidAggregationQuery<TemplateDruidQuery>

Returns:

the query aggregations

getPostAggregations

public Set<PostAggregation> getPostAggregations()

Description copied from interface: DruidAggregationQuery

Returns the post-aggregations of the query.

Specified by:

getPostAggregations in interface DruidAggregationQuery<TemplateDruidQuery>

Returns:

the query post-aggregations

getTimeGrain

public ZonelessTimeGrain getTimeGrain()

getInnerQuery

public Optional<TemplateDruidQuery> getInnerQuery()

Description copied from interface: DruidQuery

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

Specified by:

getInnerQuery in interface DruidAggregationQuery<TemplateDruidQuery>

Specified by:

getInnerQuery in interface DruidFactQuery<TemplateDruidQuery>

Specified by:

getInnerQuery in interface DruidQuery<TemplateDruidQuery>

Returns:

the nested query or empty if there is no nested query

getInnermostQuery

public TemplateDruidQuery getInnermostQuery()

Description copied from interface: DruidQuery

If this structure is part of a query stack, return the lowest element.

Specified by:

getInnermostQuery in interface DruidAggregationQuery<TemplateDruidQuery>

Specified by:

getInnermostQuery in interface DruidFactQuery<TemplateDruidQuery>

Specified by:

getInnermostQuery in interface DruidQuery<TemplateDruidQuery>

Returns:

Return the most nested inner query OR the object itself if it has no children

isNested

public boolean isNested()

Checks if the template druid query is nested.

Returns:

true if query is nested else false.

depth

public int depth()

Returns the depth of the query nesting.

Returns:

1 for queries without nesting. >1 for queries with nested queries.

getMetricField

public MetricField getMetricField(String name)

Get the field by name.

Parameters:

name - Name of the field to retrieve

Returns:

The field if found, or null if we couldn't find a matching Field

Throws:

IllegalArgumentException - if there is no MetricField with the given name

withAggregations

public TemplateDruidQuery withAggregations(Collection<Aggregation> newAggregations)

Makes a copy of the template query and any sub query(s), changing aggregations.

Everything is a shallow copy.

Specified by:

withAggregations in interface DruidAggregationQuery<TemplateDruidQuery>

Parameters:

newAggregations - The Aggregations to replace in the copy

Returns:

copy of the query

withPostAggregations

public TemplateDruidQuery withPostAggregations(Collection<PostAggregation> newPostAggregations)

Makes a copy of the template query and any sub query(s), changing post-aggregations.

Everything is a shallow copy.

Specified by:

withPostAggregations in interface DruidAggregationQuery<TemplateDruidQuery>

Parameters:

newPostAggregations - The PostAggregations to replace with in the copy

Returns:

copy of the query

withInnerQuery

public TemplateDruidQuery withInnerQuery(TemplateDruidQuery newNestedQuery)

Makes a copy of the template query, changing nested query.

Everything is a shallow copy.

Parameters:

newNestedQuery - The nestedQuery to replace in the copy

Returns:

copy of the query

withGranularity

public TemplateDruidQuery withGranularity(ZonelessTimeGrain newTimeGrain)

Makes a copy of the template query and any sub query(s), changing time grain on the outermost level only.

Everything is a shallow copy.

Parameters:

newTimeGrain - The TimeGrain to replace with in the copy

Returns:

copy of the query

withDataSource

public TemplateDruidQuery withDataSource(DataSource dataSource)

Description copied from interface: DruidQuery

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

Specified by:

withDataSource in interface DruidQuery<TemplateDruidQuery>

Parameters:

dataSource - the new data source

Returns:

the query copy

withInnermostDataSource

public TemplateDruidQuery withInnermostDataSource(DataSource dataSource)

Description copied from interface: DruidQuery

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

Specified by:

withInnermostDataSource in interface DruidQuery<TemplateDruidQuery>

Parameters:

dataSource - the new data source

Returns:

the query copy

withGranularity

public TemplateDruidQuery withGranularity(Granularity granularity)

With granularity is partially implemented because TemplateDruidQuery supports only ZonelessTimeGrains.

Specified by:

withGranularity in interface DruidFactQuery<TemplateDruidQuery>

Parameters:

granularity - a zoneless time grain

Returns:

a new TemplateDruidQuery based in the new granularity

Throws:

UnsupportedOperationException - if the granularity is not a ZonelessTimeGrain

withFilter

public TemplateDruidQuery withFilter(Filter filter)

Description copied from interface: DruidFactQuery

Returns a copy of this query with the specified filter.

Specified by:

withFilter in interface DruidFactQuery<TemplateDruidQuery>

Parameters:

filter - the new filter

Returns:

the query copy

withIntervals

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

Description copied from interface: DruidFactQuery

Returns a copy of this query with the specified intervals.

Specified by:

withIntervals in interface DruidFactQuery<TemplateDruidQuery>

Parameters:

intervals - the new intervals

Returns:

the query copy

withAllIntervals

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

Specified by:

withAllIntervals in interface DruidFactQuery<TemplateDruidQuery>

Parameters:

intervals - the new intervals

Returns:

the query copy

withContext

public TemplateDruidQuery withContext(QueryContext context)

Description copied from interface: DruidQuery

Returns a copy of this query with the specified context.

Specified by:

withContext in interface DruidQuery<TemplateDruidQuery>

Parameters:

context - the new context

Returns:

the query copy

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object