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

Class TopNQuery

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

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

All Implemented Interfaces:

DruidAggregationQuery<TopNQuery>, DruidFactQuery<TopNQuery>, DruidQuery<TopNQuery>

public class TopNQuery
extends AbstractDruidAggregationQuery<TopNQuery>

Druid topN query.

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

Modifier	Constructor and Description
	TopNQuery(DataSource dataSource, Granularity granularity, Dimension dimension, Filter filter, Collection<Aggregation> aggregations, Collection<PostAggregation> postAggregations, Collection<org.joda.time.Interval> intervals, long threshold, TopNMetric metric) Constructor.
protected	TopNQuery(DataSource dataSource, Granularity granularity, Dimension dimension, Filter filter, Collection<Aggregation> aggregations, Collection<PostAggregation> postAggregations, Collection<org.joda.time.Interval> intervals, long threshold, TopNMetric metric, QueryContext context, boolean doFork) Constructor.

Method Summary

Modifier and Type	Method and Description
Dimension	getDimension()
Collection<Dimension>	getDimensions() Returns the dimensions of the query if any.
TopNMetric	getMetric()
long	getThreshold()
TopNQuery	withAggregations(Collection<Aggregation> aggregations) Returns a copy of this query with the specified aggregations.
TopNQuery	withAllIntervals(Collection<org.joda.time.Interval> intervals) Returns a copy of this query with the specified intervals set in this and all inner queries.
TopNQuery	withContext(QueryContext context) Returns a copy of this query with the specified context.
TopNQuery	withDataSource(DataSource dataSource) Returns a copy of this query with the specified data source.
TopNQuery	withDimension(Dimension dimension)
TopNQuery	withFilter(Filter filter) Returns a copy of this query with the specified filter.
TopNQuery	withGranularity(Granularity granularity) Returns a copy of this query with the specified time grain.
TopNQuery	withInnermostDataSource(DataSource dataSource) Returns a copy of this query with the specified data source on the innermost query.
TopNQuery	withIntervals(Collection<org.joda.time.Interval> intervals) Returns a copy of this query with the specified intervals.
TopNQuery	withMetric(TopNMetric metric)
TopNQuery	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.AbstractDruidAggregationQuery

getAggregations, getPostAggregations

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

getFilter, getGranularity, getIntervals

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, getInnerQuery, getMetricDimensions

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

getFilter, getGranularity, getIntervals

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

getContext, getDataSource, getQueryType

Constructor Detail

TopNQuery

protected TopNQuery(DataSource dataSource,
                    Granularity granularity,
                    Dimension dimension,
                    Filter filter,
                    Collection<Aggregation> aggregations,
                    Collection<PostAggregation> postAggregations,
                    Collection<org.joda.time.Interval> intervals,
                    long threshold,
                    TopNMetric metric,
                    QueryContext context,
                    boolean doFork)

Constructor.

Parameters:

dataSource - The datasource

granularity - The granularity

dimension - The dimension

filter - The filter

aggregations - The aggregations

postAggregations - The post-aggregations

intervals - The intervals

threshold - The threshold

metric - The TopN metric

context - The context

doFork - true to fork a new context and bump up the query id, or false to create an exact copy of the context.

TopNQuery

public TopNQuery(DataSource dataSource,
                 Granularity granularity,
                 Dimension dimension,
                 Filter filter,
                 Collection<Aggregation> aggregations,
                 Collection<PostAggregation> postAggregations,
                 Collection<org.joda.time.Interval> intervals,
                 long threshold,
                 TopNMetric metric)

Constructor.

Parameters:

dataSource - The datasource

granularity - The granularity

dimension - The dimension

filter - The filter

aggregations - The aggregations

postAggregations - The post-aggregations

intervals - The intervals

threshold - The threshold

metric - The TopN metric

Method Detail

getDimension

public Dimension getDimension()

getDimensions

public Collection<Dimension> getDimensions()

Description copied from interface: DruidAggregationQuery

Returns the dimensions of the query if any.

Specified by:

getDimensions in interface DruidAggregationQuery<TopNQuery>

Overrides:

getDimensions in class AbstractDruidAggregationQuery<TopNQuery>

Returns:

the query dimensions

getThreshold

public long getThreshold()

getMetric

public TopNMetric getMetric()

withDataSource

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

withDimension

public TopNQuery withDimension(Dimension dimension)

withMetric

public TopNQuery withMetric(TopNMetric metric)

withGranularity

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

withAggregations

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

withIntervals

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

withContext

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