org.hkijena.jipipe.api.history

Class JIPipeDedicatedGraphHistoryJournal

java.lang.Object

org.hkijena.jipipe.api.history.JIPipeDedicatedGraphHistoryJournal

All Implemented Interfaces:

JIPipeHistoryJournal

public class JIPipeDedicatedGraphHistoryJournal
extends Object
implements JIPipeHistoryJournal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDedicatedGraphHistoryJournal.Snapshot Stores all information about the state of a

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.history.JIPipeHistoryJournal

JIPipeHistoryJournal.ChangedEvent

Constructor Summary

Constructors

Constructor and Description
JIPipeDedicatedGraphHistoryJournal(JIPipeGraph graph)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the journal
JIPipeHistoryJournalSnapshot	getCurrentSnapshot() Gets the snapshot that represents the current state of the data
EventBus	getEventBus() The event bus
JIPipeGraph	getGraph()
JIPipeHistoryJournalSnapshot	getRedoSnapshot() Gets the snapshot for the next redo operation
List<JIPipeHistoryJournalSnapshot>	getSnapshots() Gets the list of all snapshots.
JIPipeHistoryJournalSnapshot	getUndoSnapshot() Gets the snapshot for the next undo operation
boolean	goToSnapshot(JIPipeHistoryJournalSnapshot snapshot, UUID compartment) Attempts to go to a specified snapshot
void	snapshot(String name, String description, UUID compartment, Icon icon) Creates a new snapshot in the history journal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.history.JIPipeHistoryJournal

redo, snapshotBeforeAddCompartment, snapshotBeforeAddNode, snapshotBeforeAddNodes, snapshotBeforeAddSlot, snapshotBeforeConnect, snapshotBeforeCutCompartment, snapshotBeforeCutNodes, snapshotBeforeDisconnect, snapshotBeforeDisconnectAll, snapshotBeforeEditSlot, snapshotBeforeLabelSlot, snapshotBeforeMoveNodes, snapshotBeforeMoveSlot, snapshotBeforePasteNodes, snapshotBeforeRemoveCompartment, snapshotBeforeRemoveNode, snapshotBeforeRemoveNodes, snapshotBeforeRemoveSlot, undo

Constructor Detail

JIPipeDedicatedGraphHistoryJournal

public JIPipeDedicatedGraphHistoryJournal(JIPipeGraph graph)

Method Detail

snapshot

public void snapshot(String name,
                     String description,
                     UUID compartment,
                     Icon icon)

Description copied from interface: JIPipeHistoryJournal

Creates a new snapshot in the history journal

Specified by:

snapshot in interface JIPipeHistoryJournal

Parameters:

name - the name of the snapshot

description - the description of the snapshot

compartment - the compartment. can be null.

icon - an icon. can be null.

getSnapshots

public List<JIPipeHistoryJournalSnapshot> getSnapshots()

Description copied from interface: JIPipeHistoryJournal

Gets the list of all snapshots. The higher the index, the newer the snapshot.

Specified by:

getSnapshots in interface JIPipeHistoryJournal

Returns:

the list of snapshots

clear

public void clear()

Description copied from interface: JIPipeHistoryJournal

Clears the journal

Specified by:

clear in interface JIPipeHistoryJournal

goToSnapshot

public boolean goToSnapshot(JIPipeHistoryJournalSnapshot snapshot,
                            UUID compartment)

Description copied from interface: JIPipeHistoryJournal

Attempts to go to a specified snapshot

Specified by:

goToSnapshot in interface JIPipeHistoryJournal

Parameters:

snapshot - the snapshot

compartment - the compartment. can be null.

Returns:

if the undo/redo was successful

getCurrentSnapshot

public JIPipeHistoryJournalSnapshot getCurrentSnapshot()

Description copied from interface: JIPipeHistoryJournal

Gets the snapshot that represents the current state of the data

Specified by:

getCurrentSnapshot in interface JIPipeHistoryJournal

Returns:

the snapshot. can be null

getUndoSnapshot

public JIPipeHistoryJournalSnapshot getUndoSnapshot()

Description copied from interface: JIPipeHistoryJournal

Gets the snapshot for the next undo operation

Specified by:

getUndoSnapshot in interface JIPipeHistoryJournal

Returns:

the snapshot. can be null.

getRedoSnapshot

public JIPipeHistoryJournalSnapshot getRedoSnapshot()

Description copied from interface: JIPipeHistoryJournal

Gets the snapshot for the next redo operation

Specified by:

getRedoSnapshot in interface JIPipeHistoryJournal

Returns:

the snapshot. can be null

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeHistoryJournal

The event bus

Specified by:

getEventBus in interface JIPipeHistoryJournal

Returns:

the event bus

getGraph

public JIPipeGraph getGraph()