org.lsst.ccs.description

Class ComponentLookup

java.lang.Object

org.lsst.ccs.description.ComponentLookup

public class ComponentLookup
extends Object

This class helps find component of the subsystem as they are defined in the description "tree".

Author:

The LSST CCS Team. TO-DO: Allow to add components programmatically with a path TO-DO: Should be possible to close this lookup, preventing further nodes from being added. Or add listeners. Once a component lookup is added to a subsystem it should not be possible to add more components.

Constructor Summary

Constructors

Constructor and Description
ComponentLookup(ComponentNode top)
ComponentLookup(String name, Object topObject)

Method Summary

Modifier and Type	Method and Description
boolean	containsComponent(Object obj)
<N> LinkedHashMap<String,N>	getChildren(String parentName, Class<N> classFilter) gets the children of a Component in the ComponentNode and filters by Class.
Object	getComponentByName(String name) return any object registered by the componentNodeDictionaries of the service.
String	getFullPathFor(String componentName)
String	getNameOfComponent(Object obj)
ComponentNode	getNodeByName(String name)
Map.Entry<String,Object>	getParent(String componentName) gets the Parent of a component in the ComponentNode tree.
ComponentNode	getTopComponentNode() Get the top ComponentNode, ie the tip of the tree structure.
<Q> List<Q>	listChildren(String parentName, Class<Q> klass) lists the children of a component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ComponentLookup

public ComponentLookup(String name,
                       Object topObject)

ComponentLookup

public ComponentLookup(ComponentNode top)

Method Detail

getTopComponentNode

public ComponentNode getTopComponentNode()

Get the top ComponentNode, ie the tip of the tree structure.

Returns:

The top ComponentNode.

getComponentByName

public Object getComponentByName(String name)

return any object registered by the componentNodeDictionaries of the service.

Parameters:

name -

Returns:

getNodeByName

public ComponentNode getNodeByName(String name)

getNameOfComponent

public String getNameOfComponent(Object obj)

getChildren

public <N> LinkedHashMap<String,N> getChildren(String parentName,
                                               Class<N> classFilter)

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

Type Parameters:

N - the type of node

Parameters:

parentName -

classFilter -

Returns:

listChildren

public <Q> List<Q> listChildren(String parentName,
                                Class<Q> klass)

lists the children of a component.

Type Parameters:

Q - the type of node

Parameters:

parentName -

klass -

Returns:

an empty list if there are no children

getParent

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

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

Parameters:

componentName -

Returns:

getFullPathFor

public String getFullPathFor(String componentName)

containsComponent

public boolean containsComponent(Object obj)