org.lsst.ccs.framework

Interface ComponentLookupService

All Known Implementing Classes:

NodeLookup

public interface ComponentLookupService

This interface helps find component of the susbsystem as they are defined in the description "tree"

Author:

bamade

Field Summary

Fields

Modifier and Type	Field and Description
static LinkedHashMap	EMPTY
static ComponentLookupService	NONE a default component Lookup service that does not do anything

Method Summary

Modifier and Type	Method and Description
void	aliasObject(String alias, Object component) adds an object to a key.
<T> LinkedHashMap<String,T>	getChildren(String parentName, Class<T> classFilter) gets the children of a Component in the EffectiveNode and filters by Class.
Object	getComponentByName(String name) return any object registered by the dictionaries of the service.
Map.Entry<String,Object>	getParent(String componentName) gets the Parent of a component in the EffectiveNode tree.
<T> List<T>	listChildren(String parentName) lists the children of a component.

Field Detail

EMPTY

static final LinkedHashMap EMPTY

NONE

static final ComponentLookupService NONE

a default component Lookup service that does not do anything

Method Detail

getComponentByName

Object getComponentByName(String name)

return any object registered by the dictionaries of the service. Though most are Configurable objects of the corresponding EffectiveNode In some case a use can register other objects through the alias method method

Parameters:

name -

Returns:

aliasObject

void aliasObject(String alias,
                 Object component)

adds an object to a key. implementors should ensure that the corresponding dictionary is different from the top dictionary of the EffectiveNode.

Parameters:

alias -

component -

getChildren

<T> LinkedHashMap<String,T> getChildren(String parentName,
                                        Class<T> classFilter)

gets the children of a Component in the EffectiveNode and filters by Class. BEWARE: the map should be a LinkedHashMap!

Type Parameters:

T -

Parameters:

parentName -

classFilter -

Returns:

listChildren

<T> List<T> listChildren(String parentName)

lists the children of a component.

Type Parameters:

T -

Parameters:

parentName -

Returns:

an empty list if there are no children

getParent

Map.Entry<String,Object> getParent(String componentName)

gets the Parent of a component in the EffectiveNode tree. The parent of the top node is named _EDEN_ and has a null value.

Parameters:

componentName -

Returns: