com.yahoo.bard.webservice.data.metric

Class MetricDictionary

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<K,V>

com.yahoo.bard.webservice.util.DelegatingMap<K,V>

com.yahoo.bard.webservice.util.ScopeMap<String,String,LogicalMetric,MetricDictionary>

com.yahoo.bard.webservice.data.metric.MetricDictionary

All Implemented Interfaces:

Scope<String,String,LogicalMetric,MetricDictionary>, Serializable, Cloneable, Map<String,LogicalMetric>

@Singleton
public class MetricDictionary
extends ScopeMap<String,String,LogicalMetric,MetricDictionary>

Map of MetricName to LogicalMetric. Metric Dictionary supports metric configuration as well as providing metric definitions at query resolution time.

 At configuration time metrics are loaded into the metric dictionary, global by default:
      globalMetricDictionary.add(LogicalMetric)
 or for metrics within a single level of scope named "scope", either:
      globalMetricDictionary.putScope("scope", logicalMetric.getName(), logicalMetric)
 or
      MetricDictionary scopedDictionary = globalMetricDictionary.getScope("scope")
      scopedDictionary.add(logicalMetric)

 With more than one scope of nesting use:
      MetricDictionary scopedDictionary = globalMetricDictionary.getScope("scope1").getScope("scope2")
 or
      scopedDictionary = metricDictionary.getScope("scopeOuter", "scopeMiddle", "scopeInner")

 At queryTime: with scope "scope":
   metricDictionary =  metricDictionary.get("scope")
   LogicalMetric lm = metricDictionary.get("key")

 will return values in both "scope" and in global scope.
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MetricDictionary() Create a metric dictionary with global scope.

Method Summary

Modifier and Type	Method and Description
boolean	add(LogicalMetric logicalMetric) Add a logical metric to the dictionary.
protected MetricDictionary	factory(MetricDictionary scope) Used to construct child scopes.

Methods inherited from class com.yahoo.bard.webservice.util.ScopeMap

getScope, getScope

Methods inherited from class com.yahoo.bard.webservice.util.DelegatingMap

clear, clearLocal, containsKey, containsValue, entrySet, equals, flatView, get, hashCode, keySet, put, remove, removeLocal, size, values

Methods inherited from class java.util.LinkedHashMap

forEach, getOrDefault, removeEldestEntry, replaceAll

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace

Methods inherited from class java.util.AbstractMap

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.bard.webservice.util.Scope

putScope

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

MetricDictionary

public MetricDictionary()

Create a metric dictionary with global scope.

Method Detail

add

public boolean add(LogicalMetric logicalMetric)

Add a logical metric to the dictionary.

Parameters:

logicalMetric - Logical metric to add

Returns:

True if the Logical Metric did not exist in the dictionary before, false if it did

factory

protected MetricDictionary factory(MetricDictionary scope)

Description copied from class: ScopeMap

Used to construct child scopes.

Specified by:

factory in class ScopeMap<String,String,LogicalMetric,MetricDictionary>

Parameters:

scope - The parent scope for the scope being created

Returns:

A new Scope which is a child of this scope