org.lsst.gruth.jutils

Class ComponentNode<T extends ComponentNode<T>>

java.lang.Object

org.lsst.gruth.jutils.ComponentNode<T>

All Implemented Interfaces:

Serializable, TreeNode

Direct Known Subclasses:

DescriptiveNode, EffectiveNode

public class ComponentNode<T extends ComponentNode<T>>
extends Object
implements Serializable, TreeNode

A node for a tree.

Author:

bamade

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map	attributes for a DescriptiveNode the description of parameters not used for EffectiveNode (but might be with a copy of parameters description)
protected ComponentNode	calls a node containing special subnodes that describe method calls to be operated later on object value (may be changed to a special structure)
protected ArrayList<T>	children
protected String	key the key of the node
protected String	name todo: righ now key and name should be the same ..
protected IndirectMap<String,Object>	nodeDict A dictionary of all nodes in the tree.
protected boolean	orphan indicate if this node is waiting for connection to a tree.
protected T	parent
protected Object	realValue for DescriptiveNode the Class of the future object (or an ImplPlaceHolder) for an EffectiveNode the actual object
protected boolean	root indicates if this is a root node
protected String	simpleDescription

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComponentNode(IndirectMap<String,Object> registry, Object name, String key, Map attributes, Object value) this constructor to be used by EffectiveNode (does not use checkDict!)
	ComponentNode(T parent, Object name)
	ComponentNode(T parent, Object name, Map attributes)
	ComponentNode(T parent, Object name, Map attributes, Object value)
	ComponentNode(T parent, Object name, Object value)

Method Summary

Modifier and Type	Method and Description
void	addChild(T child) adds a ComponentNode as a child of the current node
Object	calls(Object callDescription) a ComponentNode might have a "calls" method which takes a Closure as parameter.
protected void	checkDict(T parent, Object name, Map attributes) prepare the setDict call Beware should be used only in top-down build of the tree
Enumeration	children()
Iterator<String>	getAllKeys()
Iterable<String>	getAllNames()
boolean	getAllowsChildren()
Map	getAttributes()
ComponentNode	getCalls()
TreeNode	getChildAt(int childIndex)
int	getChildCount()
ArrayList<T>	getChildren()
int	getIndex(TreeNode node)
Object	getIndirect(Object key)
String	getKey()
String	getName()
Object	getNodeByName(String name)
IndirectMap	getNodeDict()
T	getParent()
Object	getRealValue()
String	getSimpleDescription()
boolean	isLeaf()
boolean	isOrphan()
boolean	isRoot()
ComponentNode	setCalls(ComponentNode callsNode)
protected void	setDict(IndirectMap<String,Object> registry, Object name, Map attributes) set the dictionary of the node and set the entry of this Node in the Dictionary
void	setNodeDict(IndirectMap<String,Object> registry) Deprecated.
void	setRoot(boolean isRoot)
void	setSimpleDescription(String simpleDescription)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

nodeDict

protected IndirectMap<String,Object> nodeDict

A dictionary of all nodes in the tree. name duplications should be detected

root

protected boolean root

indicates if this is a root node

orphan

protected boolean orphan

indicate if this node is waiting for connection to a tree.

calls

protected ComponentNode calls

a node containing special subnodes that describe method calls to be operated later on object value (may be changed to a special structure)

key

protected String key

the key of the node

parent

protected T extends ComponentNode<T> parent

children

protected ArrayList<T extends ComponentNode<T>> children

name

protected String name

todo: righ now key and name should be the same .. if separate one must change the use of the dictionary

simpleDescription

protected String simpleDescription

realValue

protected Object realValue

for DescriptiveNode the Class of the future object (or an ImplPlaceHolder) for an EffectiveNode the actual object

attributes

protected Map attributes

for a DescriptiveNode the description of parameters not used for EffectiveNode (but might be with a copy of parameters description)

Constructor Detail

ComponentNode

public ComponentNode(T parent,
                     Object name)

ComponentNode

public ComponentNode(T parent,
                     Object name,
                     Object value)

ComponentNode

public ComponentNode(T parent,
                     Object name,
                     Map attributes)

ComponentNode

public ComponentNode(T parent,
                     Object name,
                     Map attributes,
                     Object value)

ComponentNode

protected ComponentNode(IndirectMap<String,Object> registry,
                        Object name,
                        String key,
                        Map attributes,
                        Object value)

this constructor to be used by EffectiveNode (does not use checkDict!)

Parameters:

registry -

name -

key -

attributes -

value -

Method Detail

getNodeDict

public IndirectMap getNodeDict()

setNodeDict

@Deprecated
public void setNodeDict(IndirectMap<String,Object> registry)

Deprecated.

checkDict

protected void checkDict(T parent,
                         Object name,
                         Map attributes)

prepare the setDict call Beware should be used only in top-down build of the tree

Parameters:

parent -

name -

attributes -

setDict

protected void setDict(IndirectMap<String,Object> registry,
                       Object name,
                       Map attributes)

set the dictionary of the node and set the entry of this Node in the Dictionary

Parameters:

registry -

name -

attributes -

calls

public Object calls(Object callDescription)

a ComponentNode might have a "calls" method which takes a Closure as parameter.

Parameters:

callDescription -

Returns:

setCalls

public ComponentNode setCalls(ComponentNode callsNode)

isRoot

public boolean isRoot()

setRoot

public void setRoot(boolean isRoot)

isOrphan

public boolean isOrphan()

getCalls

public ComponentNode getCalls()

getName

public String getName()

getSimpleDescription

public String getSimpleDescription()

setSimpleDescription

public void setSimpleDescription(String simpleDescription)

getRealValue

public Object getRealValue()

getNodeByName

public Object getNodeByName(String name)

getIndirect

public Object getIndirect(Object key)

getAllKeys

public Iterator<String> getAllKeys()

getAllNames

public Iterable<String> getAllNames()

getAttributes

public Map getAttributes()

getKey

public String getKey()

getChildren

public ArrayList<T> getChildren()

Returns:

the list of child nodes, null if there aren't any

addChild

public void addChild(T child)
              throws NullPointerException

adds a ComponentNode as a child of the current node

Parameters:

child - to be added to the node

Throws:

NullPointerException - if child is null

toString

public String toString()

Overrides:

toString in class Object

getChildAt

public TreeNode getChildAt(int childIndex)

Specified by:

getChildAt in interface TreeNode

getChildCount

public int getChildCount()

Specified by:

getChildCount in interface TreeNode

getParent

public T getParent()

Specified by:

getParent in interface TreeNode

getIndex

public int getIndex(TreeNode node)

Specified by:

getIndex in interface TreeNode

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

isLeaf

public boolean isLeaf()

Specified by:

isLeaf in interface TreeNode

children

public Enumeration children()

Specified by:

children in interface TreeNode