com.yahoo.bard.webservice.data.config.dimension

Interface DimensionConfig

All Known Subinterfaces:

LookupDimensionConfig, RegisteredLookupDimensionConfig

All Known Implementing Classes:

DefaultKeyValueStoreDimensionConfig, DefaultLookupDimensionConfig, DefaultRegisteredLookupDimensionConfig

public interface DimensionConfig

Defines the core information needed to define a dimension.

Method Summary

Modifier and Type	Method and Description
String	getApiName() The API Name is the external, end-user-facing name for the dimension.
String	getCategory() The Category is the external, end-user-facing category for the dimension.
LinkedHashSet<DimensionField>	getDefaultDimensionFields() The default set of fields for this dimension to be shown in the response.
String	getDescription() The description for this dimension.
LinkedHashSet<DimensionField>	getFields() The set of fields for this dimension.
KeyValueStore	getKeyValueStore() The key value store holding dimension row data.
String	getLongName() The Long Name is the external, end-user-facing long name for the dimension.
String	getPhysicalName() The internal, physical name for the dimension.
SearchProvider	getSearchProvider() The search provider for field value lookups on this dimension.
default Class	getType() The type of the Dimension this DimensionConfiguration is intended to build.
default boolean	isAggregatable() Return whether this dimension can be aggregated.

Method Detail

getApiName

String getApiName()

The API Name is the external, end-user-facing name for the dimension. This is the name of this dimension in API requests.

Returns:

User facing name for this dimension

getLongName

String getLongName()

The Long Name is the external, end-user-facing long name for the dimension.

Returns:

User facing long name for this dimension

getCategory

String getCategory()

The Category is the external, end-user-facing category for the dimension.

Returns:

User facing category for this dimension

getPhysicalName

String getPhysicalName()

The internal, physical name for the dimension. This field (if set) is used as the only physical name.

Returns:

The name of the druid dimension

getDescription

String getDescription()

The description for this dimension.

Returns:

A description of the dimension and its meaning

getFields

LinkedHashSet<DimensionField> getFields()

The set of fields for this dimension.

Returns:

The set of all dimension fields for this dimension

getDefaultDimensionFields

LinkedHashSet<DimensionField> getDefaultDimensionFields()

The default set of fields for this dimension to be shown in the response.

Returns:

The default set of dimension fields to be shown in the response row for this dimension

getKeyValueStore

KeyValueStore getKeyValueStore()

The key value store holding dimension row data.

Returns:

The store for this dimension

getSearchProvider

SearchProvider getSearchProvider()

The search provider for field value lookups on this dimension.

Returns:

The SearchProvider for this dimension

isAggregatable

default boolean isAggregatable()

Return whether this dimension can be aggregated. By default a dimension is aggregatable.

Returns:

true if this dimension is aggregatable.

getType

default Class getType()

The type of the Dimension this DimensionConfiguration is intended to build.

Returns:

The type of the Dimension this DimensionConfiguration is intended to build, KeyValueStoreDimension by default