bridges.base.TreeElement< E > Class Template Reference

Inheritance diagram for bridges.base.TreeElement< E >:

Detailed Description

This class extends Element to represent general trees with arbitrary number of children.

TreeElement nodes can have an arbitrary number of child nodes(held in in a vector in the order in which they were added). The visualization of trees assumes that the children are drawn in order from left to right.

Tree Elements have labels (string) that are displayed on the visualization. Elements take an generic object E as a user defined parameter, which can be any native type or object.

Elements contain a visualizer (ElementVisualizer) object for setting visual attributes (color, shape, opacity, size), necessary for displaying them in a web browser.

Elements also have a LinkVisualizer object that is used when they are linked to another element, appropriate for setting link attributes, between parent and child nodes.

See also

Example tutorial at http://bridgesuncc.github.io/tutorials/Tree.html

Author

Kalpathi Subramanian

Date

6/22/16, 5/17/17, 7/14/19

Parameters

E	The generic parameter object that is part of this element, representing application specific data.

Public Member Functions
	TreeElement ()
	TreeElement (E e)
	TreeElement (String label, E e)
	TreeElement (TreeElement< E > left, TreeElement< E > right)
	TreeElement (E e, TreeElement< E > left, TreeElement< E > right)
String	getDataStructType ()
void	addChild (TreeElement< E > child)
int	getNumberOfChildren ()
void	setChild (int index, TreeElement< E > child)
TreeElement< E >	getChild (int index)
String	getDataStructureRepresentation ()
Public Member Functions inherited from bridges.base.Element< E >
String	getDataStructType ()
	Get the Element type name. More...
	Element ()
	Element constructor. More...
	Element (E val)
	the constructor of Element More...
	Element (String label, E val)
	Constructor of Element. More...
	Element (Element< E > original)
	performing deep copy of an element when needed More...
String	getIdentifier ()
void	setSize (double sz)
void	setColor (Color col)
Color	getColor ()
void	setOpacity (float opacity)
double	getOpacity ()
void	setShape (String aShape)
ElementVisualizer	getVisualizer ()
void	setVisualizer (ElementVisualizer visualizer)
LinkVisualizer	getLinkVisualizer (Element< E > el)
	Returns the Element's link visualizer object. More...
String	getClassName ()
int	compareTo (Element< E > e1)
boolean	equals (Element< E > e1)
String	getElementRepresentation ()
String	getDataStructureRepresentation ()
String	getLinkRepresentation (LinkVisualizer lv, String src, String dest)
String	getLabel ()
void	setLabel (String label)
E	getValue ()
void	setValue (E value)
double	getSize ()
void	setColor (String col)
	Change the element color. More...
String	getShape ()
void	setLocation (double locX, double locY)
	Set the location attributes of an element. More...
double	getLocationX ()
double	getLocationY ()
String	toString ()
Public Member Functions inherited from bridges.base.DataStruct
abstract String	getDataStructType ()
abstract String	getDataStructureRepresentation ()

Additional Inherited Members
Protected Member Functions inherited from bridges.base.Element< E >
void	setLinkVisualizer (Element< E > el)
	Sets the link from this element to a new incoming element. More...
void	removeLinkVisualizer (Element< E > el)
	Removes the link from this element to a new incoming element. More...
void	validateVal (E value)
Protected Attributes inherited from bridges.base.DataStruct
String	QUOTE = "\""

Constructor & Destructor Documentation

TreeElement() [1/5]

bridges.base.TreeElement< E >.TreeElement

(

)

Constructs an empty TreeElement with first two children set to null.

TreeElement() [2/5]

bridges.base.TreeElement< E >.TreeElement

(

E

e

)

Constructs a TreeElement holding an object "e" with first two children set to null.

Parameters

e	the generic object that TreeElement will hold

TreeElement() [3/5]

bridges.base.TreeElement< E >.TreeElement	(	String	label,
		E	e
	)

Constructs a TreeElement with label set to "label", holding an object "e".

Parameters

label	the label of TreeElement that shows up on the Bridges visualization
e	the generic object that TreeElement will hold

TreeElement() [4/5]

bridges.base.TreeElement< E >.TreeElement	(	TreeElement< E >	left,
		TreeElement< E >	right
	)

Constructs an empty TreeElement left pointer pointing to child 0 and right pointer pointing to child 1.

Parameters

left	the TreeElement to be assigned to the child 0 of this TreeElement
right	the TreeElement to be assigned to the child 1 of this TreeElement

TreeElement() [5/5]

bridges.base.TreeElement< E >.TreeElement	(	E	e,
		TreeElement< E >	left,
		TreeElement< E >	right
	)

Constructs a TreeElement holding the object "e", left pointer pointing to first child and right pointer pointing to second child

Parameters

e	the generic object that TreeElement will hold
left	the TreeElement to be assigned to the first child of this TreeElement
right	the TreeElement to be assigned to the second child of this TreeElement

Member Function Documentation

addChild()

void bridges.base.TreeElement< E >.addChild

(

TreeElement< E >

child

)

Adds a child to the node

getChild()

TreeElement<E> bridges.base.TreeElement< E >.getChild

(

int

index

)

gets a child at a particular index

Parameters

index

into the list of children

Returns

child to be returned

getDataStructType()

String bridges.base.TreeElement< E >.getDataStructType

(

)

This method gets the data structure type

Returns

The date structure type as a string

getDataStructureRepresentation()

String bridges.base.TreeElement< E >.getDataStructureRepresentation

(

)

Get hierarchical JSON of the tree representation

Returns

the JSON string

getNumberOfChildren()

int bridges.base.TreeElement< E >.getNumberOfChildren

(

)

Returns the number of children at this node

Returns

number of children

setChild()

void bridges.base.TreeElement< E >.setChild	(	int	index,
		TreeElement< E >	child
	)

adds a child to the node - will be added at the next open position

Parameters

[in]	index	which child to set
[in]	child	child to be added

---

The documentation for this class was generated from the following file:

• /home/erik/work/bridges/bridges-java/src/main/java/bridges/base/TreeElement.java