com.yahoo.bard.webservice.data.dimension

Interface Dimension

All Known Subinterfaces:

ExtractionFunctionDimension

All Known Implementing Classes:

KeyValueStoreDimension, LookupDimension, RegisteredLookupDimension

public interface Dimension

Dimension interface.

ApiName must be unique to corresponding domain.

NOTE: To override the default serialization, use the @JsonSerialize on the implementing class. Using @JsonSerialize with no parameters will provide default Jackson behavior (so things such as @JsonValue will work properly) or else you can provide your own custom serializers using the same approach.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CATEGORY

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.
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.
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.

Field Detail

DEFAULT_CATEGORY

static final String DEFAULT_CATEGORY

See Also:

Constant Field Values

Method Detail

setLastUpdated

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

Setter for lastUpdated.

Parameters:

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

getApiName

String getApiName()

Getter for api name.

Returns:

apiName

getDescription

String getDescription()

Getter for description.

Returns:

description

getLastUpdated

org.joda.time.DateTime getLastUpdated()

Getter for lastUpdated.

Returns:

lastUpdated

getDimensionFields

LinkedHashSet<DimensionField> getDimensionFields()

Getter for dimension fields.

Returns:

Set of dimension fields

getDefaultDimensionFields

LinkedHashSet<DimensionField> getDefaultDimensionFields()

Getter for default dimension fields.

Returns:

Set of dimension fields

getFieldByName

DimensionField getFieldByName(String name)

Find dimension field by name.

Parameters:

name - field name

Returns:

DimensionField

Throws:

IllegalArgumentException - if this dimension does not have a field with the specified name

getSearchProvider

SearchProvider getSearchProvider()

Getter for search provider.

Returns:

search provider

addDimensionRow

void addDimensionRow(DimensionRow dimensionRow)

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

Parameters:

dimensionRow - DimensionRow to add

addAllDimensionRows

void addAllDimensionRows(Set<DimensionRow> dimensionRows)

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

Parameters:

dimensionRows - Set of DimensionRows to add

findDimensionRowByKeyValue

DimensionRow findDimensionRowByKeyValue(String value)

Get a dimension row given an id.

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

getKey

DimensionField getKey()

Get primary key field for this dimension.

Returns:

primary key field

parseDimensionRow

DimensionRow parseDimensionRow(Map<String,String> fieldNameValueMap)

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

Parameters:

fieldNameValueMap - Map of field names to values

Returns:

A DimensionRow with the schema of this Dimension

createEmptyDimensionRow

DimensionRow createEmptyDimensionRow(String keyFieldValue)

Create an empty DimensionRow for this dimension.

Parameters:

keyFieldValue - String value of the key field

Returns:

empty dimensionRow

getCategory

String getCategory()

Get the category of the dimension.

Returns:

category

getLongName

String getLongName()

Get the long name of the dimension.

Returns:

long name

getStorageStrategy

StorageStrategy getStorageStrategy()

Returns the StorageStrategy of the dimension.

Returns:

the storage strategy of the dimension.

getCardinality

int getCardinality()

Get the cardinality of the dimension.

Returns:

cardinality as an int

isAggregatable

boolean isAggregatable()

Return whether this dimension can be aggregated.

Returns:

true if this dimension is aggregatable