com.yahoo.bard.webservice.table

Interface PhysicalTable

All Superinterfaces:

Table

All Known Subinterfaces:

ConfigPhysicalTable

All Known Implementing Classes:

BaseCompositePhysicalTable, BasePhysicalTable, ConstrainedTable, MetricUnionCompositeTable, PartitionCompositeTable, PermissivePhysicalTable, SingleDataSourcePhysicalTable, SqlPhysicalTable, StrictPhysicalTable

public interface PhysicalTable
extends Table

An interface describing a fact level physical table. It may be backed by a single fact table or multiple.

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.
default SimplifiedIntervalList	getAvailableIntervals() Return a view of the available intervals.
default SimplifiedIntervalList	getAvailableIntervals(DataSourceConstraint constraint) Return a view of the available intervals for this table given a constraint.
default Set<Column>	getColumns() Deprecated. In favor of getting the columns directly from the schema
Set<DataSourceName>	getDataSourceNames() Get the names of the data sources that back this physical table.
default Set<DataSourceName>	getDataSourceNames(DataSourceConstraint constraint) Return the DataSourceName of the dataSources which back this table given a constraint.
String	getPhysicalColumnName(String logicalName) Translate a logical name into a physical column name.
PhysicalTableSchema	getSchema() The schema for this table.
org.joda.time.DateTime	getTableAlignment() Get a date time that the table will align to based on grain and available intervals.
TableName	getTableName() Deprecated. Use Table::getName instead
default ZonedTimeGrain	getTimeGrain() Deprecated. use getSchema().getTimeGrain()
default Map<Column,SimplifiedIntervalList>	mapToSchemaAvailability(Map<String,SimplifiedIntervalList> rawIntervals, PhysicalTableSchema schema) Map availabilities in schema-less columns to a Column keyed availability map for a given table.
ConstrainedTable	withConstraint(DataSourceConstraint constraint) Create a constrained copy of this table.

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

getDimensions, getName

Method Detail

getAllAvailableIntervals

Map<Column,SimplifiedIntervalList> getAllAvailableIntervals()

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

Returns:

map of column to set of available intervals

getAvailableIntervals

default SimplifiedIntervalList getAvailableIntervals()

Return a view of the available intervals.

Returns:

The widest set of intervals that the table can report on

getTableName

@Deprecated
TableName getTableName()

Deprecated. Use Table::getName instead

Get the name of the table.

Returns:

name of the table as TableName

getAvailableIntervals

default SimplifiedIntervalList getAvailableIntervals(DataSourceConstraint constraint)

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

Parameters:

constraint - The constraint which limits available intervals

Returns:

The widest set of intervals that the table can report on, given the constraints

getColumns

@Deprecated
default Set<Column> getColumns()

Deprecated. In favor of getting the columns directly from the schema

Get the columns from the schema for this physical table.

Returns:

The columns of this physical table

getDataSourceNames

Set<DataSourceName> getDataSourceNames()

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

Returns:

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

getDataSourceNames

default Set<DataSourceName> getDataSourceNames(DataSourceConstraint constraint)

Return the DataSourceName of the dataSources which back this table given a constraint.

Parameters:

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

Returns:

A set of names for backing dataSources, given the constraints

getPhysicalColumnName

String getPhysicalColumnName(String logicalName)

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.

Parameters:

logicalName - Logical name to lookup in physical table

Returns:

Translated logicalName if applicable

getSchema

PhysicalTableSchema getSchema()

Description copied from interface: Table

The schema for this table.

Specified by:

getSchema in interface Table

Returns:

a schema

getTableAlignment

org.joda.time.DateTime getTableAlignment()

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

Returns:

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

getTimeGrain

@Deprecated
default ZonedTimeGrain getTimeGrain()

Deprecated. use getSchema().getTimeGrain()

Get the time grain from granularity. Physical tables must have time zone associated time grains.

Returns:

The time grain of this physical table

withConstraint

ConstrainedTable withConstraint(DataSourceConstraint constraint)

Create a constrained copy of this table.

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

mapToSchemaAvailability

default Map<Column,SimplifiedIntervalList> mapToSchemaAvailability(Map<String,SimplifiedIntervalList> rawIntervals,
                                                                   PhysicalTableSchema schema)

Map availabilities in schema-less columns to a Column keyed availability map for a given table.

Parameters:

rawIntervals - The map of physical name to SimplifiedIntervalLists as the source availability

schema - The schema describing the columns of this table, which includes the logical -> physical mappings

Returns:

map of column to set of available intervals