com.yahoo.bard.webservice.data.dimension.impl

Class KeyValueStoreDimension

java.lang.Object

com.yahoo.bard.webservice.data.dimension.impl.KeyValueStoreDimension

All Implemented Interfaces:

Dimension

Direct Known Subclasses:

LookupDimension, RegisteredLookupDimension

public class KeyValueStoreDimension
extends Object
implements Dimension

KeyValueStoreDimension implements key value collection of DimensionRows.

Supports point lookups:

• Id -> DimensionRow

Field Summary

Fields inherited from interface com.yahoo.bard.webservice.data.dimension.Dimension

DEFAULT_CATEGORY

Constructor Summary

Constructors

Constructor and Description
KeyValueStoreDimension(DimensionConfig dimensionConfig) Constructor.
KeyValueStoreDimension(String dimensionName, String description, LinkedHashSet<DimensionField> dimensionFields, KeyValueStore keyValueStore, SearchProvider searchProvider) Constructor.
KeyValueStoreDimension(String dimensionName, String description, LinkedHashSet<DimensionField> dimensionFields, KeyValueStore keyValueStore, SearchProvider searchProvider, boolean isAggregatable) Constructor.
KeyValueStoreDimension(String dimensionName, String description, LinkedHashSet<DimensionField> dimensionFields, KeyValueStore keyValueStore, SearchProvider searchProvider, Set<DimensionRow> dimensionRows) Constructor.
KeyValueStoreDimension(String dimensionName, String longName, String category, String description, LinkedHashSet<DimensionField> dimensionFields, KeyValueStore keyValueStore, SearchProvider searchProvider, LinkedHashSet<DimensionField> defaultDimensionFields, boolean isAggregatable) Constructor.
KeyValueStoreDimension(String dimensionName, String longName, String category, String description, LinkedHashSet<DimensionField> dimensionFields, KeyValueStore keyValueStore, SearchProvider searchProvider, LinkedHashSet<DimensionField> defaultDimensionFields, boolean isAggregatable, StorageStrategy storageStrategy) Constructor.
KeyValueStoreDimension(String dimensionName, String longName, String category, String description, LinkedHashSet<DimensionField> dimensionFields, KeyValueStore keyValueStore, SearchProvider searchProvider, Set<DimensionRow> dimensionRows) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addAllDimensionRows(Set<DimensionRow> dimensionRows) Add all dimension rows to the dimension's set of rows.
void	addDimensionRow(DimensionRow dimensionRow) Add a dimension row to the dimension's set of rows.
DimensionRow	createEmptyDimensionRow(String keyFieldValue) Create an empty DimensionRow for this dimension.
void	deleteAllDimensionRows() Internal method for cleaning the dimension rows.
boolean	equals(Object o)
DimensionRow	findDimensionRowByKeyValue(String value) Get a dimension row given an id.
String	getApiName() Getter for api name.
int	getCardinality() Get the cardinality of the dimension.
String	getCategory() Get the category of the dimension.
LinkedHashSet<DimensionField>	getDefaultDimensionFields() Getter for default dimension fields.
String	getDescription() Getter for description.
LinkedHashSet<DimensionField>	getDimensionFields() Getter for dimension fields.
DimensionField	getFieldByName(String name) Find dimension field by name.
DimensionField	getKey() Get primary key field for this dimension.
org.joda.time.DateTime	getLastUpdated() Getter for lastUpdated.
String	getLongName() Get the long name of the dimension.
SearchProvider	getSearchProvider() Getter for search provider.
StorageStrategy	getStorageStrategy() Returns the StorageStrategy of the dimension.
int	hashCode()
boolean	isAggregatable() Return whether this dimension can be aggregated.
DimensionRow	parseDimensionRow(Map<String,String> fieldNameValueMap) Generate a DimensionRow for this dimension from a field name / value map.
void	setLastUpdated(org.joda.time.DateTime lastUpdated) Setter for lastUpdated.
String	toString()
KeyValueStoreDimension	withStorageStrategy(StorageStrategy storageStrategy) Constructs a new KeyValueStoreDimension with specified StorageStrategy.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueStoreDimension

public KeyValueStoreDimension(String dimensionName,
                              String longName,
                              String category,
                              String description,
                              @NotNull
                              LinkedHashSet<DimensionField> dimensionFields,
                              @NotNull
                              KeyValueStore keyValueStore,
                              SearchProvider searchProvider,
                              @NotNull
                              LinkedHashSet<DimensionField> defaultDimensionFields,
                              boolean isAggregatable,
                              StorageStrategy storageStrategy)

Constructor.

Parameters:

dimensionName - API Name of the dimension

longName - Long API Name of the dimension

category - Category of the dimension

description - Description of the dimension

dimensionFields - Metadata fields of the dimension

keyValueStore - Metadata store for the dimension

searchProvider - Search provider over the metadata for the dimension

defaultDimensionFields - Default fields for the dimension

isAggregatable - Whether the dimension is aggregatable

storageStrategy - Strategy of how dimension is loaded. See StorageStrategy

KeyValueStoreDimension

public KeyValueStoreDimension(String dimensionName,
                              String longName,
                              String category,
                              String description,
                              @NotNull
                              LinkedHashSet<DimensionField> dimensionFields,
                              @NotNull
                              KeyValueStore keyValueStore,
                              SearchProvider searchProvider,
                              @NotNull
                              LinkedHashSet<DimensionField> defaultDimensionFields,
                              boolean isAggregatable)

Constructor.

Parameters:

dimensionName - API Name of the dimension

longName - Long API Name of the dimension

category - Category of the dimension

description - Description of the dimension

dimensionFields - Metadata fields of the dimension

keyValueStore - Metadata store for the dimension

searchProvider - Search provider over the metadata for the dimension

defaultDimensionFields - Default fields for the dimension

isAggregatable - Whether the dimension is aggregatable StorageStrategy

KeyValueStoreDimension

public KeyValueStoreDimension(String dimensionName,
                              String description,
                              @NotNull
                              LinkedHashSet<DimensionField> dimensionFields,
                              @NotNull
                              KeyValueStore keyValueStore,
                              SearchProvider searchProvider)

Constructor.

It constructs an aggregatable dimension that defaults the Long Api Name to the Api Name and sets the Category to the default category.

Parameters:

dimensionName - API Name of the dimension

description - Description of the dimension

dimensionFields - Metadata fields of the dimension

keyValueStore - Metadata store for the dimension

searchProvider - Search provider over the metadata for the dimension

KeyValueStoreDimension

public KeyValueStoreDimension(String dimensionName,
                              String description,
                              @NotNull
                              LinkedHashSet<DimensionField> dimensionFields,
                              @NotNull
                              KeyValueStore keyValueStore,
                              SearchProvider searchProvider,
                              boolean isAggregatable)

Constructor.

Defaults the Long Api Name to the Api Name and sets the Category to the default category.

Parameters:

dimensionName - API Name of the dimension

description - Description of the dimension

dimensionFields - Metadata fields of the dimension

keyValueStore - Metadata store for the dimension

searchProvider - Search provider over the metadata for the dimension

isAggregatable - Whether the dimension is aggregatable

KeyValueStoreDimension

public KeyValueStoreDimension(String dimensionName,
                              String description,
                              @NotNull
                              LinkedHashSet<DimensionField> dimensionFields,
                              @NotNull
                              KeyValueStore keyValueStore,
                              SearchProvider searchProvider,
                              Set<DimensionRow> dimensionRows)

Constructor.

Build an aggregatable dimension that defaults the Long Api Name to the Api Name and sets the Category to the default category.

Parameters:

dimensionName - API Name of the dimension

description - Description of the dimension

dimensionFields - Metadata fields of the dimension

keyValueStore - Metadata store for the dimension

searchProvider - Search provider over the metadata for the dimension

dimensionRows - Dimension metadata rows for this dimension

KeyValueStoreDimension

public KeyValueStoreDimension(String dimensionName,
                              String longName,
                              String category,
                              String description,
                              @NotNull
                              LinkedHashSet<DimensionField> dimensionFields,
                              @NotNull
                              KeyValueStore keyValueStore,
                              SearchProvider searchProvider,
                              Set<DimensionRow> dimensionRows)

Constructor.

Parameters:

dimensionName - API Name of the dimension

longName - Long API Name of the dimension

category - Category of the dimension

description - Description of the dimension

dimensionFields - Metadata fields of the dimension

keyValueStore - Metadata store for the dimension

searchProvider - Search provider over the metadata for the dimension

dimensionRows - Dimension metadata rows for this dimension

KeyValueStoreDimension

public KeyValueStoreDimension(DimensionConfig dimensionConfig)

Constructor.

Parameters:

dimensionConfig - Configuration holder for this dimension

Method Detail

setLastUpdated

public void setLastUpdated(org.joda.time.DateTime lastUpdated)

Description copied from interface: Dimension

Setter for lastUpdated.

Specified by:

setLastUpdated in interface Dimension

Parameters:

lastUpdated - The date and time at which this Dimension was last updated

getApiName

public String getApiName()

Description copied from interface: Dimension

Getter for api name.

Specified by:

getApiName in interface Dimension

Returns:

apiName

getLastUpdated

public org.joda.time.DateTime getLastUpdated()

Description copied from interface: Dimension

Getter for lastUpdated.

Specified by:

getLastUpdated in interface Dimension

Returns:

lastUpdated

getDescription

public String getDescription()

Description copied from interface: Dimension

Getter for description.

Specified by:

getDescription in interface Dimension

Returns:

description

getCategory

public String getCategory()

Description copied from interface: Dimension

Get the category of the dimension.

Specified by:

getCategory in interface Dimension

Returns:

category

getLongName

public String getLongName()

Description copied from interface: Dimension

Get the long name of the dimension.

Specified by:

getLongName in interface Dimension

Returns:

long name

getStorageStrategy

public StorageStrategy getStorageStrategy()

Description copied from interface: Dimension

Returns the StorageStrategy of the dimension.

Specified by:

getStorageStrategy in interface Dimension

Returns:

the storage strategy of the dimension.

getCardinality

public int getCardinality()

Description copied from interface: Dimension

Get the cardinality of the dimension.

Specified by:

getCardinality in interface Dimension

Returns:

cardinality as an int

getDimensionFields

public LinkedHashSet<DimensionField> getDimensionFields()

Description copied from interface: Dimension

Getter for dimension fields.

Specified by:

getDimensionFields in interface Dimension

Returns:

Set of dimension fields

getDefaultDimensionFields

public LinkedHashSet<DimensionField> getDefaultDimensionFields()

Description copied from interface: Dimension

Getter for default dimension fields.

Specified by:

getDefaultDimensionFields in interface Dimension

Returns:

Set of dimension fields

getFieldByName

public DimensionField getFieldByName(String name)

Description copied from interface: Dimension

Find dimension field by name.

Specified by:

getFieldByName in interface Dimension

Parameters:

name - field name

Returns:

DimensionField

getSearchProvider

public SearchProvider getSearchProvider()

Description copied from interface: Dimension

Getter for search provider.

Specified by:

getSearchProvider in interface Dimension

Returns:

search provider

addDimensionRow

public void addDimensionRow(DimensionRow dimensionRow)

Description copied from interface: Dimension

Add a dimension row to the dimension's set of rows.

Specified by:

addDimensionRow in interface Dimension

Parameters:

dimensionRow - DimensionRow to add

addAllDimensionRows

public void addAllDimensionRows(Set<DimensionRow> dimensionRows)

Description copied from interface: Dimension

Add all dimension rows to the dimension's set of rows.

Specified by:

addAllDimensionRows in interface Dimension

Parameters:

dimensionRows - Set of DimensionRows to add

createEmptyDimensionRow

public DimensionRow createEmptyDimensionRow(String keyFieldValue)

Description copied from interface: Dimension

Create an empty DimensionRow for this dimension.

Specified by:

createEmptyDimensionRow in interface Dimension

Parameters:

keyFieldValue - String value of the key field

Returns:

empty dimensionRow

findDimensionRowByKeyValue

public DimensionRow findDimensionRowByKeyValue(String value)

Description copied from interface: Dimension

Get a dimension row given an id.

Specified by:

findDimensionRowByKeyValue in interface Dimension

Parameters:

value - key value

Returns:

a dimension row - returns the first one found if there are multiple, or null if no matching row is found

deleteAllDimensionRows

public void deleteAllDimensionRows()

Internal method for cleaning the dimension rows.

getKey

public DimensionField getKey()

Description copied from interface: Dimension

Get primary key field for this dimension.

Specified by:

getKey in interface Dimension

Returns:

primary key field

parseDimensionRow

public DimensionRow parseDimensionRow(Map<String,String> fieldNameValueMap)

Description copied from interface: Dimension

Generate a DimensionRow for this dimension from a field name / value map.

Specified by:

parseDimensionRow in interface Dimension

Parameters:

fieldNameValueMap - Map of field names to values

Returns:

A DimensionRow with the schema of this Dimension

isAggregatable

public boolean isAggregatable()

Description copied from interface: Dimension

Return whether this dimension can be aggregated.

Specified by:

isAggregatable in interface Dimension

Returns:

true if this dimension is aggregatable

withStorageStrategy

public KeyValueStoreDimension withStorageStrategy(StorageStrategy storageStrategy)

Constructs a new KeyValueStoreDimension with specified StorageStrategy.

Parameters:

storageStrategy - The specified StorageStrategy

Returns:

the new KeyValueStoreDimension with the specified StorageStrategy

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object