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

Class DefaultRegisteredLookupDimensionConfig

java.lang.Object

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

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

All Implemented Interfaces:

DimensionConfig, RegisteredLookupDimensionConfig

public class DefaultRegisteredLookupDimensionConfig
extends DefaultKeyValueStoreDimensionConfig
implements RegisteredLookupDimensionConfig

A Default Registered Lookup Dimension holds all of the information needed to construct a Registered Lookup Dimension.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<String>	getLookups() Returns a list of lookups used to configure the Lookup dimension.

Methods inherited from class com.yahoo.bard.webservice.data.config.dimension.DefaultKeyValueStoreDimensionConfig

getApiName, getCategory, getDefaultDimensionFields, getDescription, getFields, getKeyValueStore, getLongName, getPhysicalName, getSearchProvider

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

getType

Methods inherited from interface com.yahoo.bard.webservice.data.config.dimension.DimensionConfig

getApiName, getCategory, getDefaultDimensionFields, getDescription, getFields, getKeyValueStore, getLongName, getPhysicalName, getSearchProvider, isAggregatable

Constructor Detail

DefaultRegisteredLookupDimensionConfig

public DefaultRegisteredLookupDimensionConfig(@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,
                                              @NotNull
                                              List<String> lookups)

Construct a RegisteredLookupDefaultDimensionConfig 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.

lookups - A list of lookups used to configure the Lookup dimension.

DefaultRegisteredLookupDimensionConfig

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

Construct a RegisteredLookupDefaultDimensionConfig 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.

lookups - A list of lookups used to configure the Lookup dimension.

Method Detail

getLookups

public List<String> getLookups()

Description copied from interface: RegisteredLookupDimensionConfig

Returns a list of lookups used to configure the Lookup dimension.

Specified by:

getLookups in interface RegisteredLookupDimensionConfig

Returns:

List of lookups