Package org.apache.druid.query.topn

Class TopNQueryBuilder

java.lang.Object

org.apache.druid.query.topn.TopNQueryBuilder

public class TopNQueryBuilder
extends Object

A Builder for TopNQuery. Required: dataSource(), intervals(), metric() and threshold() must be called before build() Additional requirement for numeric metric sorts: aggregators() must be called before build() Optional: filters(), granularity(), postAggregators() and context() can be called before build() Usage example:

   TopNQuery query = new TopNQueryBuilder()
                                  .dataSource("Example")
                                  .dimension("example_dim")
                                  .metric("example_metric")
                                  .threshold(100)
                                  .intervals("2012-01-01/2012-01-02")
                                  .build();
 

See Also:

• TopNQuery

Constructor Summary

Constructors

Constructor	Description
TopNQueryBuilder()
TopNQueryBuilder(TopNQuery query)

Method Summary

Modifier and Type	Method	Description
TopNQueryBuilder	aggregators(List<? extends AggregatorFactory> a)
TopNQueryBuilder	aggregators(AggregatorFactory... aggs)
TopNQuery	build()
TopNQueryBuilder	context(Map<String,Object> c)
TopNQueryBuilder	copy(TopNQuery query)	Deprecated.
TopNQueryBuilder	copy(TopNQueryBuilder builder)	Deprecated.
TopNQueryBuilder	dataSource(String d)
TopNQueryBuilder	dataSource(DataSource d)
TopNQueryBuilder	dimension(String d)
TopNQueryBuilder	dimension(String d, String outputName)
TopNQueryBuilder	dimension(DimensionSpec d)
TopNQueryBuilder	filters(String dimensionName, String value)
TopNQueryBuilder	filters(String dimensionName, String value, String... values)
TopNQueryBuilder	filters(DimFilter f)
TopNQueryBuilder	granularity(Granularity g)
TopNQueryBuilder	intervals(String s)
TopNQueryBuilder	intervals(List<org.joda.time.Interval> l)
TopNQueryBuilder	intervals(QuerySegmentSpec q)
TopNQueryBuilder	metric(String s)
TopNQueryBuilder	metric(TopNMetricSpec t)
TopNQueryBuilder	postAggregators(Collection<PostAggregator> p)
TopNQueryBuilder	postAggregators(PostAggregator... postAggs)
TopNQueryBuilder	queryId(String queryId)
TopNQueryBuilder	randomQueryId()
TopNQueryBuilder	threshold(int i)
TopNQueryBuilder	virtualColumns(VirtualColumn... virtualColumns)
TopNQueryBuilder	virtualColumns(VirtualColumns virtualColumns)

Methods inherited from class java.lang.Object

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

Constructor Details

TopNQueryBuilder

public TopNQueryBuilder()

TopNQueryBuilder

public TopNQueryBuilder(TopNQuery query)

Method Details

build

public TopNQuery build()

copy

@Deprecated
public TopNQueryBuilder copy(TopNQuery query)

Deprecated.

copy

@Deprecated
public TopNQueryBuilder copy(TopNQueryBuilder builder)

Deprecated.

dataSource

public TopNQueryBuilder dataSource(String d)

virtualColumns

public TopNQueryBuilder virtualColumns(VirtualColumns virtualColumns)

virtualColumns

public TopNQueryBuilder virtualColumns(VirtualColumn... virtualColumns)

dataSource

public TopNQueryBuilder dataSource(DataSource d)

dimension

public TopNQueryBuilder dimension(String d)

dimension

public TopNQueryBuilder dimension(String d,
 String outputName)

dimension

public TopNQueryBuilder dimension(DimensionSpec d)

metric

public TopNQueryBuilder metric(String s)

metric

public TopNQueryBuilder metric(TopNMetricSpec t)

threshold

public TopNQueryBuilder threshold(int i)

intervals

public TopNQueryBuilder intervals(QuerySegmentSpec q)

intervals

public TopNQueryBuilder intervals(String s)

intervals

public TopNQueryBuilder intervals(List<org.joda.time.Interval> l)

filters

public TopNQueryBuilder filters(String dimensionName,
 String value)

filters

public TopNQueryBuilder filters(String dimensionName,
 String value,
 String... values)

filters

public TopNQueryBuilder filters(DimFilter f)

granularity

public TopNQueryBuilder granularity(Granularity g)

aggregators

public TopNQueryBuilder aggregators(List<? extends AggregatorFactory> a)

aggregators

public TopNQueryBuilder aggregators(AggregatorFactory... aggs)

postAggregators

public TopNQueryBuilder postAggregators(Collection<PostAggregator> p)

postAggregators

public TopNQueryBuilder postAggregators(PostAggregator... postAggs)

context

public TopNQueryBuilder context(Map<String,Object> c)

randomQueryId

public TopNQueryBuilder randomQueryId()

queryId

public TopNQueryBuilder queryId(String queryId)