com.yahoo.bard.webservice.data.dimension.metadata

Enum StorageStrategy

java.lang.Object

java.lang.Enum<StorageStrategy>

com.yahoo.bard.webservice.data.dimension.metadata.StorageStrategy

All Implemented Interfaces:

Serializable, Comparable<StorageStrategy>

public enum StorageStrategy
extends Enum<StorageStrategy>

Allows clients to be notified if a dimension's values are browsable and searchable.

For the non-loaded dimensions(A "non-loaded dimension" is a fact based dimension, where we don't load any domain data for it, but simply send queries directly to druid), we need to surface metadata to the UI. If there aren't dimension values loaded, we can't validate when we build filters and you can't use the dimension values endpoint to browse values. UI needs to know that a dimension isn't going to be validated and searched. The way that UI knows about this is through this StorageStrategy

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOADED Loaded dimension.
NONE Non-loaded dimension.

Method Summary

Modifier and Type	Method and Description
String	getApiName() Returns the API name of this StorageStrategy.
String	toString()
static StorageStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static StorageStrategy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LOADED

public static final StorageStrategy LOADED

Loaded dimension.

NONE

public static final StorageStrategy NONE

Non-loaded dimension.

Method Detail

values

public static StorageStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StorageStrategy c : StorageStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StorageStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getApiName

public String getApiName()

Returns the API name of this StorageStrategy.

Returns:

the API name of this StorageStrategy

toString

public String toString()

Overrides:

toString in class Enum<StorageStrategy>