org.hkijena.jipipe.api.history

Interface JIPipeHistoryJournal

All Known Implementing Classes:

JIPipeDedicatedGraphHistoryJournal, JIPipeDummyGraphHistoryJournal, JIPipeProjectHistoryJournal

public interface JIPipeHistoryJournal

Base class for all journals that track the history of projects or graphs

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JIPipeHistoryJournal.ChangedEvent Event when the history log was changed

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
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
default boolean	redo(UUID compartment) Redo the last undo operation
void	snapshot(String name, String description, UUID compartment, Icon icon) Creates a new snapshot in the history journal
default void	snapshotBeforeAddCompartment(String compartment) Create a snapshot for adding a node
default void	snapshotBeforeAddNode(JIPipeGraphNode node, UUID compartment) Create a snapshot for adding a node
default void	snapshotBeforeAddNodes(Collection<JIPipeGraphNode> nodes, UUID compartment) Create a snapshot for adding a node
default void	snapshotBeforeAddSlot(JIPipeGraphNode node, JIPipeDataSlotInfo info, UUID compartment) Snapshot before adding a slot
default void	snapshotBeforeConnect(JIPipeDataSlot source, JIPipeDataSlot target, UUID compartment) Snapshot before connecting two slots
default void	snapshotBeforeCutCompartment(JIPipeProjectCompartment compartment) Snapshot before cutting a compartment
default void	snapshotBeforeCutNodes(Set<JIPipeGraphNode> nodes, UUID compartment) Snapshot before cutting a compartment
default void	snapshotBeforeDisconnect(JIPipeDataSlot source, JIPipeDataSlot target, UUID compartment) Snapshot before disconnecting two slots
default void	snapshotBeforeDisconnectAll(JIPipeDataSlot slot, UUID compartment) Snapshot before disconnecting two slots
default void	snapshotBeforeEditSlot(JIPipeDataSlot slot, UUID compartment) Create snapshot before a slot edit
default void	snapshotBeforeLabelSlot(JIPipeDataSlot slot, UUID compartment) Snapshot before adding a slot
default void	snapshotBeforeMoveNodes(Set<JIPipeGraphNode> nodes, UUID compartment) Create a snapshot for moving nodes
default void	snapshotBeforeMoveSlot(JIPipeDataSlot slot, UUID compartment) Snapshot before adding a slot
default void	snapshotBeforePasteNodes(Collection<JIPipeGraphNode> nodes, UUID compartment) Create a snapshot for adding a node
default void	snapshotBeforeRemoveCompartment(JIPipeProjectCompartment compartment) Create a snapshot for removing a node
default void	snapshotBeforeRemoveNode(JIPipeGraphNode node, UUID compartment) Create a snapshot for removing a node
default void	snapshotBeforeRemoveNodes(Collection<JIPipeGraphNode> nodes, UUID compartment) Create a snapshot for adding a node
default void	snapshotBeforeRemoveSlot(JIPipeGraphNode node, JIPipeDataSlotInfo info, UUID compartment) Snapshot before adding a slot
default boolean	undo(UUID compartment) Undo the last undo operation

Method Detail

getEventBus

EventBus getEventBus()

The event bus

Returns:

the event bus

snapshot

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

Creates a new snapshot in the history journal

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

List<JIPipeHistoryJournalSnapshot> getSnapshots()

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

Returns:

the list of snapshots

snapshotBeforeCutNodes

default void snapshotBeforeCutNodes(Set<JIPipeGraphNode> nodes,
                                    UUID compartment)

Snapshot before cutting a compartment

Parameters:

nodes - the nodes

compartment - the compartment. can be null.

snapshotBeforeCutCompartment

default void snapshotBeforeCutCompartment(JIPipeProjectCompartment compartment)

Snapshot before cutting a compartment

Parameters:

compartment - the compartment

snapshotBeforeDisconnectAll

default void snapshotBeforeDisconnectAll(JIPipeDataSlot slot,
                                         UUID compartment)

Snapshot before disconnecting two slots

Parameters:

slot - the slot

compartment - the compartment. can be null.

snapshotBeforeDisconnect

default void snapshotBeforeDisconnect(JIPipeDataSlot source,
                                      JIPipeDataSlot target,
                                      UUID compartment)

Snapshot before disconnecting two slots

Parameters:

source - the source

target - the target

compartment - the compartment. can be null.

snapshotBeforeConnect

default void snapshotBeforeConnect(JIPipeDataSlot source,
                                   JIPipeDataSlot target,
                                   UUID compartment)

Snapshot before connecting two slots

Parameters:

source - the source

target - the target

compartment - the compartment. can be null.

snapshotBeforeAddSlot

default void snapshotBeforeAddSlot(JIPipeGraphNode node,
                                   JIPipeDataSlotInfo info,
                                   UUID compartment)

Snapshot before adding a slot

Parameters:

node - the node

info - the slot info

compartment - the compartment. can be null.

snapshotBeforeRemoveSlot

default void snapshotBeforeRemoveSlot(JIPipeGraphNode node,
                                      JIPipeDataSlotInfo info,
                                      UUID compartment)

Snapshot before adding a slot

Parameters:

node - the node

info - the slot info

compartment - the compartment. can be null.

snapshotBeforeLabelSlot

default void snapshotBeforeLabelSlot(JIPipeDataSlot slot,
                                     UUID compartment)

Snapshot before adding a slot

Parameters:

slot - the slot

compartment - the compartment. can be null.

snapshotBeforeMoveSlot

default void snapshotBeforeMoveSlot(JIPipeDataSlot slot,
                                    UUID compartment)

Snapshot before adding a slot

Parameters:

slot - the slot

compartment - the compartment. can be null.

snapshotBeforeEditSlot

default void snapshotBeforeEditSlot(JIPipeDataSlot slot,
                                    UUID compartment)

Create snapshot before a slot edit

Parameters:

slot - the slot

snapshotBeforeAddNodes

default void snapshotBeforeAddNodes(Collection<JIPipeGraphNode> nodes,
                                    UUID compartment)

Create a snapshot for adding a node

Parameters:

nodes - the nodes

compartment - the compartment. can be null.

snapshotBeforePasteNodes

default void snapshotBeforePasteNodes(Collection<JIPipeGraphNode> nodes,
                                      UUID compartment)

Create a snapshot for adding a node

Parameters:

nodes - the nodes

compartment - the compartment. can be null.

snapshotBeforeAddNode

default void snapshotBeforeAddNode(JIPipeGraphNode node,
                                   UUID compartment)

Create a snapshot for adding a node

Parameters:

node - the node

compartment - the compartment. can be null.

snapshotBeforeAddCompartment

default void snapshotBeforeAddCompartment(String compartment)

Create a snapshot for adding a node

Parameters:

compartment - the compartment.

snapshotBeforeRemoveNodes

default void snapshotBeforeRemoveNodes(Collection<JIPipeGraphNode> nodes,
                                       UUID compartment)

Create a snapshot for adding a node

Parameters:

nodes - the nodes

compartment - the compartment. can be null.

snapshotBeforeMoveNodes

default void snapshotBeforeMoveNodes(Set<JIPipeGraphNode> nodes,
                                     UUID compartment)

Create a snapshot for moving nodes

Parameters:

nodes - the nodes

compartment - the compartment

snapshotBeforeRemoveNode

default void snapshotBeforeRemoveNode(JIPipeGraphNode node,
                                      UUID compartment)

Create a snapshot for removing a node

Parameters:

node - the node

compartment - the compartment. can be null.

snapshotBeforeRemoveCompartment

default void snapshotBeforeRemoveCompartment(JIPipeProjectCompartment compartment)

Create a snapshot for removing a node

Parameters:

compartment - the node

redo

default boolean redo(UUID compartment)

Redo the last undo operation

Parameters:

compartment - the compartment. can be null.

Returns:

if redo was successful

undo

default boolean undo(UUID compartment)

Undo the last undo operation

Parameters:

compartment - the compartment. can be null.

Returns:

if undo was successful

goToSnapshot

boolean goToSnapshot(JIPipeHistoryJournalSnapshot snapshot,
                     UUID compartment)

Attempts to go to a specified snapshot

Parameters:

snapshot - the snapshot

compartment - the compartment. can be null.

Returns:

if the undo/redo was successful

getUndoSnapshot

JIPipeHistoryJournalSnapshot getUndoSnapshot()

Gets the snapshot for the next undo operation

Returns:

the snapshot. can be null.

getRedoSnapshot

JIPipeHistoryJournalSnapshot getRedoSnapshot()

Gets the snapshot for the next redo operation

Returns:

the snapshot. can be null

getCurrentSnapshot

JIPipeHistoryJournalSnapshot getCurrentSnapshot()

Gets the snapshot that represents the current state of the data

Returns:

the snapshot. can be null

clear

void clear()

Clears the journal