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

Class BaseTableLoader

java.lang.Object

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

All Implemented Interfaces:

TableLoader

Direct Known Subclasses:

GenericTableLoader, WikiTableLoader

public abstract class BaseTableLoader
extends Object
implements TableLoader

Provides commonly-needed methods for loading tables.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.joda.time.DateTimeZone	defaultTimeZone

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseTableLoader(DataSourceMetadataService metadataService) A table loader using a standard time context and UTC default time zone.
protected	BaseTableLoader(org.joda.time.DateTimeZone defaultTimeZone, DataSourceMetadataService metadataService) A table loader using a time context and a default time zone.

Method Summary

Modifier and Type	Method and Description
TableGroup	buildDimensionSpanningTableGroup(Set<ApiMetricName> apiMetrics, Set<FieldName> druidMetrics, Set<PhysicalTableDefinition> tableDefinitions, ResourceDictionaries dictionaries) Deprecated. does not load table with external dependency, use the other buildDimensionSpanningTableGroup instead
TableGroup	buildDimensionSpanningTableGroup(Set<TableName> currentTableGroupTableNames, Set<PhysicalTableDefinition> tableDefinitions, ResourceDictionaries dictionaries, Set<ApiMetricName> apiMetrics) Builds a table group that derive its dimensions by taking the union of all the underlying physical dimensions.
LogicalTable	buildLogicalTable(String name, Granularity granularity, String category, String longName, org.joda.time.ReadablePeriod retention, String description, TableGroup group, MetricDictionary metrics) Deprecated. The LogicalTable constructor is being mirrored here, can be referenced directly
LogicalTable	buildLogicalTable(String name, Granularity granularity, TableGroup group, MetricDictionary metrics) Deprecated. use new LogicalTable(...) by preferences
protected ConfigPhysicalTable	buildPhysicalTableWithDependency(String currentTableName, Map<String,PhysicalTableDefinition> availableTableDefinitions, ResourceDictionaries dictionaries) Build and return the current physical table given its table name and definition, if dependency exists, build its dependencies and load the dependencies into physical table dictionary.
TableGroup	buildTableGroup(String logicalTableName, Set<ApiMetricName> apiMetrics, Set<FieldName> druidMetrics, Set<PhysicalTableDefinition> tableDefinitions, ResourceDictionaries dictionaries) Deprecated. logicalTableName is not used in TableGroup, use buildDimensionSpanningTableGroup instead
protected DataSourceMetadataService	getDataSourceMetadataService() Getter for the data source metadata service use for creating physical tables.
void	loadLogicalTablesWithGranularities(Map<String,TableGroup> nameGroupMap, Set<? extends Granularity> validGrains, LogicalTableDictionary tableDictionary, Map<String,MetricDictionary> scopedMetrics) Load several logical tables into the logicalDictionary, each with their own scoped metric dictionary.
void	loadLogicalTablesWithGranularities(Map<String,TableGroup> nameGroupMap, Set<? extends Granularity> validGrains, ResourceDictionaries dictionaries) Load several logical tables into the logicalDictionary, all with the globally-scoped metric dictionary.
void	loadLogicalTableWithGranularities(String logicalTableName, TableGroup nameGroup, Set<? extends Granularity> validGrains, LogicalTableDictionary tableDictionary, MetricDictionary metricDictionary) Load a logical table into the logicalDictionary.
void	loadLogicalTableWithGranularities(String logicalTableName, TableGroup nameGroup, Set<? extends Granularity> validGrains, ResourceDictionaries dictionaries) Load a logical table into the logicalDictionary.
protected PhysicalTable	loadPhysicalTable(PhysicalTableDefinition definition, Set<FieldName> metricNames, ResourceDictionaries dictionaries) Deprecated. use buildPhysicalTableWithDependency instead, which also supports building table with dependencies
abstract void	loadTableDictionary(ResourceDictionaries dictionaries) Load user configured tables into resource dictionary.

Methods inherited from class java.lang.Object

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

Field Detail

defaultTimeZone

protected final org.joda.time.DateTimeZone defaultTimeZone

Constructor Detail

BaseTableLoader

protected BaseTableLoader(DataSourceMetadataService metadataService)

A table loader using a standard time context and UTC default time zone.

Parameters:

metadataService - Service containing the segment data for constructing tables

BaseTableLoader

protected BaseTableLoader(org.joda.time.DateTimeZone defaultTimeZone,
                          DataSourceMetadataService metadataService)

A table loader using a time context and a default time zone.

Parameters:

defaultTimeZone - The default time zone to tables being loaded

metadataService - Service containing the segment data for constructing tables

Method Detail

loadTableDictionary

public abstract void loadTableDictionary(ResourceDictionaries dictionaries)

Load user configured tables into resource dictionary.

Specified by:

loadTableDictionary in interface TableLoader

Parameters:

dictionaries - dictionary to be loaded with configured tables

buildDimensionSpanningTableGroup

public TableGroup buildDimensionSpanningTableGroup(Set<TableName> currentTableGroupTableNames,
                                                   Set<PhysicalTableDefinition> tableDefinitions,
                                                   ResourceDictionaries dictionaries,
                                                   Set<ApiMetricName> apiMetrics)

Builds a table group that derive its dimensions by taking the union of all the underlying physical dimensions.

Builds and loads the physical tables from table definitions for the current table group.

Parameters:

currentTableGroupTableNames - Set of table name of tables belonging to this table group

tableDefinitions - A list of config objects for building physical tables and its dependent physical tables

dictionaries - The container for all the data dictionaries

apiMetrics - The set of metric names surfaced to the api

Returns:

A table group binding all the tables for a logical table view together.

loadLogicalTablesWithGranularities

public void loadLogicalTablesWithGranularities(Map<String,TableGroup> nameGroupMap,
                                               Set<? extends Granularity> validGrains,
                                               ResourceDictionaries dictionaries)

Load several logical tables into the logicalDictionary, all with the globally-scoped metric dictionary.

Note: This builds the logical tables as well.

Parameters:

nameGroupMap - A map of logical table name to table group information

validGrains - The accepted grains for the logical table

dictionaries - The resource dictionaries for reading and storing configuration

loadLogicalTablesWithGranularities

public void loadLogicalTablesWithGranularities(Map<String,TableGroup> nameGroupMap,
                                               Set<? extends Granularity> validGrains,
                                               LogicalTableDictionary tableDictionary,
                                               Map<String,MetricDictionary> scopedMetrics)

Load several logical tables into the logicalDictionary, each with their own scoped metric dictionary.

Note: This builds the logical tables as well.

Parameters:

nameGroupMap - A map of logical table name to table group information

validGrains - The accepted grains for the logical table

tableDictionary - The logical table dictionary to be populated

scopedMetrics - A mapping from table name to the scoped MetricDictionary to use for that table

loadLogicalTableWithGranularities

public void loadLogicalTableWithGranularities(String logicalTableName,
                                              TableGroup nameGroup,
                                              Set<? extends Granularity> validGrains,
                                              ResourceDictionaries dictionaries)

Load a logical table into the logicalDictionary.

Note: This builds the logical table as well.

Parameters:

logicalTableName - The logical table name

nameGroup - The table group information for the logical table

validGrains - The accepted grains for the logical table

dictionaries - The resource dictionaries for reading and storing configuration

loadLogicalTableWithGranularities

public void loadLogicalTableWithGranularities(String logicalTableName,
                                              TableGroup nameGroup,
                                              Set<? extends Granularity> validGrains,
                                              LogicalTableDictionary tableDictionary,
                                              MetricDictionary metricDictionary)

Load a logical table into the logicalDictionary.

Note: This builds the logical table as well.

Parameters:

logicalTableName - The logical table name

nameGroup - The table group information for the logical table

validGrains - The accepted grains for the logical table

tableDictionary - The dictionary to load the logical table into

metricDictionary - The dictionary to use when looking up metrics for this table

buildPhysicalTableWithDependency

protected ConfigPhysicalTable buildPhysicalTableWithDependency(String currentTableName,
                                                               Map<String,PhysicalTableDefinition> availableTableDefinitions,
                                                               ResourceDictionaries dictionaries)

Build and return the current physical table given its table name and definition, if dependency exists, build its dependencies and load the dependencies into physical table dictionary.

note: current physical table not loaded into physical table dictionary, only dependencies will

Parameters:

currentTableName - Table name of the table being built

availableTableDefinitions - A map of table name to table definition that are available globally

dictionaries - Contains both dimension and physical table dictionary for building and dependency resolution

Returns:

the current physical table built from table definitions

getDataSourceMetadataService

protected DataSourceMetadataService getDataSourceMetadataService()

Getter for the data source metadata service use for creating physical tables.

Returns:

the data source metadata service associated with the table loader

loadPhysicalTable

@Deprecated
protected PhysicalTable loadPhysicalTable(PhysicalTableDefinition definition,
                                                      Set<FieldName> metricNames,
                                                      ResourceDictionaries dictionaries)

Deprecated. use buildPhysicalTableWithDependency instead, which also supports building table with dependencies

Load a new physical table into the dictionary and return the loaded physical table.

Parameters:

definition - A config object for the physical table

metricNames - The Set of metric names on the table

dictionaries - The resource dictionaries for reading and storing resource data

Returns:

The physical table created

buildDimensionSpanningTableGroup

@Deprecated
public TableGroup buildDimensionSpanningTableGroup(Set<ApiMetricName> apiMetrics,
                                                               Set<FieldName> druidMetrics,
                                                               Set<PhysicalTableDefinition> tableDefinitions,
                                                               ResourceDictionaries dictionaries)

Deprecated. does not load table with external dependency, use the other buildDimensionSpanningTableGroup instead

Builds a table group.

Builds and loads the physical tables for the physical table definitions as well.

Parameters:

apiMetrics - The set of metric names surfaced to the api

druidMetrics - Names of druid datasource metric columns

tableDefinitions - A list of config objects for physical tables

dictionaries - The container for all the data dictionaries

Returns:

A table group binding all the tables for a logical table view together.

buildLogicalTable

@Deprecated
public LogicalTable buildLogicalTable(String name,
                                                  Granularity granularity,
                                                  TableGroup group,
                                                  MetricDictionary metrics)

Deprecated. use new LogicalTable(...) by preferences

Build a logical table, supplying it with a name, grain, table group, and metrics, the default category and longName set to the name.

Note: This builds a logical table with all valid metrics for the grain of the table

Parameters:

name - The name for this logical table

granularity - The granularity for this logical table

group - The group of physical tables for this logical table

metrics - The dictionary of all metrics

Returns:

The logical table built

buildLogicalTable

@Deprecated
public LogicalTable buildLogicalTable(String name,
                                                  Granularity granularity,
                                                  String category,
                                                  String longName,
                                                  org.joda.time.ReadablePeriod retention,
                                                  String description,
                                                  TableGroup group,
                                                  MetricDictionary metrics)

Deprecated. The LogicalTable constructor is being mirrored here, can be referenced directly

Build a logical table, supplying it with a name, grain, table group, and metrics.

Note: This builds a logical table with all valid metrics for the grain of the table.

Parameters:

name - The name for this logical table

granularity - The granularity for this logical table

category - The category for this logical table

longName - The long name for this logical table

retention - The retention for this logical table

description - The description for this logical table

group - The group of physical tables for this logical table

metrics - The dictionary of all metrics

Returns:

The logical table built

buildTableGroup

@Deprecated
public TableGroup buildTableGroup(String logicalTableName,
                                              Set<ApiMetricName> apiMetrics,
                                              Set<FieldName> druidMetrics,
                                              Set<PhysicalTableDefinition> tableDefinitions,
                                              ResourceDictionaries dictionaries)

Deprecated. logicalTableName is not used in TableGroup, use buildDimensionSpanningTableGroup instead

Builds a table group.

Builds and loads the physical tables for the physical table definitions as well.

Parameters:

logicalTableName - The logical table for the table group

apiMetrics - The set of metric names surfaced to the api

druidMetrics - Names of druid datasource metric columns

tableDefinitions - A list of config objects for physical tables

dictionaries - The container for all the data dictionaries

Returns:

A table group binding all the tables for a logical table view together.