Package com.storedobject.chart

Class SankeyData

java.lang.Object

java.util.AbstractCollection<SankeyData.Node>

java.util.AbstractList<SankeyData.Node>

java.util.ArrayList<SankeyData.Node>

com.storedobject.chart.AbstractData<SankeyData.Node>

com.storedobject.chart.SankeyData

All Implemented Interfaces:

AbstractDataProvider<SankeyData.Node>, ComponentPart, ComponentProperty, SankeyDataProvider, Serializable, Cloneable, Iterable<SankeyData.Node>, Collection<SankeyData.Node>, List<SankeyData.Node>, RandomAccess, SequencedCollection<SankeyData.Node>

public class SankeyData
extends AbstractData<SankeyData.Node>
implements SankeyDataProvider

A concrete implementation of SankeyDataProvider as an ArrayList of SankeyData.Nodes. It detects duplicate SankeyData.Nodes and circular references in SankeyData.Edges.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SankeyData.Edge	Class that defines an edge between 2 Sankey nodes.
static class	SankeyData.Node	Sankey data node class.

Nested classes/interfaces inherited from interface com.storedobject.chart.AbstractDataProvider

AbstractDataProvider.NumberComparator

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
SankeyData(SankeyData.Node... nodes)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addEdge(SankeyData.Edge edge)	Add an SankeyData.Edge.
Stream<SankeyData.Edge>	getEdges()	Get the edges.
Stream<SankeyData.Node>	getNodes()	Get the nodes.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.AbstractData

asList, getDataType, getName, getSerial, setName, setSerial, stream

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.storedobject.chart.AbstractDataProvider

create, create, encode, encodeJSON, getComparator, getId, getMax, getMin

Methods inherited from interface java.util.Collection

parallelStream, toArray

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getRenderingIndex, getSerial, setName, setRenderingIndex, setSerial

Methods inherited from interface java.util.List

containsAll, reversed

Constructor Details

SankeyData

public SankeyData(SankeyData.Node... nodes)

Constructor.

Parameters:

nodes - Nodes to be added.

Method Details

addEdge

public void addEdge(SankeyData.Edge edge)

Add an SankeyData.Edge.

Parameters:

edge - SankeyData.Edge to be added. If the SankeyData.Edge contains SankeyData.Nodes that are not part of this, it will be automatically added.

getNodes

public Stream<SankeyData.Node> getNodes()

Description copied from interface: SankeyDataProvider

Get the nodes. The stream should not contain duplicate node names.

Specified by:

getNodes in interface SankeyDataProvider

Returns:

Nodes as a stream.

getEdges

public Stream<SankeyData.Edge> getEdges()

Description copied from interface: SankeyDataProvider

Get the edges. The stream should not contain edges with circular references.

Specified by:

getEdges in interface SankeyDataProvider

Returns:

Edges as a stream.

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 AbstractDataProvider<SankeyData.Node>

Specified by:

validate in interface ComponentPart

Throws:

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