org.lsst.ccs.command

Class DictionariesTree

java.lang.Object

org.lsst.ccs.command.DictionariesTree

All Implemented Interfaces:

Iterable<DictionaryContext>

public class DictionariesTree
extends Object
implements Iterable<DictionaryContext>

Client codes can receive a complete Tree of DictionaryContext from a Subsystem. It can then build this object to read informations about available dictionaries.

Author:

bamade

Constructor Summary

Constructors

Constructor and Description
DictionariesTree(org.lsst.ccs.utilities.structs.TreeBranch<DictionaryContext> topNode)

Method Summary

Methods

Modifier and Type	Method and Description
org.lsst.ccs.utilities.beanutils.Optional<Dictionary>	getDictionaryFor(String componentName) gets a Dictionary linked to a Component.
TreeNode	getNodeFor(String componentName)
org.lsst.ccs.utilities.structs.TreeBranch<DictionaryContext>	getTopNode() Since the TreeBranch class is a TreeNode this method is useful for GUIs in need of a JTree.
Iterator<DictionaryContext>	iterator()
Iterator<String>	namesIterator()

Methods inherited from class java.lang.Object

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

Constructor Detail

DictionariesTree

public DictionariesTree(org.lsst.ccs.utilities.structs.TreeBranch<DictionaryContext> topNode)

Method Detail

getDictionaryFor

public org.lsst.ccs.utilities.beanutils.Optional<Dictionary> getDictionaryFor(String componentName)

gets a Dictionary linked to a Component.

Parameters:

componentName -

Returns:

an Optional Dictionary (just in case the name is wrong!)

getTopNode

public org.lsst.ccs.utilities.structs.TreeBranch<DictionaryContext> getTopNode()

Since the TreeBranch class is a TreeNode this method is useful for GUIs in need of a JTree. or for all methods that "walk" trees.
The tree has the same structure as the subsystem description file.

Returns:

getNodeFor

public TreeNode getNodeFor(String componentName)

iterator

public Iterator<DictionaryContext> iterator()

Specified by:

iterator in interface Iterable<DictionaryContext>

Returns:

all the DictionaryContext in preOrder (that is with the structure defined in the subsystem description file)

namesIterator

public Iterator<String> namesIterator()

Returns:

the names of the component of the subsystem in preOrder.