org.lsst.ccs.description

Class ComponentLookupService

java.lang.Object

org.lsst.ccs.description.ComponentLookupService

public class ComponentLookupService
extends Object

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

Author:

bamade

Constructor Summary

Constructors

Constructor and Description
ComponentLookupService(EffectiveNode top)

Method Summary

Modifier and Type	Method and Description
<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.
String	getFullPathFor(String componentName)
Map.Entry<String,Object>	getParent(String componentName) gets the Parent of a component in the EffectiveNode tree.
<T> List<T>	listChildren(String parentName, Class<T> klass) lists the children of a component.
void	proceduralNodeWalk(String startingNodeName, Consumer<EffectiveNode> pre, Consumer<EffectiveNode> post) Tree walking starting from the top node.
<T> void	proceduralWalk(String startingNodeName, Class<T> klass, Consumer<T> pre, Consumer<T> post) Tree walking starting from the top node.
<T> void	treeWalk(String startingNodeName, Class<T> klass, Function<T,TreeWalkerDiag> func, Consumer<T> post) Walks the components tree recursively, applying rules of TreeWalkerDiag (the walk can be interrupted by HANDLING_CHILDREN (the code is not invoked on children) or STOP (the code abruptly ends).

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentLookupService

public ComponentLookupService(EffectiveNode top)

Method Detail

getComponentByName

public 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:

getChildren

public <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

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

lists the children of a component.

Type Parameters:

T -

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 EffectiveNode tree. The parent of the top node is named _EDEN_ and has a null value.

Parameters:

componentName -

Returns:

getFullPathFor

public String getFullPathFor(String componentName)

proceduralWalk

public <T> void proceduralWalk(String startingNodeName,
                               Class<T> klass,
                               Consumer<T> pre,
                               Consumer<T> post)

Tree walking starting from the top node. If the class of the node's inner object is assignable to the specified class, the pre and post consumers are applied to it.

Type Parameters:

T -

Parameters:

startingNodeName - the name of the node to start the procedure from.

klass -

pre - the procedure to apply in pre order

post - the procedure to apply in post order

proceduralNodeWalk

public void proceduralNodeWalk(String startingNodeName,
                               Consumer<EffectiveNode> pre,
                               Consumer<EffectiveNode> post)

Tree walking starting from the top node. Consumers are targeted to the node itself.

Parameters:

startingNodeName -

pre -

post -

treeWalk

public <T> void treeWalk(String startingNodeName,
                         Class<T> klass,
                         Function<T,TreeWalkerDiag> func,
                         Consumer<T> post)

Walks the components tree recursively, applying rules of TreeWalkerDiag (the walk can be interrupted by HANDLING_CHILDREN (the code is not invoked on children) or STOP (the code abruptly ends). REVIEW : proceduralWalk and proceduralNodeWalk are particular cases of treeWalk.

Type Parameters:

T -

Parameters:

startingNodeName -

klass -

func -

post -