com.yahoo.bard.webservice.druid.model.orderby

Class TopNMetric

java.lang.Object

com.yahoo.bard.webservice.druid.model.orderby.TopNMetric

public class TopNMetric
extends Object

TopNMetric class corresponding to the Druid TopNMetricSpec. It specifies how topN values will be sorted.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopNMetric.TopNMetricType Types of topN metrics.

Constructor Summary

Constructors

Constructor and Description
TopNMetric(String metricName) Constructs a numeric sort of the given metric with default sorting order (descending).
TopNMetric(String metricName, SortDirection order) Constructs a numeric sort of the given metric and explicitly specifies the order (ascending or descending).
TopNMetric(TopNMetric.TopNMetricType type, String previousStop) Constructs a sort of the given type with a starting point.
TopNMetric(TopNMetric.TopNMetricType type, String previousStop, SortDirection order) Constructs a sort of the given type with a starting point and explicitly specifies the order (ascending or descending).

Method Summary

Modifier and Type	Method and Description
Object	getMetric() Getter for the metric of TopNMetric.
String	getPreviousStop() Getter for the previousStop of TopNMetric.
TopNMetric.TopNMetricType	getType() Getter for the type of TopNMetric.

Methods inherited from class java.lang.Object

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

Constructor Detail

TopNMetric

public TopNMetric(String metricName)

Constructs a numeric sort of the given metric with default sorting order (descending).

Parameters:

metricName - the metric name

TopNMetric

public TopNMetric(String metricName,
                  SortDirection order)

Constructs a numeric sort of the given metric and explicitly specifies the order (ascending or descending).

Parameters:

metricName - the metric name

order - sorting order

TopNMetric

public TopNMetric(TopNMetric.TopNMetricType type,
                  String previousStop)

Constructs a sort of the given type with a starting point.

Parameters:

type - the type of sort

previousStop - the starting point of the sort

TopNMetric

public TopNMetric(TopNMetric.TopNMetricType type,
                  String previousStop,
                  SortDirection order)

Constructs a sort of the given type with a starting point and explicitly specifies the order (ascending or descending).

Parameters:

type - the type of sort

previousStop - the starting point of the sort

order - sorting order

Method Detail

getType

public TopNMetric.TopNMetricType getType()

Getter for the type of TopNMetric.

Returns:

type

getMetric

public Object getMetric()

Getter for the metric of TopNMetric.

Returns:

metric

getPreviousStop

public String getPreviousStop()

Getter for the previousStop of TopNMetric.

Returns:

previousStop