com.yahoo.bard.webservice.util

Class DimensionStoreKeyUtils

java.lang.Object

com.yahoo.bard.webservice.util.DimensionStoreKeyUtils

public class DimensionStoreKeyUtils
extends Object

Provider for magic strings used in dimension keystore key generation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SEPARATOR
static String	ROW_KEY_SUFFIX

Constructor Summary

Constructors

Constructor and Description
DimensionStoreKeyUtils()

Method Summary

Modifier and Type	Method and Description
static String	getAllValuesKey() Returns a key for accessing all the dimension values in a KeyValueStore.
static String	getCardinalityKey() Returns a key that, when fed into a KeyValueStore returns the cardinality of the dimensions.
static String	getColumnKey(String columnName) Returns a key that, when fed into a KeyValueStore returns the field name used by Lucene.
static String	getLastUpdatedKey()
static String	getRowKey(String fieldName, String fieldValue) Returns a key that allows access to the dimension rows of a given dimension.

Methods inherited from class java.lang.Object

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

Field Detail

ROW_KEY_SUFFIX

public static final String ROW_KEY_SUFFIX

See Also:

Constant Field Values

KEY_SEPARATOR

public static final String KEY_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

DimensionStoreKeyUtils

public DimensionStoreKeyUtils()

Method Detail

getLastUpdatedKey

public static String getLastUpdatedKey()

getAllValuesKey

public static String getAllValuesKey()

Returns a key for accessing all the dimension values in a KeyValueStore.

When this key is passed into a KeyValueStore, the KeyValueStore will return a String representation of a list of all the dimension values stored in the key value dimension store.

Returns:

A key for accessing a list of all the values in a KeyValueStore as a String.

getRowKey

public static String getRowKey(@NotNull
                               String fieldName,
                               String fieldValue)

Returns a key that allows access to the dimension rows of a given dimension.

Given a dimension field name (such as "id"), and the id of the dimension desired, returns a key. When this key is passed into the appropriate KeyValueStore, the KeyValueStore will return the metadata of the associated dimension.

Parameters:

fieldName - The dimension field name to be appended to the beginning of the key

fieldValue - The key of the dimension whose data is desired

Returns:

A key that, when passed into the appropriate KeyValueStore, will return the associated dimension value.

getColumnKey

public static String getColumnKey(String columnName)

Returns a key that, when fed into a KeyValueStore returns the field name used by Lucene.

Parameters:

columnName - The name of the column to extract from Lucene.

Returns:

A key that, when fed into a KeyValueStore, returns the ID used to query a dimension in Lucene.

getCardinalityKey

public static String getCardinalityKey()

Returns a key that, when fed into a KeyValueStore returns the cardinality of the dimensions.

Returns:

A key that, when fed into a KeyValueStore returns the cardinality of the dimensions.