io.druid.query.topn

Class TopNQueryBuilder

java.lang.Object

io.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 and Description
TopNQueryBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
TopNQueryBuilder	aggregators(List<AggregatorFactory> a)
TopNQuery	build()
TopNQueryBuilder	context(Map<String,Object> c)
TopNQueryBuilder	copy(TopNQuery query)
TopNQueryBuilder	copy(TopNQueryBuilder builder)
TopNQueryBuilder	dataSource(DataSource d)
TopNQueryBuilder	dataSource(String d)
TopNQueryBuilder	dimension(DimensionSpec d)
TopNQueryBuilder	dimension(String d)
TopNQueryBuilder	dimension(String d, String outputName)
TopNQueryBuilder	filters(DimFilter f)
TopNQueryBuilder	filters(String dimensionName, String value)
TopNQueryBuilder	filters(String dimensionName, String value, String... values)
List<AggregatorFactory>	getAggregatorSpecs()
Map<String,Object>	getContext()
DataSource	getDataSource()
DimensionSpec	getDimensionSpec()
DimFilter	getDimFilter()
QueryGranularity	getGranularity()
List<PostAggregator>	getPostAggregatorSpecs()
QuerySegmentSpec	getQuerySegmentSpec()
int	getThreshold()
TopNMetricSpec	getTopNMetricSpec()
TopNQueryBuilder	granularity(QueryGranularity g)
TopNQueryBuilder	granularity(String g)
TopNQueryBuilder	intervals(List<org.joda.time.Interval> l)
TopNQueryBuilder	intervals(QuerySegmentSpec q)
TopNQueryBuilder	intervals(String s)
TopNQueryBuilder	metric(String s)
TopNQueryBuilder	metric(TopNMetricSpec t)
TopNQueryBuilder	postAggregators(List<PostAggregator> p)
TopNQueryBuilder	threshold(int i)

Methods inherited from class java.lang.Object

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

Constructor Detail

TopNQueryBuilder

public TopNQueryBuilder()

Method Detail

getDataSource

public DataSource getDataSource()

getDimensionSpec

public DimensionSpec getDimensionSpec()

getTopNMetricSpec

public TopNMetricSpec getTopNMetricSpec()

getThreshold

public int getThreshold()

getQuerySegmentSpec

public QuerySegmentSpec getQuerySegmentSpec()

getDimFilter

public DimFilter getDimFilter()

getGranularity

public QueryGranularity getGranularity()

getAggregatorSpecs

public List<AggregatorFactory> getAggregatorSpecs()

getPostAggregatorSpecs

public List<PostAggregator> getPostAggregatorSpecs()

getContext

public Map<String,Object> getContext()

build

public TopNQuery build()

copy

public TopNQueryBuilder copy(TopNQuery query)

copy

public TopNQueryBuilder copy(TopNQueryBuilder builder)

dataSource

public TopNQueryBuilder dataSource(String d)

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(String g)

granularity

public TopNQueryBuilder granularity(QueryGranularity g)

aggregators

public TopNQueryBuilder aggregators(List<AggregatorFactory> a)

postAggregators

public TopNQueryBuilder postAggregators(List<PostAggregator> p)

context

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