com.yahoo.bard.webservice.table

Class BasePhysicalTable

java.lang.Object

com.yahoo.bard.webservice.table.BasePhysicalTable

All Implemented Interfaces:

ConfigPhysicalTable, PhysicalTable, Table

Direct Known Subclasses:

BaseCompositePhysicalTable, SingleDataSourcePhysicalTable, SqlPhysicalTable

public abstract class BasePhysicalTable
extends Object
implements ConfigPhysicalTable

Base implementation of physical table that are shared across various types of physical tables.

Constructor Summary

Constructors

Constructor and Description
BasePhysicalTable(TableName name, ZonedTimeGrain timeGrain, Iterable<Column> columns, Map<String,String> logicalToPhysicalColumnNames, Availability availability) Create a physical table.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<Column,SimplifiedIntervalList>	getAllAvailableIntervals() Getter for all the available intervals for the corresponding columns configured on the table.
Availability	getAvailability() Get the value of the backing availability instance for this physical table.
SimplifiedIntervalList	getAvailableIntervals(DataSourceConstraint constraint) Return a view of the available intervals for this table given a constraint.
Set<DataSourceName>	getDataSourceNames() Get the names of the data sources that back this physical table.
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.
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.
int	hashCode()
protected void	setAvailability(Availability availability) Deprecated. Should avoid this method and refine testing strategy to remove this method
String	toString()
ConstrainedTable	withConstraint(DataSourceConstraint constraint) Create a constrained copy of this table.

Methods inherited from class java.lang.Object

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

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

getAvailableIntervals, getColumns, getDataSourceNames, getTimeGrain, mapToSchemaAvailability

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

getDimensions

Constructor Detail

BasePhysicalTable

public BasePhysicalTable(@NotNull
                         TableName name,
                         @NotNull
                         ZonedTimeGrain timeGrain,
                         @NotNull
                         Iterable<Column> columns,
                         @NotNull
                         Map<String,String> logicalToPhysicalColumnNames,
                         @NotNull
                         Availability availability)

Create a physical table.

Parameters:

name - Fili name of the physical table

timeGrain - time grain of the table

columns - The columns for this physical table

logicalToPhysicalColumnNames - Mappings from logical to physical names

availability - The availability of columns in this table

Method Detail

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

getName

public String getName()

Description copied from interface: Table

The name for this table.

Specified by:

getName in interface Table

Returns:

The table name

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.

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

getAvailability

public Availability getAvailability()

Description copied from interface: ConfigPhysicalTable

Get the value of the backing availability instance for this physical table.

Specified by:

getAvailability in interface ConfigPhysicalTable

Returns:

The availability or a runtime exception if there isn't one.

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.

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

getAvailableIntervals

public SimplifiedIntervalList getAvailableIntervals(DataSourceConstraint constraint)

Description copied from interface: PhysicalTable

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

Specified by:

getAvailableIntervals in interface PhysicalTable

Parameters:

constraint - The constraint which limits available intervals

Returns:

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

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

setAvailability

@Deprecated
protected void setAvailability(Availability availability)

Deprecated. Should avoid this method and refine testing strategy to remove this method

Used only for testing to inject test availability data into table.

Parameters:

availability - The test availability for this table

withConstraint

public ConstrainedTable withConstraint(DataSourceConstraint constraint)

Create a constrained copy of this 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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object