This is the main superclass in BRIDGES for deriving a number of objects used in building arrays, lists, trees and graph data structures. More...

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

Public Member Functions
String	getDataStructType ()

	Element ()

	Element (E val)

	Element (String label, E val)

	Element (Element< E > original)

String	getIdentifier ()

ElementVisualizer	getVisualizer ()

void	setVisualizer (ElementVisualizer visualizer)

LinkVisualizer	getLinkVisualizer (Element< E > el)

String	getClassName ()

int	compareTo (Element< E > e1)

boolean	equals (Element< E > e1)

String	getElementRepresentation ()

String	getLinkRepresentation (LinkVisualizer lv, String src, String dest)

String	getLabel ()

void	setLabel (String label)

String	arrangeLabel (String label, int wordNumber)

E	getValue ()

void	setValue (E value)

String	toString ()

Public Member Functions inherited from bridges.base.DataStruct
abstract String	getDataStructType ()

Protected Member Functions
void	setLinkVisualizer (Element< E > el)

void	removeLinkVisualizer (Element< E > el)

void	validateVal (E value)

Additional Inherited Members
Protected Attributes inherited from bridges.base.DataStruct
String	QUOTE = "\""

Detailed Description

This is the main superclass in BRIDGES for deriving a number of objects used in building arrays, lists, trees and graph data structures.

SLelement, DLelement, CircSLelement, CircDLelement, TreeElement, BinTreeElement, BSTElement, CircSLelement, CircDLelement, AVLTreeElement are all subclasses (see class hierarchy above). Element contains two visualizer objects (ElementVisualizer, LinkVisualizer) for specifying visual attributes for nodes and links respectively. It also contains a label that that can be displayed in BRIDGES visualizations.

All the tutorials under

http://bridgesuncc.github.io/Hello_World_Tutorials/Overview.html

illustrate examples of using different types of Element objects and how to manipulate their visual attributes.

Author: Mihai Mehedint, Kalpathi Subramanian

Parameters

generic <E> Elements are defined with an application specific generic parameter, that is defined by the user. These can be any legal Java type and manipulated using setValue()/getValue() methods. For more information on Java generics, see for example, https://docs.oracle.com/javase/tutorial/java/generics/types.html

Constructor & Destructor Documentation

bridges.base.Element< E >.Element ( )

Element constructor creates an ElementVisualizer object sets a unique identifier for the current Element normally used from subclasses

bridges.base.Element< E >.Element ( E val )

the constructor of Element

Parameters

val	generic parameter value used to construct Element

bridges.base.Element< E >.Element	(	String	label,
		E	val
	)

the constructor of Element

Parameters

label	the string that is visible on the Bridges Visualization
val	generic parameter value used to construct Element

bridges.base.Element< E >.Element ( Element< E > original )

performing deep copy of an element when needed

Parameters

original the Element that is to be copied

Member Function Documentation

String bridges.base.Element< E >.arrangeLabel	(	String	label,
		int	wordNumber
	)

This method formats the label string using a predefine pattern (DIVIDE_KEY) and replaces the pattern with the string characters hold by the INSERT_STRING global variable

Parameters

label the input label string

wordNumber in very long strings in the case where the whitespace \s is chosen as a key the wordNumber can be set to replace the whitespace with a newline character \n at a given number of words (every second or third word) The default value is 0. In most situations we want to replace all patterns found. for more complex patterns the key must be changed like so "((John) (.+?))" returns "John firstWordAfterJohn": John writes, John doe, John eats etc. (\w) matches any word (\s) one white space (\s*) zero or more white spaces, (\s+) one or more

Returns: the formatted label

int bridges.base.Element< E >.compareTo ( Element< E > e1 )

Comparison between 2 elements

Parameters

e1	the Element to compare this with

Returns: 0 if the 2 elements have the same label and the same identifier and a nonZero integer otherwise

boolean bridges.base.Element< E >.equals ( Element< E > e1 )

This method compares 2 Elements

Parameters

e1

Returns: boolean

String bridges.base.Element< E >.getClassName ( )

This method returns the name of the class

Returns: the class name "Element"

String bridges.base.Element< E >.getDataStructType ( )

String bridges.base.Element< E >.getElementRepresentation ( )

Internal code for getting the properties of the Element object. It produces (without the spaces or newlines): { "name": "Some label", "other CSS properties like color": any_JSON_value }

Returns: the encoded JSON string

String bridges.base.Element< E >.getIdentifier ( )

this method returns the element's unique identifier

Returns: the string identifier

String bridges.base.Element< E >.getLabel ( )

This method returns the existing value of the label fields

Returns: the label of the Element; the label is typically displayed on BRIDGES visualizations.

String bridges.base.Element< E >.getLinkRepresentation	(	LinkVisualizer	lv,
		String	src,
		String	dest
	)

Generate string representing the data structure of a list

Parameters

nodes the list of nodes in the list

Get the link visualizer representation, iterating through the link properties

LinkVisualizer bridges.base.Element< E >.getLinkVisualizer ( Element< E > el )

Returns the Element's link visualizer object

The link visualizer object links this element to another element, which is specified by the argument to this method. This method is typically used to set the visual attributes of the links, such as in graphs or binary tree structures.

Element el – the element terminating the link

Returns: the link visualizer

E bridges.base.Element< E >.getValue ( )

This method returns the generic parameter value held in the element.

Returns: the value

ElementVisualizer bridges.base.Element< E >.getVisualizer ( )

Returns the Element's visualizer object

Returns: the visualizer object

void bridges.base.Element< E >.removeLinkVisualizer ( Element< E > el )

protected

void bridges.base.Element< E >.setLabel ( String label )

This method sets the label

Parameters

label the label to set

void bridges.base.Element< E >.setLinkVisualizer ( Element< E > el )

protected

Sets the link from this element to a new incoming element

Parameters

el	the element to be linked to.

void bridges.base.Element< E >.setValue ( E value )

This method sets the generic parameter value for this element.

Parameters

value the value to set

void bridges.base.Element< E >.setVisualizer ( ElementVisualizer visualizer )

This method sets the visualizer object for the current element object

Parameters

visualizer the visualizer to set

String bridges.base.Element< E >.toString ( )

void bridges.base.Element< E >.validateVal ( E value )

protected

Validates the Element's value when the Element is created A non null value is expected this will be unnecessary after we modify the server

Parameters

ELement value

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

/Users/kalpathi/gr/bridges/bridges17/java/src/main/java/bridges/base/Element.java

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation