Package com.storedobject.chart

Class GraphData.Node

java.lang.Object

com.storedobject.chart.GraphData.Node

All Implemented Interfaces:

ComponentPart, ComponentProperty

Direct Known Subclasses:

GraphData.ValueNode, GraphData.XYNode

Enclosing class:

GraphData<N extends GraphData.Node>

public abstract static class GraphData.Node
extends Object
implements ComponentPart

The abstract class Node serves as the base class for components within a graph structure. It represents a single node entity that can be connected to other nodes via edges and contains functionality to manage its own metadata and relationships. This class ensures each node has a unique identifier, a name, a category, and a list of edges. Nodes can be connected to other nodes and can serialize themselves into JSON format.

Author:

Syam

Field Summary

Fields

Modifier and Type	Field	Description
protected String	name

Constructor Summary

Constructors

Constructor	Description
Node()

Method Summary

Modifier and Type	Method	Description
GraphData.Edge	connectTo(GraphData.Node target)	Connects the current node to the specified target node by creating an edge between them.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
GraphData.Category	getCategory()	Retrieves the category associated with this node.
final long	getId()	Each part should have a unique Id.
final String	getName()	Retrieves the name of the node.
int	getSerial()	Get the current serial number (Serial number used for internal purposes only).
void	setCategory(GraphData.Category category)	Sets the category associated with this node.
void	setName(String name)	Sets the name of this node.
void	setSerial(int serial)	Set a serial number (Serial number used for internal purposes only).
final Stream<GraphData.Edge>	streamEdges()	Streams the edges associated with this node as a Stream.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getRenderingIndex, setRenderingIndex

Field Details

name

protected String name

Constructor Details

Node

public Node()

Method Details

getCategory

public GraphData.Category getCategory()

Retrieves the category associated with this node.

Returns:

The category of this node.

setCategory

public void setCategory(GraphData.Category category)

Sets the category associated with this node.

Parameters:

category - The category to be associated with this node.

connectTo

public GraphData.Edge connectTo(GraphData.Node target)

Connects the current node to the specified target node by creating an edge between them. If an edge already exists between the current node and the target node, it is returned. Otherwise, a new edge is created, added to the current node's list of edges, and returned.

Parameters:

target - The target node to which a connection is to be established. May not be null.

Returns:

The Edge object representing the connection to the target node, or null if the target node is null.

getName

public final String getName()

Retrieves the name of the node.

Specified by:

getName in interface ComponentPart

Returns:

the name of the node as a String.

setName

public void setName(String name)

Sets the name of this node.

Specified by:

setName in interface ComponentPart

Parameters:

name - The name to be set for this node.

getId

public final long getId()

Description copied from interface: ComponentPart

Each part should have a unique Id. (It can be a final variable and can be set by calling ID.newID().

Specified by:

getId in interface ComponentPart

Returns:

Unique Id.

setSerial

public void setSerial(int serial)

Description copied from interface: ComponentPart

Set a serial number (Serial number used for internal purposes only). The implementation of this method must be in such a way that the serial number set here must be returned by the ComponentPart.getSerial() method.

Specified by:

setSerial in interface ComponentPart

Parameters:

serial - Serial number to set.

getSerial

public int getSerial()

Description copied from interface: ComponentPart

Get the current serial number (Serial number used for internal purposes only). The serial number set by the ComponentPart.setSerial(int) method should be returned by this method.

Specified by:

getSerial in interface ComponentPart

Returns:

Current serial number.

validate

public void validate()
              throws ChartException

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Throws:

ChartException - Raises exception if the component or part is not valid.

streamEdges

public final Stream<GraphData.Edge> streamEdges()

Streams the edges associated with this node as a Stream.

Returns:

A Stream of Edge objects representing the edges of this node.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Parameters:

sb - Encoded JSON string to be appended to this.