Warn user when comparing graphs of the same name (#1618)

* add a check to exit and warn the user

* Revert "add a check to exit and warn the user"

This reverts commit 963df95.

* add controller but not functioning

* remove update parameter code

* remove commented code

* Update whatsnew.txt

Author: aldebaran30701

CoreFunctionality/src/au/gov/asd/tac/constellation/functionality/compare/CompareGraphPlugin.java

@@ -36,6 +36,7 @@
 import au.gov.asd.tac.constellation.plugins.PluginNotificationLevel;
 import au.gov.asd.tac.constellation.plugins.PluginRegistry;
 import au.gov.asd.tac.constellation.plugins.PluginType;
+import au.gov.asd.tac.constellation.plugins.parameters.ParameterChange;
 import au.gov.asd.tac.constellation.plugins.parameters.PluginParameter;
 import au.gov.asd.tac.constellation.plugins.parameters.PluginParameters;
 import au.gov.asd.tac.constellation.plugins.parameters.types.ColorParameterType;
@@ -111,12 +112,40 @@ public PluginParameters createParameters() {
         originalGraph.setName("Original Graph");
         originalGraph.setDescription("The graph used as the starting point for the comparison");
         parameters.addParameter(originalGraph);
+        
+        // Controller listens for value change so that the compare graph cannot be compared against itself
+        parameters.addController(ORIGINAL_GRAPH_PARAMETER_ID, (PluginParameter<?> master, Map<String, PluginParameter<?>> params, ParameterChange change) -> {
+            // When value has changed, remove choice from the comparison graph dialog
+            if (change == ParameterChange.VALUE) {
+                final String originalGraphName = params.get(ORIGINAL_GRAPH_PARAMETER_ID).getStringValue();
+                if (originalGraphName != null) {
+                    
+                    final List<String> graphNames = new ArrayList<>();
+                    final Map<String, Graph> allGraphs = GraphNode.getAllGraphs();
+                    if (allGraphs != null) {
+                        for (final String graphId : allGraphs.keySet()) {
+                            graphNames.add(GraphNode.getGraphNode(graphId).getDisplayName());
+                        }
+                    }
+                    // remove the current original graph selection from the list of graphs allowed to compare with
+                    graphNames.remove(originalGraphName);
+                    
+                    // sort drop down list
+                    graphNames.sort(String::compareTo);
+                    
+                          
+                    @SuppressWarnings("unchecked") //COMPARE_GRAPH_PARAMETER_ID will always be of type SingleChoiceParameterValue
+                    final PluginParameter<SingleChoiceParameterValue> compareParamter = (PluginParameter<SingleChoiceParameterValue>) params.get(COMPARE_GRAPH_PARAMETER_ID);
+                    SingleChoiceParameterType.setOptions(compareParamter, graphNames);
+                }
+            }
+        });
 
         final PluginParameter<SingleChoiceParameterValue> compareGraph = SingleChoiceParameterType.build(COMPARE_GRAPH_PARAMETER_ID);
         compareGraph.setName("Compare With Graph");
         compareGraph.setDescription("The graph used to compare against the original graph");
         parameters.addParameter(compareGraph);
-
+        
         final PluginParameter<MultiChoiceParameterValue> ignoreVertexAttributes = MultiChoiceParameterType.build(IGNORE_VERTEX_ATTRIBUTES_PARAMETER_ID);
         ignoreVertexAttributes.setName("Ignore Node Attributes");
         ignoreVertexAttributes.setDescription("Ignore these attributes when comparing nodes");
@@ -198,10 +227,6 @@ public void updateParameters(final Graph graph, final PluginParameters parameter
         SingleChoiceParameterType.setOptions(originalGraph, graphNames);
         SingleChoiceParameterType.setChoice(originalGraph, GraphNode.getGraphNode(graph.getId()).getDisplayName());
 
-        @SuppressWarnings("unchecked") //COMPARE_GRAPH_PARAMETER will always be of type SingleChoiceParameter
-        final PluginParameter<SingleChoiceParameterValue> compareGraph = (PluginParameter<SingleChoiceParameterValue>) parameters.getParameters().get(COMPARE_GRAPH_PARAMETER_ID);
-        SingleChoiceParameterType.setOptions(compareGraph, graphNames);
-
         @SuppressWarnings("unchecked") //IGNORE_VERTEX_ATTRIBUTES_PARAMETER will always be of type MultiChoiceParameter
         final PluginParameter<MultiChoiceParameterValue> ignoreVertexAttributes = (PluginParameter<MultiChoiceParameterValue>) parameters.getParameters().get(IGNORE_VERTEX_ATTRIBUTES_PARAMETER_ID);
         MultiChoiceParameterType.setOptions(ignoreVertexAttributes, new ArrayList<>(registeredVertexAttributes));

CoreWhatsNewView/src/au/gov/asd/tac/constellation/views/whatsnew/whatsnew.txt

@@ -1,16 +1,19 @@
 == 3030-12-31 Getting Started
 <p>If you're new to Constellation, read the <a href="" helpId="au.gov.asd.tac.constellation.functionality.gettingstarted">getting started guide</a>.</p>
 
+== 2022-02-21 Compare Graph Parameters
+<p>The dialog for comparing graphs in the Tools -> Compare graph menu will now update to prevent the user from comparing against the original graph.</p>
+
 == 2022-02-17 Add description to Step Tab names in Data Access View
 <p> The Step Tab names in the Data Access View can now be double clicked to add a brief decription. E.g. If "Initial run" is entered, "Step 1 - Initial run" will be displayed in the Tab name. This is also saved and loaded as part of the templates.</p>
 
 == 2022-01-24 Histogram Bins Selected Count
 <p>The Histogram now shows the amount of bins selected out of the total bins present.</p>
 
 == 2022-01-21 File Importer
-<p>File Importer enforces all files that are being added have the same column structure. 
-When the 'Files Include Headers' option is enabled, the column headings of all the files should be the same. When it is disabled, 
-the number of columns should be the same. Otherwise a warning message is displayed and the files with a different structure to the 
+<p>File Importer enforces all files that are being added have the same column structure.
+When the 'Files Include Headers' option is enabled, the column headings of all the files should be the same. When it is disabled,
+the number of columns should be the same. Otherwise a warning message is displayed and the files with a different structure to the
 first file added are removed.</p>
 
 == 2021-12-16 Quality Control Categories
@@ -24,7 +27,7 @@ first file added are removed.</p>
 
 == 2021-10-29 New Online & Offline Help
 <p>The help documentation is now able to be viewed both online through the constellation-app.com website and offline through a local server.</p>
-<p>A preference has been added where you choose to view help documentation either online or offline. This can be found via 
+<p>A preference has been added where you choose to view help documentation either online or offline. This can be found via
 Setup -> Options -> CONSTELLATION -> Help -> Online Help. The help documentation is accessible through the blue question mark icons found in each view. </p>
 
 == 2021-10-27 Layers View Graph Context