Bridges-Java-2.3.3  2.3.3
Bridges(JavaAPI)
Public Member Functions | List of all members
bridges.base.CircDLelement< E > Class Template Reference

This class can be used to instantiate Circular Doubly Linked List Elements. More...

Inheritance diagram for bridges.base.CircDLelement< E >:
bridges.base.DLelement< E > bridges.base.SLelement< E > bridges.base.Element< E > bridges.base.DataStruct

Public Member Functions

 CircDLelement ()
 
 CircDLelement (String label, E e)
 
 CircDLelement (CircDLelement< E > next, CircDLelement< E > prev)
 
 CircDLelement (E e, CircDLelement< E > next, CircDLelement< E > prev)
 
String getDataStructType ()
 
CircDLelement< E > getNext ()
 
CircDLelement< E > getPrev ()
 
- Public Member Functions inherited from bridges.base.DLelement< E >
 DLelement ()
 
 DLelement (String label, E e)
 
 DLelement (DLelement< E > next, DLelement< E > prev)
 
 DLelement (E e, DLelement< E > next, DLelement< E > prev)
 
String getDataStructType ()
 
DLelement< E > getNext ()
 
DLelement< E > getPrev ()
 
void setPrev (DLelement< E > prv)
 
String getDataStructureRepresentation ()
 
- Public Member Functions inherited from bridges.base.SLelement< E >
 SLelement ()
 
 SLelement (String label, E e)
 
 SLelement (E e, SLelement< E > next)
 
 SLelement (E e)
 
 SLelement (SLelement< E > next)
 
String getDataStructType ()
 
SLelement< E > getNext ()
 
void setNext (SLelement< E > next)
 
String toString ()
 
String getDataStructureRepresentation ()
 
- Public Member Functions inherited from bridges.base.Element< E >
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)
 
getValue ()
 
void setValue (E value)
 
String toString ()
 
- Public Member Functions inherited from bridges.base.DataStruct
abstract String getDataStructType ()
 

Additional Inherited Members

- Protected Member Functions inherited from bridges.base.SLelement< E >
void getListElements (Vector< Element< E >> nodes)
 
- Protected Member Functions inherited from bridges.base.Element< E >
void setLinkVisualizer (Element< E > el)
 
void removeLinkVisualizer (Element< E > el)
 
void validateVal (E value)
 
- Protected Attributes inherited from bridges.base.DLelement< E >
DLelement< E > prev
 
- Protected Attributes inherited from bridges.base.SLelement< E >
SLelement< E > next = null
 
- Protected Attributes inherited from bridges.base.DataStruct
String QUOTE = "\""
 

Detailed Description

This class can be used to instantiate Circular Doubly Linked List Elements.

Structurally they are the same as doubly linked elements except that each node constructed with the next and the previous pointers points to itself.

User's implementation of the circularly linked list needs to ensure that the last node's next pointer points to the first node and the first node's previous pointer points to the last node, as the visualization generation is dependent on this.

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 the element and its previous or next nodes.

Author
Kalpathi Subramanian
Date
7/17/16, 1/16/17
Parameters
<E>the generic parameter object that contains application specific data, defined by the user when instantiating this object.
See also
Example Tutorial at
http://bridgesuncc.github.io/Hello_World_Tutorials/CDLL.html

Constructor & Destructor Documentation

Constructs an empty CircDLelement with next and prev pointers set to itself

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

Constructs a CircDLelement labeled "label", holding an object "e", with next and prev pointers set to itself

Parameters
labelthe label for this CircDLelement that shows up on the Bridges visualization
ethe genereic object that this CircDLelement is holding

Constructs an empty DLelement with the next pointer set to the CircDLelement "next" and the prev pointer set to CircDLelement "prev".

Parameters
nextthe DLelement that should be assigned to the next pointer
prevthe DLelement that should be assigned to the prev pointer
bridges.base.CircDLelement< E >.CircDLelement ( e,
CircDLelement< E >  next,
CircDLelement< E >  prev 
)

Constructs a DLelement holding an object "e", with the next pointer set to the DLelement "next" and the prev pointer set to DLelement "prev".

Parameters
ethe generic object that this CircDLelement is holding
nextthe CircDLelement that should be assigned to the next pointer
prevthe CircDLelement that should be assigned to the prev pointer

Member Function Documentation

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

This method gets the data structure type

Returns
The date structure type as a string

This method returns the pointer to the next DLelement

Returns
the DLelement assigned to the next pointer

This method returns the pointer to the previous DLelement

Returns
the DLelement assigned to the prev pointer

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