com.yahoo.bard.webservice.table

Class LogicalTable

java.lang.Object

com.yahoo.bard.webservice.table.LogicalTable

All Implemented Interfaces:

Table, Comparable<LogicalTable>

public class LogicalTable
extends Object
implements Table, Comparable<LogicalTable>

A LogicalTable has a grain and a tablegroup of physical tables that satisfy the logical table.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CATEGORY
static org.joda.time.ReadablePeriod	DEFAULT_RETENTION

Constructor Summary

Constructors

Constructor and Description
LogicalTable(String name, Granularity granularity, TableGroup tableGroup, MetricDictionary metricDictionary) Constructor
LogicalTable(String name, String category, String longName, Granularity granularity, org.joda.time.ReadablePeriod retention, String description, TableGroup tableGroup, MetricDictionary metricDictionary) Constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(LogicalTable o)
String	getCategory()
String	getDescription()
Granularity	getGranularity()
Set<LogicalMetric>	getLogicalMetrics()
String	getLongName()
String	getName() The name for this table.
org.joda.time.ReadablePeriod	getRetention()
LogicalTableSchema	getSchema() The schema for this table.
TableGroup	getTableGroup()

Methods inherited from class java.lang.Object

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

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

getDimensions

Field Detail

DEFAULT_CATEGORY

public static final String DEFAULT_CATEGORY

See Also:

Constant Field Values

DEFAULT_RETENTION

public static final org.joda.time.ReadablePeriod DEFAULT_RETENTION

Constructor Detail

LogicalTable

public LogicalTable(@NotNull
                    String name,
                    @NotNull
                    Granularity granularity,
                    TableGroup tableGroup,
                    MetricDictionary metricDictionary)

Constructor

Sets the Category and Retention to the defaults, and sets the long name and description to the name.

Parameters:

name - The logical table name

granularity - The logical table granularity

tableGroup - The tablegroup for the logical table

metricDictionary - The metric dictionary to bind tableGroup's metrics

LogicalTable

public LogicalTable(@NotNull
                    String name,
                    String category,
                    String longName,
                    @NotNull
                    Granularity granularity,
                    org.joda.time.ReadablePeriod retention,
                    String description,
                    TableGroup tableGroup,
                    MetricDictionary metricDictionary)

Constructor.

Parameters:

name - The logical table name

category - The category of the logical table

longName - The long name of the logical table

granularity - The logical table time grain

retention - The period the data in the logical table is retained for

description - The description for this logical table

tableGroup - The tablegroup for the logical table

metricDictionary - The metric dictionary to bind tableGroup's metrics

Method Detail

getTableGroup

public TableGroup getTableGroup()

getLogicalMetrics

public Set<LogicalMetric> getLogicalMetrics()

compareTo

public int compareTo(LogicalTable o)

Specified by:

compareTo in interface Comparable<LogicalTable>

getCategory

public String getCategory()

getLongName

public String getLongName()

getRetention

public org.joda.time.ReadablePeriod getRetention()

getDescription

public String getDescription()

getGranularity

public Granularity getGranularity()

getName

public String getName()

Description copied from interface: Table

The name for this table.

Specified by:

getName in interface Table

Returns:

The table name

getSchema

public LogicalTableSchema getSchema()

Description copied from interface: Table

The schema for this table.

Specified by:

getSchema in interface Table

Returns:

a schema