com.yahoo.bard.webservice.table

Class PhysicalTableSchema

java.lang.Object

com.yahoo.bard.webservice.table.BaseSchema

com.yahoo.bard.webservice.table.PhysicalTableSchema

All Implemented Interfaces:

Schema

public class PhysicalTableSchema
extends BaseSchema

The schema for a physical table.

Constructor Summary

Constructors

Constructor and Description
PhysicalTableSchema(ZonedTimeGrain timeGrain, Iterable<Column> columns, Map<String,String> logicalToPhysicalColumnNames) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	containsLogicalName(String logicalName) Returns true if the mapping of names is populated for this logical name.
boolean	equals(Object o)
Set<String>	getLogicalColumnNames(String physicalName) Look up all the logical column names corresponding to a physical name.
String	getPhysicalColumnName(String logicalName) Translate a logical name into a physical column name.
ZonedTimeGrain	getTimeGrain() Granularity.
int	hashCode()
String	toString()

Methods inherited from class com.yahoo.bard.webservice.table.BaseSchema

getColumnNames, getColumns, getGranularity, getMetricColumnNames

Methods inherited from class java.lang.Object

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

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

getColumn, getColumns

Constructor Detail

PhysicalTableSchema

public PhysicalTableSchema(@NotNull
                           ZonedTimeGrain timeGrain,
                           Iterable<Column> columns,
                           @NotNull
                           Map<String,String> logicalToPhysicalColumnNames)

Constructor.

Parameters:

timeGrain - The time grain for this table

columns - The columns for this table

logicalToPhysicalColumnNames - The mapping of logical column names to physical names

Method Detail

getPhysicalColumnName

public 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

getLogicalColumnNames

public Set<String> getLogicalColumnNames(String physicalName)

Look up all the logical column names corresponding to a physical name. If no translation exists (i.e. they are the same), then the physical name is returned.

Parameters:

physicalName - Physical name to lookup in physical table

Returns:

Translated physicalName if applicable

containsLogicalName

public boolean containsLogicalName(String logicalName)

Returns true if the mapping of names is populated for this logical name.

Parameters:

logicalName - the name of a metric or dimension column

Returns:

true if this table supports this column explicitly

getTimeGrain

public ZonedTimeGrain getTimeGrain()

Granularity.

Returns:

the granularity for this schema

equals

public boolean equals(Object o)

Overrides:

equals in class BaseSchema

hashCode

public int hashCode()

Overrides:

hashCode in class BaseSchema

toString

public String toString()

Overrides:

toString in class BaseSchema