com.yahoo.bard.webservice.data.config.table

Class PhysicalTableDefinition

java.lang.Object

com.yahoo.bard.webservice.data.config.table.PhysicalTableDefinition

Direct Known Subclasses:

ConcretePhysicalTableDefinition, DimensionListPartitionTableDefinition, MetricUnionCompositeTableDefinition

public abstract class PhysicalTableDefinition
extends Object

Common configurations necessary to build a physical table.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PhysicalTableDefinition(TableName name, ZonedTimeGrain timeGrain, Set<FieldName> metricNames, Set<? extends DimensionConfig> dimensionConfigs) Constructor for sub-class to call.
protected	PhysicalTableDefinition(TableName name, ZonedTimeGrain timeGrain, Set<FieldName> metricNames, Set<? extends DimensionConfig> dimensionConfigs, Map<String,String> logicalToPhysicalNames) Constructor with provided logical to physical name mapping.

Method Summary

Modifier and Type	Method and Description
abstract ConfigPhysicalTable	build(ResourceDictionaries dictionaries, DataSourceMetadataService metadataService) Given the resource dictionaries and a data source metadata service, build the corresponding physical table.
protected Set<Column>	buildColumns(DimensionDictionary dimensionDictionary) Helper method for sub-classes to convert dimension configs into dimension columns and create metric columns.
protected Map<String,String>	buildLogicalToPhysicalNames(Set<? extends DimensionConfig> dimensionConfigs) Builds the dimension logical name to physical name mapping from dimension configs.
abstract Set<TableName>	getDependentTableNames() Get the set of physical tables required to build the current physical table.
Set<? extends DimensionConfig>	getDimensionConfigs()
Map<String,String>	getLogicalToPhysicalNames()
Set<FieldName>	getMetricNames()
TableName	getName()
ZonedTimeGrain	getTimeGrain()

Methods inherited from class java.lang.Object

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

Constructor Detail

PhysicalTableDefinition

protected PhysicalTableDefinition(TableName name,
                                  ZonedTimeGrain timeGrain,
                                  Set<FieldName> metricNames,
                                  Set<? extends DimensionConfig> dimensionConfigs)

Constructor for sub-class to call.

Parameters:

name - Table name of the physical table

timeGrain - Zoned time grain of the table

metricNames - The Set of metric names on the table

dimensionConfigs - Set of dimensions on the table as dimension configs

PhysicalTableDefinition

protected PhysicalTableDefinition(TableName name,
                                  ZonedTimeGrain timeGrain,
                                  Set<FieldName> metricNames,
                                  Set<? extends DimensionConfig> dimensionConfigs,
                                  Map<String,String> logicalToPhysicalNames)

Constructor with provided logical to physical name mapping.

Parameters:

name - Table name of the physical table

timeGrain - Zoned time grain of the table

metricNames - The Set of metric names on the table

dimensionConfigs - Set of dimensions on the table as dimension configs

logicalToPhysicalNames - A map from logical column names to physical column names

Method Detail

getDependentTableNames

public abstract Set<TableName> getDependentTableNames()

Get the set of physical tables required to build the current physical table.

Returns:

a set of physical table names

build

public abstract ConfigPhysicalTable build(ResourceDictionaries dictionaries,
                                          DataSourceMetadataService metadataService)

Given the resource dictionaries and a data source metadata service, build the corresponding physical table.

Parameters:

dictionaries - Dictionary containing dimension dictionary and physical table dictionary

metadataService - Service containing column available interval information

Returns:

the type of physical table which was built.

getName

public TableName getName()

getTimeGrain

public ZonedTimeGrain getTimeGrain()

getMetricNames

public Set<FieldName> getMetricNames()

getDimensionConfigs

public Set<? extends DimensionConfig> getDimensionConfigs()

getLogicalToPhysicalNames

public Map<String,String> getLogicalToPhysicalNames()

buildLogicalToPhysicalNames

protected Map<String,String> buildLogicalToPhysicalNames(Set<? extends DimensionConfig> dimensionConfigs)

Builds the dimension logical name to physical name mapping from dimension configs.

Parameters:

dimensionConfigs - Dimension config containing both logical and physical names

Returns:

the dimension logical name to physical name mapping

buildColumns

protected Set<Column> buildColumns(DimensionDictionary dimensionDictionary)

Helper method for sub-classes to convert dimension configs into dimension columns and create metric columns.

Parameters:

dimensionDictionary - Dictionary for dimension name to dimension columns

Returns:

all columns including dimension columns and metric columns