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

Class DefaultKeyValueStoreDimensionConfig

java.lang.Object

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

All Implemented Interfaces:

DimensionConfig

Direct Known Subclasses:

DefaultLookupDimensionConfig, DefaultRegisteredLookupDimensionConfig

public class DefaultKeyValueStoreDimensionConfig
extends Object
implements DimensionConfig

A Default Key Value Store Dimension holds all of the information needed to construct a Dimension.

Constructor Summary

Constructors

Constructor and Description
DefaultKeyValueStoreDimensionConfig(DimensionName apiName, String physicalName, String description, String longName, String category, LinkedHashSet<DimensionField> fields, KeyValueStore keyValueStore, SearchProvider searchProvider) Construct a DefaultKeyValueStoreDimensionConfig instance from dimension name and only using default dimension fields.
DefaultKeyValueStoreDimensionConfig(DimensionName apiName, String physicalName, String description, String longName, String category, LinkedHashSet<DimensionField> fields, LinkedHashSet<DimensionField> defaultDimensionFields, KeyValueStore keyValueStore, SearchProvider searchProvider) Construct a DefaultKeyValueStoreDimensionConfig instance from dimension name, dimension fields and default dimension fields.

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.

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.data.config.dimension.DimensionConfig

getType, isAggregatable

Constructor Detail

DefaultKeyValueStoreDimensionConfig

public DefaultKeyValueStoreDimensionConfig(@NotNull
                                           DimensionName apiName,
                                           String physicalName,
                                           String description,
                                           String longName,
                                           String category,
                                           @NotNull
                                           LinkedHashSet<DimensionField> fields,
                                           @NotNull
                                           LinkedHashSet<DimensionField> defaultDimensionFields,
                                           @NotNull
                                           KeyValueStore keyValueStore,
                                           @NotNull
                                           SearchProvider searchProvider)

Construct a DefaultKeyValueStoreDimensionConfig instance from dimension name, dimension fields and default dimension fields.

Parameters:

apiName - The API Name is the external, end-user-facing name for the dimension.

physicalName - The internal, physical name for the dimension.

description - A description of the dimension and its meaning.

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

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

fields - The set of fields for this dimension.

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

keyValueStore - The key value store holding dimension row data.

searchProvider - The search provider for field value lookups on this dimension.

DefaultKeyValueStoreDimensionConfig

public DefaultKeyValueStoreDimensionConfig(@NotNull
                                           DimensionName apiName,
                                           String physicalName,
                                           String description,
                                           String longName,
                                           String category,
                                           @NotNull
                                           LinkedHashSet<DimensionField> fields,
                                           @NotNull
                                           KeyValueStore keyValueStore,
                                           @NotNull
                                           SearchProvider searchProvider)

Construct a DefaultKeyValueStoreDimensionConfig instance from dimension name and only using default dimension fields.

Parameters:

apiName - The API Name is the external, end-user-facing name for the dimension.

physicalName - The internal, physical name for the dimension.

description - A description of the dimension and its meaning.

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

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

fields - The set of fields for this dimension, this set of field will also be used for the default fields.

keyValueStore - The key value store holding dimension row data.

searchProvider - The search provider for field value lookups on this dimension.

Method Detail

getApiName

public String getApiName()

Description copied from interface: DimensionConfig

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

Specified by:

getApiName in interface DimensionConfig

Returns:

User facing name for this dimension

getLongName

public String getLongName()

Description copied from interface: DimensionConfig

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

Specified by:

getLongName in interface DimensionConfig

Returns:

User facing long name for this dimension

getCategory

public String getCategory()

Description copied from interface: DimensionConfig

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

Specified by:

getCategory in interface DimensionConfig

Returns:

User facing category for this dimension

getPhysicalName

public String getPhysicalName()

Description copied from interface: DimensionConfig

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

Specified by:

getPhysicalName in interface DimensionConfig

Returns:

The name of the druid dimension

getDescription

public String getDescription()

Description copied from interface: DimensionConfig

The description for this dimension.

Specified by:

getDescription in interface DimensionConfig

Returns:

A description of the dimension and its meaning

getFields

public LinkedHashSet<DimensionField> getFields()

Description copied from interface: DimensionConfig

The set of fields for this dimension.

Specified by:

getFields in interface DimensionConfig

Returns:

The set of all dimension fields for this dimension

getDefaultDimensionFields

public LinkedHashSet<DimensionField> getDefaultDimensionFields()

Description copied from interface: DimensionConfig

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

Specified by:

getDefaultDimensionFields in interface DimensionConfig

Returns:

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

getKeyValueStore

public KeyValueStore getKeyValueStore()

Description copied from interface: DimensionConfig

The key value store holding dimension row data.

Specified by:

getKeyValueStore in interface DimensionConfig

Returns:

The store for this dimension

getSearchProvider

public SearchProvider getSearchProvider()

Description copied from interface: DimensionConfig

The search provider for field value lookups on this dimension.

Specified by:

getSearchProvider in interface DimensionConfig

Returns:

The SearchProvider for this dimension