org.eth.cyril.graphdrawing.graph.sequence

Class RewindableGraphSequence

java.lang.Object

org.eth.cyril.graphdrawing.graph.sequence.RewindableGraphSequence

public class RewindableGraphSequence
extends java.lang.Object

A sequence of graphs which can be rewinded and forwarded. Add graphs to this sequence to support loading them again in a later stage.

Constructor Summary

Constructors

Constructor and Description
RewindableGraphSequence()
RewindableGraphSequence(int maxCapacity)

Method Summary

Modifier and Type	Method and Description
void	addNewGraph(Graph graph, DrawingFrame frame) Add a new graph and drawing frame to the sequence.
void	addSequenceChangeListener(java.util.function.Consumer<RewindableGraphSequence> listener)
DrawingFrame	getCurrentFrame() Get the current drawing frame.
Graph	getCurrentGraph() Get the current graph.
boolean	hasNext() Whether this sequence has a next graph to forward to.
boolean	hasPrevious() Whether this sequence has a previous graph to rewind to.
boolean	isEmpty() Returns whether this sequence is empty.
void	next() Set to the next graph.
void	previous() Set to the previous graph.
void	removeSequenceChangeListener(java.util.function.Consumer<RewindableGraphSequence> listener) Add a listener to be notified about changes to the sequence's content and current position.

Methods inherited from class java.lang.Object

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

Constructor Detail

RewindableGraphSequence

public RewindableGraphSequence(int maxCapacity)

RewindableGraphSequence

public RewindableGraphSequence()

Method Detail

isEmpty

public boolean isEmpty()

Returns whether this sequence is empty. If it is empty, then there is no current graph.

hasNext

public boolean hasNext()

Whether this sequence has a next graph to forward to.

next

public void next()

Set to the next graph. Note that you must get the current graph and drawing frame manually, using the getCurrentFrame() and getCurrentGraph() functions.

hasPrevious

public boolean hasPrevious()

Whether this sequence has a previous graph to rewind to.

previous

public void previous()

Set to the previous graph. Note that you must get the current graph and drawing frame manually, using the getCurrentFrame() and getCurrentGraph() functions.

addNewGraph

public void addNewGraph(Graph graph,
                        DrawingFrame frame)

Add a new graph and drawing frame to the sequence. Before adding the new graph and frame, the sequence is forwarded to the last position, to keep the order of graphs intact.

Parameters:

graph - The new graph to add.

frame - The new drawing frame to add.

getCurrentGraph

public Graph getCurrentGraph()

Get the current graph. Returns null iff the sequence is empty. See isEmpty().

getCurrentFrame

public DrawingFrame getCurrentFrame()

Get the current drawing frame. Returns null iff the sequence is empty. See isEmpty().

addSequenceChangeListener

public void addSequenceChangeListener(java.util.function.Consumer<RewindableGraphSequence> listener)

removeSequenceChangeListener

public void removeSequenceChangeListener(java.util.function.Consumer<RewindableGraphSequence> listener)

Add a listener to be notified about changes to the sequence's content and current position.

Parameters:

listener - A listener which is notified when the sequence changes.