com.yahoo.bard.webservice.data.dimension

Class DimensionDictionary

java.lang.Object

com.yahoo.bard.webservice.data.dimension.DimensionDictionary

@Singleton
public class DimensionDictionary
extends Object

Dimension dictionary.

Constructor Summary

Constructors

Constructor and Description
DimensionDictionary() Constructor.
DimensionDictionary(Set<Dimension> dimensions) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(Dimension dimension) Adds the specified element to the dictionary if it is not already present.
boolean	addAll(Collection<? extends Dimension> dimensions) Adds all of the dimensions in the specified collection to the dictionary.
boolean	equals(Object obj)
Set<Dimension>	findAll() Get all dimensions available in dimension dictionary.
Dimension	findByApiName(String dimensionName) Find a Dimension given a dimension api name.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DimensionDictionary

public DimensionDictionary()

Constructor.

DimensionDictionary

public DimensionDictionary(Set<Dimension> dimensions)

Constructor.

Parameters:

dimensions - Set of Dimension values to add

Method Detail

findByApiName

public Dimension findByApiName(String dimensionName)

Find a Dimension given a dimension api name.

Parameters:

dimensionName - API name to search

Returns:

the first dimension found (if exists)

findAll

public Set<Dimension> findAll()

Get all dimensions available in dimension dictionary.

Returns:

a set of dimensions

add

public boolean add(Dimension dimension)

Adds the specified element to the dictionary if it is not already present.

Parameters:

dimension - element to add to dictionary

Returns:

true if the dictionary did not already contain the specified dimension

See Also:

Set.add(Object)

addAll

public boolean addAll(Collection<? extends Dimension> dimensions)

Adds all of the dimensions in the specified collection to the dictionary.

Parameters:

dimensions - collection of dimensions to add

Returns:

true if the dictionary changed as a result of the call

See Also:

Set.addAll(Collection)

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object