com.yahoo.bard.webservice.table.resolver

Class DataSourceConstraint

java.lang.Object

com.yahoo.bard.webservice.table.resolver.DataSourceConstraint

Direct Known Subclasses:

PhysicalDataSourceConstraint, QueryPlanningConstraint

public class DataSourceConstraint
extends Object

Constraints for retrieving potential table availability for a given query.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataSourceConstraint(DataApiRequest dataApiRequest, DruidAggregationQuery<?> templateDruidQuery) Constructor.
protected	DataSourceConstraint(DataSourceConstraint dataSourceConstraint) Copy Constructor.
protected	DataSourceConstraint(Set<Dimension> requestDimensions, Set<Dimension> filterDimensions, Set<Dimension> metricDimensions, Set<String> metricNames, ApiFilters apiFilters) Constructor.
protected	DataSourceConstraint(Set<Dimension> requestDimensions, Set<Dimension> filterDimensions, Set<Dimension> metricDimensions, Set<String> metricNames, Set<Dimension> allDimensions, Set<String> allDimensionNames, Set<String> allColumnNames, ApiFilters apiFilters) Deprecated. "allDimensions", "allDimensionNames", and "allColumnNames" can be generated by other arguments. Use DataSourceConstraint(Set, Set, Set, Set, ApiFilters) instead, which saves caller argument-passing efforts.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Set<String>	getAllColumnNames()
Set<String>	getAllDimensionNames()
Set<Dimension>	getAllDimensions()
ApiFilters	getApiFilters()
Set<Dimension>	getFilterDimensions()
Set<Dimension>	getMetricDimensions()
Set<String>	getMetricNames()
Set<Dimension>	getRequestDimensions()
int	hashCode()
static DataSourceConstraint	unconstrained(PhysicalTable table) Build a constraint which should not filter away any part of a given table.
DataSourceConstraint	withMetricIntersection(Set<String> metricNames) Create a new DataSourceConstraint instance with a new subset of metric names.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceConstraint

public DataSourceConstraint(DataApiRequest dataApiRequest,
                            DruidAggregationQuery<?> templateDruidQuery)

Constructor.

Parameters:

dataApiRequest - Api request containing the constraints information.

templateDruidQuery - Query containing metric constraint information.

DataSourceConstraint

protected DataSourceConstraint(@NotNull
                               Set<Dimension> requestDimensions,
                               @NotNull
                               Set<Dimension> filterDimensions,
                               @NotNull
                               Set<Dimension> metricDimensions,
                               @NotNull
                               Set<String> metricNames,
                               @NotNull
                               ApiFilters apiFilters)

Constructor.

Parameters:

requestDimensions - Dimensions contained in request

filterDimensions - Filtered dimensions

metricDimensions - Metric related dimensions

metricNames - Names of metrics

apiFilters - Map of dimension to its set of API filters

DataSourceConstraint

@Deprecated
protected DataSourceConstraint(@NotNull
                                           Set<Dimension> requestDimensions,
                                           @NotNull
                                           Set<Dimension> filterDimensions,
                                           @NotNull
                                           Set<Dimension> metricDimensions,
                                           @NotNull
                                           Set<String> metricNames,
                                           @NotNull
                                           Set<Dimension> allDimensions,
                                           @NotNull
                                           Set<String> allDimensionNames,
                                           @NotNull
                                           Set<String> allColumnNames,
                                           @NotNull
                                           ApiFilters apiFilters)

Deprecated. "allDimensions", "allDimensionNames", and "allColumnNames" can be generated by other arguments. Use DataSourceConstraint(Set, Set, Set, Set, ApiFilters) instead, which saves caller argument-passing efforts.

Constructor.

Parameters:

requestDimensions - Dimensions contained in request

filterDimensions - Filtered dimensions

metricDimensions - Metric related dimensions

metricNames - Names of metrics

allDimensions - Set of all dimension objects

allDimensionNames - Set of all dimension names

allColumnNames - Set of all column names

apiFilters - Map of dimension to its set of API filters

DataSourceConstraint

protected DataSourceConstraint(DataSourceConstraint dataSourceConstraint)

Copy Constructor.

Parameters:

dataSourceConstraint - The data source constraint to copy from

Method Detail

getRequestDimensions

public Set<Dimension> getRequestDimensions()

getFilterDimensions

public Set<Dimension> getFilterDimensions()

getMetricDimensions

public Set<Dimension> getMetricDimensions()

getMetricNames

public Set<String> getMetricNames()

getAllDimensions

public Set<Dimension> getAllDimensions()

getAllDimensionNames

public Set<String> getAllDimensionNames()

getAllColumnNames

public Set<String> getAllColumnNames()

getApiFilters

public ApiFilters getApiFilters()

withMetricIntersection

public DataSourceConstraint withMetricIntersection(Set<String> metricNames)

Create a new DataSourceConstraint instance with a new subset of metric names.

The new set of metric names will be an intersection between old metric names and a user provided set of metric names

Parameters:

metricNames - The set of metric names that are to be intersected with metric names in this DataSourceConstraint

Returns:

the new DataSourceConstraint instance with a new subset of metric names

unconstrained

public static DataSourceConstraint unconstrained(PhysicalTable table)

Build a constraint which should not filter away any part of a given table.

Parameters:

table - The table whose dimensions and metrics are to be queried

Returns:

a constraint which should provide no restrictions

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object