com.yahoo.bard.webservice.util

Class ScopeMap<S,K,V,T extends ScopeMap<S,K,V,T>>

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<S,K,V,T>

Type Parameters:

S - The address element type for looking up child scopes

K - The key type for the map

V - The value type for the map

T - The implementation type (used to type returns from getScope in subclasses)

All Implemented Interfaces:

Scope<S,K,V,T>, Serializable, Cloneable, Map<K,V>

Direct Known Subclasses:

MetricDictionary

public abstract class ScopeMap<S,K,V,T extends ScopeMap<S,K,V,T>>
extends DelegatingMap<K,V>
implements Scope<S,K,V,T>

ScopeMap implements Scope using a factory method to create child scopes when requested by getScope()

In general query usage, the ScopeMap representing the global scope will be passed and clients will look up the child scope which they wish to use to resolve map keys or store map keys at.

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
ScopeMap() Build a scope with no parent scope and empty children.
ScopeMap(Map<K,V> parent) Build a scope with a parent scope.

Method Summary

Modifier and Type	Method and Description
protected abstract T	factory(T scope) Used to construct child scopes.
T	getScope(List<S> scopeKeys) Resolves a child scope.
T	getScope(S... scopeKeys) Helper function converting the varargs to array.

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

ScopeMap

public ScopeMap()

Build a scope with no parent scope and empty children.

ScopeMap

public ScopeMap(Map<K,V> parent)

Build a scope with a parent scope.

Parameters:

parent - The map to delegate key lookups to

Method Detail

getScope

public T getScope(List<S> scopeKeys)

Description copied from interface: Scope

Resolves a child scope. The child scope should delegate to its parent scopes for value lookups.

Unless otherwise noted implementations should guarantee lazy initialization of child scopes.

Specified by:

getScope in interface Scope<S,K,V,T extends ScopeMap<S,K,V,T>>

Parameters:

scopeKeys - The subtree address expressed as a sequence of scopeKeys

Returns:

A scope which is a subtree of this scope.

getScope

public T getScope(S... scopeKeys)

Helper function converting the varargs to array.

Parameters:

scopeKeys - The subtree address expressed as a sequence of scopeKeys

Returns:

a scope, which is a subtree of this scope

factory

protected abstract T factory(T scope)

Used to construct child scopes.

Parameters:

scope - The parent scope for the scope being created

Returns:

A new Scope which is a child of this scope