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)

Method Summary

Modifier and Type	Method and Description
void	addComponentNodeToLookup(String name, ComponentNode node)
boolean	containsComponent(Object obj)
boolean	containsComponentName(String name) Check if the ComponentLookup already contains a ComponentNode for a given name.
<N> Map<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) Returns the path of a component in the tree of components.
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.
<N> List<N>	listDescendants(String parentName, Class<N> classFilter) Finds all the children of the given class in the sub-tree starting at the node named parentName

Methods inherited from class java.lang.Object

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

Constructor Detail

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.

addComponentNodeToLookup

public void addComponentNodeToLookup(String name,
                                     ComponentNode node)

Parameters:

name - the parent name.

node -

getComponentByName

public Object getComponentByName(String name)

return any object registered by the componentNodeDictionaries of the service.

Parameters:

name -

Returns:

containsComponentName

public boolean containsComponentName(String name)

Check if the ComponentLookup already contains a ComponentNode for a given name.

Parameters:

name - The name of the ComponentNode

Returns:

true/false True if it exists, false otherwise.

getNodeByName

public ComponentNode getNodeByName(String name)

getNameOfComponent

public String getNameOfComponent(Object obj)

getChildren

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

gets the children of a Component in the ComponentNode and filters by Class.

Type Parameters:

N - the type of node

Parameters:

parentName -

classFilter - the class filter. Any class if set to null

Returns:

the children of parentName, mapped by their name. The returned map does not preserved the order in which nodes were inserted in the component node

listDescendants

public <N> List<N> listDescendants(String parentName,
                                   Class<N> classFilter)

Finds all the children of the given class in the sub-tree starting at the node named parentName

Type Parameters:

N -

Parameters:

parentName - the name of the node to start getting the children from. If set to null, the whole component tree is tested against the filter, even the top node.

classFilter - the class filter. Any class if set to null

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.

Parameters:

componentName -

Returns:

getFullPathFor

public String getFullPathFor(String componentName)

Returns the path of a component in the tree of components.

Parameters:

componentName -

Returns:

containsComponent

public boolean containsComponent(Object obj)