Package com.storedobject.chart

Class GraphData<N extends GraphData.Node>

java.lang.Object

com.storedobject.chart.GraphData<N>

Type Parameters:

N - The type of nodes that the graph will handle.

public class GraphData<N extends GraphData.Node>
extends Object

The GraphData class represents a data structure used for managing and visualizing graph-based data. It supports operations such as adding nodes, connecting edges, and configuring various graph properties.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GraphData.Category	Represents a specific category for a chart or graphical element, extending the functionality of PointSymbol to include a category name.
static class	GraphData.Edge	Represents a directional edge between two nodes in a graph structure.
static class	GraphData.Force	Represents a force-directed layout configuration as a property of a chart component.
static enum	GraphData.Layout	The Layout enum defines various layout options that can be used for organizational or structural representation.
static class	GraphData.Node	The abstract class Node serves as the base class for components within a graph structure.
static class	GraphData.ValueNode	The ValueNode class represents a type of Node that holds a numerical value.
static class	GraphData.XYNode	A concrete implementation of the GraphData.Node class representing a node in a 2D space.

Constructor Summary

Constructors

Constructor	Description
GraphData()	Constructs a new instance of GraphData and initializes default properties.

Method Summary

Modifier and Type	Method	Description
final void	addNode(N... nodes)	Adds one or more nodes to the list of nodes if they are not null.
GraphData<N>	autoCurveness(boolean autoCurveness)	Sets whether automatic curveness is enabled or not and returns the current instance for method chaining.
GraphData<N>	center(Offset center)	Sets the center offset for the graph and returns the updated graph data instance.
final GraphData.Edge	connect(N source, N target)	Establishes a connection between a source node and a target node.
final GraphData.Edge	connectFromLastNode(N target)	Connects the last node in the current structure to the specified target node.
final GraphData.Edge	connectToLastNode(N source)	Connects the given source node to the last node in the graph.
GraphData<N>	defaultCategory(GraphData.Category defaultCategory)	Sets the default category for the graph and returns the current instance of GraphData.
GraphData<N>	draggable(boolean draggable)	Sets the draggable property of the GraphData object.
GraphData<N>	edgeEndSymbol(PointSymbol symbol)	Sets the symbol for the end of edges in the graph and returns the updated GraphData instance.
GraphData<N>	edgeStartSymbol(PointSymbol symbol)	Sets the start symbol for edges in the graph.
GraphData<N>	force(GraphData.Force force)	Sets the force layout configuration for the graph data.
Offset	getCenter(boolean createIfNotExist)	Retrieves the center offset configuration for this object.
GraphData.Category	getDefaultCategory()	Retrieves the default category associated with the graph data.
final PointSymbol	getEdgeEndSymbol()	Retrieves the symbol representing the end of an edge in the graph.
final PointSymbol	getEdgeStartSymbol()	Returns the symbol representing the start of an edge in the graph.
final N	getFirstNode()	Retrieves the first node from the list of nodes.
GraphData.Force	getForce(boolean createIfNotExist)	Retrieves the instance of the Force object.
final N	getLastNode()	Retrieves the last node in the list.
GraphData.Layout	getLayout()	Retrieves the layout configuration for the graph.
final N	getNode(int index)	Retrieves the node at the specified index from the collection of nodes.
final N	getNode(String name)	Retrieves the node with the specified name from the collection of nodes.
TextLabel	getTextLabel()	Retrieves the TextLabel associated with this instance of the class.
boolean	isAutoCurveness()	Determines whether the auto-curveness feature is enabled.
boolean	isDraggable()	Checks whether the object is draggable or not.
boolean	isRoam()	Checks whether roaming is enabled.
GraphData<N>	layout(GraphData.Layout layout)	Sets the layout type for the graph data and returns the updated instance.
final GraphData<N>	node(N... nodes)	Adds one or more nodes to the graph and returns the updated graph data.
final int	nodeCount()	Returns the total number of nodes present.
final Stream<N>	nodes()	Provides a sequential Stream of nodes contained in the current collection.
GraphData<N>	roam(boolean roam)	Sets whether roaming is enabled or disabled for the graph data.
void	setAutoCurveness(boolean autoCurveness)	Sets whether the curveness of edges in the graph should be automatically determined.
void	setCenter(Offset center)	Sets the center offset for the graph data.
void	setDefaultCategory(GraphData.Category defaultCategory)	Sets the default category for the graph data.
void	setDraggable(boolean draggable)	Sets whether the graph is draggable or not.
void	setEdgeEndSymbol(PointSymbol symbol)	Sets the symbol used to represent the end of an edge in the graph.
void	setForce(GraphData.Force force)	Sets the Force configuration for the graph layout.
void	setLayout(GraphData.Layout layout)	Sets the layout for the graph.
void	setRoam(boolean roam)	Sets whether the graph is in roam mode or not.
void	setTextLabel(TextLabel textLabel)	Sets the text label associated with this GraphData object.

Methods inherited from class java.lang.Object

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

Constructor Details

GraphData

public GraphData()

Constructs a new instance of GraphData and initializes default properties. Specifically, the default category's size is set to 10 during construction.

Method Details

getDefaultCategory

public GraphData.Category getDefaultCategory()

Retrieves the default category associated with the graph data.

Returns:

The default Category instance.

defaultCategory

public GraphData<N> defaultCategory(GraphData.Category defaultCategory)

Sets the default category for the graph and returns the current instance of GraphData.

Parameters:

defaultCategory - The default category to be set. If null, a default category with the name "Default" will be created and set.

Returns:

The current GraphData<N> instance with the updated default category.

setDefaultCategory

public void setDefaultCategory(GraphData.Category defaultCategory)

Sets the default category for the graph data. If the provided category is null, a new category named "Default" will be assigned.

Parameters:

defaultCategory - The category to set as default. If null, a default category with the name "Default" is created.

getTextLabel

public TextLabel getTextLabel()

Retrieves the TextLabel associated with this instance of the class.

Returns:

The TextLabel object representing the textual label configuration.

setTextLabel

public void setTextLabel(TextLabel textLabel)

Sets the text label associated with this GraphData object.

Parameters:

textLabel - the TextLabel object to set

setCenter

public void setCenter(Offset center)

Sets the center offset for the graph data.

Parameters:

center - The center position specified as an Offset object containing x and y coordinates.

center

public GraphData<N> center(Offset center)

Sets the center offset for the graph and returns the updated graph data instance.

Parameters:

center - The Offset object representing the x and y center offsets to be applied.

Returns:

The current GraphData instance with the updated center offset.

getCenter

public Offset getCenter(boolean createIfNotExist)

Retrieves the center offset configuration for this object. If the center has not been initialized and the parameter createIfNotExist is true, a new Offset instance will be created and assigned.

Parameters:

createIfNotExist - If true and the center is not already initialized, a new Offset will be created.

Returns:

The current Offset instance representing the center, or a new one if created.

setLayout

public void setLayout(GraphData.Layout layout)

Sets the layout for the graph.

Parameters:

layout - The layout to set. Possible values are FORCE, CIRCULAR, or NONE.

layout

public GraphData<N> layout(GraphData.Layout layout)

Sets the layout type for the graph data and returns the updated instance.

Parameters:

layout - The layout type to be set for the graph. Possible values include GraphData.Layout.FORCE, GraphData.Layout.CIRCULAR, and GraphData.Layout.NONE.

Returns:

The updated instance of GraphData<N> with the specified layout.

getLayout

public GraphData.Layout getLayout()

Retrieves the layout configuration for the graph.

Returns:

The current layout configuration of the graph, which determines the arrangement of elements such as nodes and edges in the graph.

setRoam

public void setRoam(boolean roam)

Sets whether the graph is in roam mode or not.

Parameters:

roam - A boolean value indicating if roam mode should be enabled (true) or disabled (false).

roam

public GraphData<N> roam(boolean roam)

Sets whether roaming is enabled or disabled for the graph data.

Parameters:

roam - A boolean value indicating if roaming is enabled (true) or disabled (false).

Returns:

The current instance of GraphData for method chaining.

isRoam

public boolean isRoam()

Checks whether roaming is enabled.

Returns:

true if roaming is enabled, false otherwise.

getForce

public GraphData.Force getForce(boolean createIfNotExist)

Retrieves the instance of the Force object. If the instance does not exist and createIfNotExist is true, a new Force object is created and returned.

Parameters:

createIfNotExist - A boolean value indicating whether to create a new Force instance if it does not already exist.

Returns:

The Force instance. Returns null if the instance does not exist and createIfNotExist is false.

force

public GraphData<N> force(GraphData.Force force)

Sets the force layout configuration for the graph data.

Parameters:

force - The GraphData.Force object containing the configuration parameters of the force layout.

Returns:

The current instance of GraphData<N> for method chaining.

setForce

public void setForce(GraphData.Force force)

Sets the Force configuration for the graph layout.

Parameters:

force - the Force instance containing the configuration settings for the graph's physical simulation.

setAutoCurveness

public void setAutoCurveness(boolean autoCurveness)

Sets whether the curveness of edges in the graph should be automatically determined.

Parameters:

autoCurveness - A boolean value indicating whether auto-curveness is enabled or not. If true, the curveness of edges will be automatically adjusted; if false, no automatic adjustment will be applied.

autoCurveness

public GraphData<N> autoCurveness(boolean autoCurveness)

Sets whether automatic curveness is enabled or not and returns the current instance for method chaining.

Parameters:

autoCurveness - true to enable automatic curveness, false to disable it.

Returns:

The current instance of GraphData<N>.

isAutoCurveness

public boolean isAutoCurveness()

Determines whether the auto-curveness feature is enabled.

Returns:

true if auto-curveness is enabled, false otherwise.

setDraggable

public void setDraggable(boolean draggable)

Sets whether the graph is draggable or not.

Parameters:

draggable - true to enable dragging, false to disable it.

draggable

public GraphData<N> draggable(boolean draggable)

Sets the draggable property of the GraphData object.

Parameters:

draggable - determines whether the graph data elements are draggable. If true, the elements can be dragged; otherwise, they cannot.

Returns:

the updated GraphData object with the modified draggable property.

isDraggable

public boolean isDraggable()

Checks whether the object is draggable or not.

Returns:

true if the object is draggable, false otherwise

getEdgeStartSymbol

public final PointSymbol getEdgeStartSymbol()

Returns the symbol representing the start of an edge in the graph.

Returns:

the symbol representing the start of an edge as a PointSymbol object

edgeStartSymbol

public GraphData<N> edgeStartSymbol(PointSymbol symbol)

Sets the start symbol for edges in the graph. If the provided symbol is null, a default symbol of type NONE will be used.

Parameters:

symbol - the PointSymbol to set as the start symbol for edges. If null, a default symbol with type NONE is used.

Returns:

the current GraphData<N> instance for method chaining.

getEdgeEndSymbol

public final PointSymbol getEdgeEndSymbol()

Retrieves the symbol representing the end of an edge in the graph.

Returns:

the PointSymbol object representing the edge's end symbol.

edgeEndSymbol

public GraphData<N> edgeEndSymbol(PointSymbol symbol)

Sets the symbol for the end of edges in the graph and returns the updated GraphData instance. If the provided symbol is null, a default point symbol with type NONE is used.

Parameters:

symbol - the PointSymbol to set for the edge end; if null, a default symbol with type NONE is used

Returns:

the updated GraphData instance

setEdgeEndSymbol

public void setEdgeEndSymbol(PointSymbol symbol)

Sets the symbol used to represent the end of an edge in the graph. If the provided symbol is null, it defaults to a symbol of type PointSymbolType.NONE.

Parameters:

symbol - the PointSymbol to set as the edge end symbol, or null to reset to the default symbol

addNode

@SafeVarargs
public final void addNode(N... nodes)

Adds one or more nodes to the list of nodes if they are not null.

Parameters:

nodes - the nodes to be added. Each node is checked for null before being added to the list.

node

@SafeVarargs
public final GraphData<N> node(N... nodes)

Adds one or more nodes to the graph and returns the updated graph data.

Parameters:

nodes - the nodes to be added to the graph

Returns:

the updated graph data instance after adding the nodes

connect

public final GraphData.Edge connect(N source,
 N target)

Establishes a connection between a source node and a target node.

Parameters:

source - the source node to connect from

target - the target node to connect to

Returns:

the created Edge representing the connection between the source and target nodes

connectFromLastNode

public final GraphData.Edge connectFromLastNode(N target)

Connects the last node in the current structure to the specified target node.

Parameters:

target - the target node to connect to the last node

Returns:

the edge created between the last node and the target node, or null if there is no last node

connectToLastNode

public final GraphData.Edge connectToLastNode(N source)

Connects the given source node to the last node in the graph.

Parameters:

source - the source node to be connected to the last node

Returns:

the edge created by connecting the source node to the last node, or null if there is no last node available

getLastNode

public final N getLastNode()

Retrieves the last node in the list.

Returns:

the last node if the list is not empty, or null if the list is empty

getFirstNode

public final N getFirstNode()

Retrieves the first node from the list of nodes.

Returns:

the first node if the list is not empty; otherwise, returns null

getNode

public final N getNode(int index)

Retrieves the node at the specified index from the collection of nodes.

Parameters:

index - the index of the node to retrieve, must be within the bounds of the nodes collection

Returns:

the node at the specified index if the index is valid; otherwise, returns null

getNode

public final N getNode(String name)

Retrieves the node with the specified name from the collection of nodes.

Parameters:

name - the name of the node to retrieve; must not be null

Returns:

the node with the specified name if found, otherwise null

nodeCount

public final int nodeCount()

Returns the total number of nodes present.

Returns:

the count of nodes as an integer

nodes

public final Stream<N> nodes()

Provides a sequential Stream of nodes contained in the current collection.

Returns:

a Stream containing all nodes in the collection