com.yahoo.bard.webservice.table

Class ConstrainedTable

java.lang.Object

com.yahoo.bard.webservice.table.ConstrainedTable

All Implemented Interfaces:

PhysicalTable, Table

public class ConstrainedTable
extends Object
implements PhysicalTable

Constrained table caches the results of applying a DataSourceConstraint to a Physical table's availability. Since a constraint is already applied, methods that accept a constraint should be considered deprecated.

Constructor Summary

Constructors

Constructor and Description
ConstrainedTable(ConfigPhysicalTable sourceTable, DataSourceConstraint constraint) Constructor.
ConstrainedTable(ConfigPhysicalTable sourceTable, QueryPlanningConstraint queryPlanningConstraint) Constructor.

Method Summary

Modifier and Type	Method and Description
Map<Column,SimplifiedIntervalList>	getAllAvailableIntervals() Getter for all the available intervals for the corresponding columns configured on the table.
SimplifiedIntervalList	getAvailableIntervals() Return a view of the available intervals.
SimplifiedIntervalList	getAvailableIntervals(DataSourceConstraint constraint) Return a view of the available intervals for the original source table given a constraint.
Set<DataSourceName>	getDataSourceNames() Get the names of the data sources that back this physical table.
Set<DataSourceName>	getDataSourceNames(DataSourceConstraint constraint) Return the TableName of the dataSources which back the original source table given a constraint.
String	getName() The name for this table.
String	getPhysicalColumnName(String logicalName) Translate a logical name into a physical column name.
PhysicalTableSchema	getSchema() The schema for this table.
PhysicalTable	getSourceTable()
org.joda.time.DateTime	getTableAlignment() Get a date time that the table will align to based on grain and available intervals.
TableName	getTableName() Get the name of the table.
ConstrainedTable	withConstraint(DataSourceConstraint constraint) Create a constrained copy of the source table.

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.table.PhysicalTable

getColumns, getTimeGrain, mapToSchemaAvailability

Methods inherited from interface com.yahoo.bard.webservice.table.Table

getDimensions

Constructor Detail

ConstrainedTable

public ConstrainedTable(ConfigPhysicalTable sourceTable,
                        DataSourceConstraint constraint)

Constructor.

Parameters:

sourceTable - The table being constrained

constraint - The constraint being applied

ConstrainedTable

public ConstrainedTable(ConfigPhysicalTable sourceTable,
                        QueryPlanningConstraint queryPlanningConstraint)

Constructor.

Parameters:

sourceTable - The table being constrained

queryPlanningConstraint - The constraint being applied

Method Detail

getSourceTable

public PhysicalTable getSourceTable()

getAvailableIntervals

public SimplifiedIntervalList getAvailableIntervals()

Description copied from interface: PhysicalTable

Return a view of the available intervals.

Specified by:

getAvailableIntervals in interface PhysicalTable

Returns:

The widest set of intervals that the table can report on

getAllAvailableIntervals

public Map<Column,SimplifiedIntervalList> getAllAvailableIntervals()

Description copied from interface: PhysicalTable

Getter for all the available intervals for the corresponding columns configured on the table.

Specified by:

getAllAvailableIntervals in interface PhysicalTable

Returns:

map of column to set of available intervals

getDataSourceNames

public Set<DataSourceName> getDataSourceNames()

Description copied from interface: PhysicalTable

Get the names of the data sources that back this physical table.

Specified by:

getDataSourceNames in interface PhysicalTable

Returns:

the names of all data sources that back this physical table.

getName

public String getName()

Description copied from interface: Table

The name for this table.

Specified by:

getName in interface Table

Returns:

The table name

getPhysicalColumnName

public String getPhysicalColumnName(String logicalName)

Description copied from interface: PhysicalTable

Translate a logical name into a physical column name. If no translation exists (i.e. they are the same), then the logical name is returned.

NOTE: This defaulting behavior WILL BE REMOVED in future releases.

The defaulting behavior shouldn't be hit for Dimensions that are serialized via the default serializer and are not properly configured with a logical-to-physical name mapping. Dimensions that are not "normal" dimensions, such as dimensions used for DimensionSpecs in queries to do mapping from fact-level dimensions to something else, should likely use their own serialization strategy so as to not hit this defaulting behavior.

Specified by:

getPhysicalColumnName in interface PhysicalTable

Parameters:

logicalName - Logical name to lookup in physical table

Returns:

Translated logicalName if applicable

getSchema

public PhysicalTableSchema getSchema()

Description copied from interface: Table

The schema for this table.

Specified by:

getSchema in interface PhysicalTable

Specified by:

getSchema in interface Table

Returns:

a schema

getTableName

public TableName getTableName()

Description copied from interface: PhysicalTable

Get the name of the table.

Specified by:

getTableName in interface PhysicalTable

Returns:

name of the table as TableName

getTableAlignment

public org.joda.time.DateTime getTableAlignment()

Description copied from interface: PhysicalTable

Get a date time that the table will align to based on grain and available intervals.

Specified by:

getTableAlignment in interface PhysicalTable

Returns:

The time of either the first available interval of any columns in this table or now, floored to the table's time grain.

getAvailableIntervals

public SimplifiedIntervalList getAvailableIntervals(DataSourceConstraint constraint)

Return a view of the available intervals for the original source table given a constraint.

Specified by:

getAvailableIntervals in interface PhysicalTable

Parameters:

constraint - The constraint which limits available intervals

Returns:

The intervals that the table can report on

getDataSourceNames

public Set<DataSourceName> getDataSourceNames(DataSourceConstraint constraint)

Return the TableName of the dataSources which back the original source table given a constraint.

Specified by:

getDataSourceNames in interface PhysicalTable

Parameters:

constraint - A constraint which may narrow the data sources participating.

Returns:

A set of tablenames for backing dataSources

withConstraint

public ConstrainedTable withConstraint(DataSourceConstraint constraint)

Create a constrained copy of the source table.

Specified by:

withConstraint in interface PhysicalTable

Parameters:

constraint - The dataSourceConstraint which narrows the view of the underlying availability

Returns:

a constrained table whose availability and serialization are narrowed by this constraint