JAL-2944 tidies for review comments

[jalview.git] / src / jalview / gui / StructureViewerBase.java

diff --git a/src/jalview/gui/StructureViewerBase.java b/src/jalview/gui/StructureViewerBase.java
index 20f5c1f..840dbae 100644 (file)
--- a/src/jalview/gui/StructureViewerBase.java
+++ b/src/jalview/gui/StructureViewerBase.java
@@ -410,35 +410,23 @@ public abstract class StructureViewerBase extends GStructureViewer
     return Desktop.instance.getStructureViewers(alp, this.getClass());
   }
 
-
-  /**
-   * Check for any existing views involving this alignment and give user the
-   * option to add and align this molecule to one of them
-   * 
-   * @param pdbentry
-   * @param seq
-   * @param chains
-   * @param apanel
-   * @param pdbId
-   * @return true if user adds to a view, or cancels entirely, else false
-   */
   @Override
-  public boolean addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
+  public void addToExistingViewer(PDBEntry pdbentry, SequenceI[] seq,
           String[] chains, final AlignmentViewPanel apanel, String pdbId)
   {
     /*
      * JAL-1742 exclude view with this structure already mapped (don't offer
-     * to align chain B to chain A of the same structure)
+     * to align chain B to chain A of the same structure); code may defend
+     * against this possibility before we reach here
      */
     if (hasPdbId(pdbId))
     {
-      return false;
+      return;
     }
-    AlignmentPanel ap = (AlignmentPanel) apanel; // Implementation error if this
+    AlignmentPanel alignPanel = (AlignmentPanel) apanel; // Implementation error if this
                                                  // cast fails
-    useAlignmentPanelForSuperposition(ap);
-    addStructure(pdbentry, seq, chains, ap.alignFrame);
-    return true;
+    useAlignmentPanelForSuperposition(alignPanel);
+    addStructure(pdbentry, seq, chains, alignPanel.alignFrame);
   }
 
   /**
@@ -502,33 +490,20 @@ public abstract class StructureViewerBase extends GStructureViewer
     }
   }
 
-  /**
-   * Check if the PDB file is already loaded, if so offer to add it to the
-   * existing viewer
-   * 
-   * @param seq
-   * @param chains
-   * @param apanel
-   * @param pdbId
-   * @return true if the user chooses to add to a viewer, or to cancel entirely
-   */
   @Override
   public boolean addAlreadyLoadedFile(SequenceI[] seq, String[] chains,
           final AlignmentViewPanel apanel, String pdbId)
   {
-    boolean finished = false;
     String alreadyMapped = apanel.getStructureSelectionManager()
             .alreadyMappedToFile(pdbId);
 
-    if (alreadyMapped != null)
+    if (alreadyMapped == null)
     {
-      /*
-       * the PDB file is already loaded
-       */
-      addSequenceMappingsToStructure(seq, chains, apanel, alreadyMapped);
-      finished = true;
+      return false;
     }
-    return finished;
+
+    addSequenceMappingsToStructure(seq, chains, apanel, alreadyMapped);
+    return true;
   }
 
   void setChainMenuItems(List<String> chainNames)
@@ -808,11 +783,11 @@ public abstract class StructureViewerBase extends GStructureViewer
       int[] alm = new int[_alignwith.size()];
       int a = 0;
 
-      for (AlignmentPanel ap : _alignwith)
+      for (AlignmentPanel alignPanel : _alignwith)
       {
-        als[a] = ap.av.getAlignment();
+        als[a] = alignPanel.av.getAlignment();
         alm[a] = -1;
-        alc[a++] = ap.av.getAlignment().getHiddenColumns();
+        alc[a++] = alignPanel.av.getAlignment().getHiddenColumns();
       }
       reply = getBinding().superposeStructures(als, alm, alc);
       if (reply != null)
@@ -824,9 +799,9 @@ public abstract class StructureViewerBase extends GStructureViewer
     } catch (Exception e)
     {
       StringBuffer sp = new StringBuffer();
-      for (AlignmentPanel ap : _alignwith)
+      for (AlignmentPanel alignPanel : _alignwith)
       {
-        sp.append("'" + ap.alignFrame.getTitle() + "' ");
+        sp.append("'" + alignPanel.alignFrame.getTitle() + "' ");
       }
       Cache.log.info("Couldn't align structures with the " + sp.toString()
               + "associated alignment panels.", e);
@@ -890,9 +865,9 @@ public abstract class StructureViewerBase extends GStructureViewer
         }
       }
       // Set the colour using the current view for the associated alignframe
-      for (AlignmentPanel ap : _colourwith)
+      for (AlignmentPanel alignPanel : _colourwith)
       {
-        binding.colourBySequence(ap);
+        binding.colourBySequence(alignPanel);
       }
       seqColoursApplied = true;
     }