Web socket messages when nodes are copied

Author: georgweiss

app/save-and-restore/app/src/main/java/org/phoebus/applications/saveandrestore/ui/SaveAndRestoreController.java

@@ -186,6 +186,7 @@ public class SaveAndRestoreController extends SaveAndRestoreBaseController
     @FXML
     private VBox errorPane;
 
+    @SuppressWarnings("unused")
     @FXML
     private Label webSocketTrackerLabel;
 
@@ -207,14 +208,10 @@ public class SaveAndRestoreController extends SaveAndRestoreBaseController
     List<MenuItem> menuItems = Arrays.asList(
             new LoginMenuItem(this, selectedItemsProperty,
                     () -> ApplicationService.createInstance("credentials_management")),
-            new NewFolderMenuItem(this, selectedItemsProperty,
-                    () -> createNewFolder()),
-            new NewConfigurationMenuItem(this, selectedItemsProperty,
-                    () -> createNewConfiguration()),
-            new CreateSnapshotMenuItem(this, selectedItemsProperty,
-                    () -> openConfigurationForSnapshot()),
-            new NewCompositeSnapshotMenuItem(this, selectedItemsProperty,
-                    () -> createNewCompositeSnapshot()),
+            new NewFolderMenuItem(this, selectedItemsProperty, this::createNewFolder),
+            new NewConfigurationMenuItem(this, selectedItemsProperty, this::createNewConfiguration),
+            new CreateSnapshotMenuItem(this, selectedItemsProperty, this::openConfigurationForSnapshot),
+            new NewCompositeSnapshotMenuItem(this, selectedItemsProperty, this::createNewCompositeSnapshot),
             new RestoreFromClientMenuItem(this, selectedItemsProperty,
                     () -> {
                         disabledUi.set(true);
@@ -226,8 +223,8 @@ public class SaveAndRestoreController extends SaveAndRestoreBaseController
                         RestoreUtil.restore(RestoreMode.SERVICE_RESTORE, saveAndRestoreService, selectedItemsProperty.get(0), () -> disabledUi.set(false));
                     }),
             new SeparatorMenuItem(),
-            new EditCompositeMenuItem(this, selectedItemsProperty, () -> editCompositeSnapshot()),
-            new RenameFolderMenuItem(this, selectedItemsProperty, () -> renameNode()),
+            new EditCompositeMenuItem(this, selectedItemsProperty, this::editCompositeSnapshot),
+            new RenameFolderMenuItem(this, selectedItemsProperty, this::renameNode),
             copyMenuItem,
             pasteMenuItem,
             deleteNodeMenuItem,
@@ -236,11 +233,10 @@ public class SaveAndRestoreController extends SaveAndRestoreBaseController
             new TagGoldenMenuItem(this, selectedItemsProperty),
             tagWithComment,
             new SeparatorMenuItem(),
-            new CopyUniqueIdToClipboardMenuItem(this, selectedItemsProperty,
-                    () -> copyUniqueNodeIdToClipboard()),
+            new CopyUniqueIdToClipboardMenuItem(this, selectedItemsProperty, this::copyUniqueNodeIdToClipboard),
             new SeparatorMenuItem(),
-            new ImportFromCSVMenuItem(this, selectedItemsProperty, () -> importFromCSV()),
-            new ExportToCSVMenuItem(this, selectedItemsProperty, () -> exportToCSV())
+            new ImportFromCSVMenuItem(this, selectedItemsProperty, this::importFromCSV),
+            new ExportToCSVMenuItem(this, selectedItemsProperty, this::exportToCSV)
     );
 
     private final SimpleStringProperty webSocketTrackerText = new SimpleStringProperty();
@@ -1041,45 +1037,6 @@ protected void moveNodes(List<Node> sourceNodes, Node targetNode, TransferMode t
         });
     }
 
-    /**
-     * Updates the tree view such that moved items are shown in the drop target.
-     *
-     * @param parentTreeItem The drop target
-     * @param nodes          List of {@link Node}s that were moved.
-     */
-    private void addMovedNodes(TreeItem<Node> parentTreeItem, List<Node> nodes) {
-        parentTreeItem.getChildren().addAll(nodes.stream().map(this::createTreeItem).toList());
-        parentTreeItem.getChildren().sort(treeNodeComparator);
-        TreeItem<Node> nextItemToExpand = parentTreeItem;
-        while (nextItemToExpand != null) {
-            nextItemToExpand.setExpanded(true);
-            nextItemToExpand = nextItemToExpand.getParent();
-        }
-
-    }
-
-    /**
-     * Updates the tree view such that moved items are removed from source nodes' parent.
-     *
-     * @param parentTreeItem The parent of the {@link Node}s before the move.
-     * @param nodes          List of {@link Node}s that were moved.
-     */
-    private void removeMovedNodes(TreeItem<Node> parentTreeItem, List<Node> nodes) {
-        List<TreeItem<Node>> childItems = parentTreeItem.getChildren();
-        List<TreeItem<Node>> treeItemsToRemove = new ArrayList<>();
-        childItems.forEach(childItem -> {
-            if (nodes.contains(childItem.getValue())) {
-                treeItemsToRemove.add(childItem);
-            }
-        });
-        parentTreeItem.getChildren().removeAll(treeItemsToRemove);
-        TreeItem<Node> nextItemToExpand = parentTreeItem;
-        while (nextItemToExpand != null) {
-            nextItemToExpand.setExpanded(true);
-            nextItemToExpand = nextItemToExpand.getParent();
-        }
-    }
-
     /**
      * Parses the {@link URI} to determine what to do. Supported actions/behavior:
      * <ul>
@@ -1316,20 +1273,15 @@ private void pasteFromClipboard() {
         }
         List<String> selectedNodeIds =
                 ((List<Node>) selectedNodes).stream().map(Node::getUniqueId).collect(Collectors.toList());
-        JobManager.schedule("copy nodes", monitor -> {
+        JobManager.schedule("Copy odes", monitor -> {
             try {
                 saveAndRestoreService.copyNodes(selectedNodeIds, browserSelectionModel.getSelectedItem().getValue().getUniqueId());
                 disabledUi.set(false);
             } catch (Exception e) {
                 disabledUi.set(false);
                 ExceptionDetailsErrorDialog.openError(Messages.errorGeneric, Messages.failedToPasteObjects, e);
                 LOG.log(Level.WARNING, "Failed to paste nodes into target " + browserSelectionModel.getSelectedItem().getValue().getName());
-                return;
             }
-            Platform.runLater(() -> {
-                expandTreeNode(browserSelectionModel.getSelectedItem());
-                treeView.refresh();
-            });
         });
     }
 

services/save-and-restore/src/main/java/org/phoebus/service/saveandrestore/persistence/dao/NodeDAO.java

@@ -32,10 +32,7 @@
 import org.phoebus.applications.saveandrestore.model.search.SearchResult;
 import org.springframework.util.MultiValueMap;
 
-import java.util.HashMap;
-import java.util.HashSet;
 import java.util.List;
-import java.util.Set;
 
 /**
  * @author georgweiss Created 11 Mar 2019
@@ -60,6 +57,7 @@ public interface NodeDAO {
 
     /**
      * Retrieve the nodes identified by the list of unique node ids
+     *
      * @param uniqueNodeIds List of unique node ids
      * @return List of matching nodes
      */
@@ -75,8 +73,8 @@ public interface NodeDAO {
     /**
      * Checks that each of the node ids passed to this method exist, and that none of them
      * is the root node. If check passes all nodes are deleted.
+     *
      * @param nodeIds List of (existing) node ids.
-     * @return The collection of unique node id representing the deleted
      * {@link Node}s. Client may use this to trigger a refresh of the UI.
      */
     void deleteNodes(List<String> nodeIds);
@@ -92,7 +90,6 @@ public interface NodeDAO {
 
 
     /**
-     *
      * @param uniqueNodeId Valid {@link Node} id.
      * @return The parent {@link Node}
      */
@@ -114,9 +111,9 @@ public interface NodeDAO {
      * @param nodeIds  Non-null and non-empty list of unique node ids subject to move
      * @param targetId Non-null and non-empty unique id of target node
      * @param userName The (account) name of the user performing the operation.
-     * @return The target {@link Node} object that is the new parent of the moved source {@link Node}
+     * @return A list of new {@link Node}s
      */
-    Node copyNodes(List<String> nodeIds, String targetId, String userName);
+    List<Node> copyNodes(List<String> nodeIds, String targetId, String userName);
 
 
     /**
@@ -139,8 +136,9 @@ public interface NodeDAO {
 
     /**
      * Saves the {@link org.phoebus.applications.saveandrestore.model.Snapshot} to the persistence layer.
+     *
      * @param parentNodeId The unique id of the parent {@link Node} for the new {@link Snapshot}.
-     * @param snapshot The {@link Snapshot} data.
+     * @param snapshot     The {@link Snapshot} data.
      * @return The persisted {@link Snapshot} data.
      */
     Snapshot createSnapshot(String parentNodeId, Snapshot snapshot);
@@ -201,14 +199,16 @@ public interface NodeDAO {
 
     /**
      * Saves the {@link org.phoebus.applications.saveandrestore.model.Configuration} to the persistence layer.
-     * @param parentNodeId The unique id of the parent {@link Node} for the new {@link Configuration}.
+     *
+     * @param parentNodeId  The unique id of the parent {@link Node} for the new {@link Configuration}.
      * @param configuration The {@link Configuration} data.
      * @return The persisted {@link Configuration} data.
      */
     Configuration createConfiguration(String parentNodeId, Configuration configuration);
 
     /**
      * Retrieves the {@link ConfigurationData} for the specified (unique) id.
+     *
      * @param uniqueId Id of the configuration {@link Node}
      * @return A {@link ConfigurationData} object.
      */
@@ -226,6 +226,7 @@ public interface NodeDAO {
 
     /**
      * Retrieves the {@link SnapshotData} for the specified (unique) id.
+     *
      * @param uniqueId Id of the snapshot {@link Node}
      * @return A {@link SnapshotData} object.
      */
@@ -249,7 +250,8 @@ public interface NodeDAO {
 
     /**
      * Saves the {@link org.phoebus.applications.saveandrestore.model.CompositeSnapshot} to the persistence layer.
-     * @param parentNodeId The unique id of the parent {@link Node} for the new {@link CompositeSnapshot}.
+     *
+     * @param parentNodeId      The unique id of the parent {@link Node} for the new {@link CompositeSnapshot}.
      * @param compositeSnapshot The {@link CompositeSnapshot} data.
      * @return The persisted {@link CompositeSnapshot} data.
      */
@@ -268,6 +270,7 @@ public interface NodeDAO {
 
     /**
      * Checks for duplicate PV names in the specified list of snapshot or composite snapshot {@link Node}s.
+     *
      * @param snapshotIds list of snapshot or composite snapshot {@link Node}s
      * @return A list if PV names that occur multiple times in the specified snapshot nodes or snapshot nodes
      * referenced in composite snapshots. If no duplicates are found, an empty list is returned.
@@ -288,6 +291,7 @@ public interface NodeDAO {
      * Aggregates a list of {@link SnapshotItem}s from a composite snapshot node. Note that since a
      * composite snapshot may reference other composite snapshots, the implementation may need to recursively
      * locate all referenced single snapshots.
+     *
      * @param compositeSnapshotNodeId The if of an existing composite snapshot {@link Node}
      * @return A list of {@link SnapshotItem}s.
      */
@@ -297,21 +301,24 @@ public interface NodeDAO {
      * Checks if all the referenced snapshot {@link Node}s in a {@link CompositeSnapshot} are
      * of the supported type, i.e. {@link org.phoebus.applications.saveandrestore.model.NodeType#COMPOSITE_SNAPSHOT}
      * or {@link org.phoebus.applications.saveandrestore.model.NodeType#SNAPSHOT}
+     *
      * @param compositeSnapshot An existing {@link CompositeSnapshot}.
      * @return <code>true</code> if all referenced snapshot {@link Node}s in a {@link CompositeSnapshot} are all
-     *      * of the supported type.
+     * * of the supported type.
      */
     boolean checkCompositeSnapshotReferencedNodeTypes(CompositeSnapshot compositeSnapshot);
 
     /**
      * Performs a search based on the provided search parameters.
+     *
      * @param searchParameters Map of keyword/value pairs defining the search criteria.
      * @return A {@link SearchResult} object with a potentially empty list of {@link Node}s.
      */
     SearchResult search(MultiValueMap<String, String> searchParameters);
 
     /**
      * Save a new or updated {@link Filter}
+     *
      * @param filter The {@link Filter} to save
      * @return The saved {@link Filter}
      */
@@ -324,6 +331,7 @@ public interface NodeDAO {
 
     /**
      * Deletes a {@link Filter} based on its name.
+     *
      * @param name Unique name of the {@link Filter}
      */
     void deleteFilter(String name);
@@ -335,13 +343,15 @@ public interface NodeDAO {
 
     /**
      * Adds a {@link Tag} to specified list of target {@link Node}s
+     *
      * @param tagData See {@link TagData}
      * @return The list of updated {@link Node}s
      */
     List<Node> addTag(TagData tagData);
 
     /**
      * Removes a {@link Tag} from specified list of target {@link Node}s
+     *
      * @param tagData See {@link TagData}
      * @return The list of updated {@link Node}s
      */