JAL-629 Adding PAE and TFType at structure loading time. Display PAE automatically
[jalview.git] / src / jalview / bin / Commands.java
index 43dc1fd..5341874 100644 (file)
@@ -14,7 +14,6 @@ import java.util.Map;
 import java.util.Map.Entry;
 
 import jalview.analysis.AlignmentUtils;
-import jalview.api.AlignmentViewPanel;
 import jalview.bin.argparser.Arg;
 import jalview.bin.argparser.ArgParser;
 import jalview.bin.argparser.ArgValue;
@@ -42,13 +41,11 @@ import jalview.io.FileLoader;
 import jalview.io.HtmlSvgOutput;
 import jalview.io.IdentifyFile;
 import jalview.schemes.AnnotationColourGradient;
-import jalview.structure.StructureImportSettings;
 import jalview.structure.StructureImportSettings.TFType;
 import jalview.structure.StructureSelectionManager;
 import jalview.util.HttpUtils;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
-import jalview.ws.dbsources.EBIAlfaFold;
 import mc_view.PDBChain;
 
 public class Commands
@@ -150,16 +147,13 @@ public class Commands
       return true;
 
     /*
-    // script to execute after all loading is completed one way or another
-    String groovyscript = m.get(Arg.GROOVY) == null ? null
-            : m.get(Arg.GROOVY).getValue();
-    String file = m.get(Arg.OPEN) == null ? null
-            : m.get(Arg.OPEN).getValue();
-    String data = null;
-    FileFormatI format = null;
-    DataSourceType protocol = null;
-    */
-    if (avm.containsArg(Arg.OPEN))
+     * // script to execute after all loading is completed one way or another String
+     * groovyscript = m.get(Arg.GROOVY) == null ? null :
+     * m.get(Arg.GROOVY).getValue(); String file = m.get(Arg.OPEN) == null ? null :
+     * m.get(Arg.OPEN).getValue(); String data = null; FileFormatI format = null;
+     * DataSourceType protocol = null;
+     */
+    if (avm.containsArg(Arg.OPEN) || avm.containsArg(Arg.OPENNEW))
     {
       commandArgsProvided = true;
       long progress = -1;
@@ -167,6 +161,8 @@ public class Commands
       boolean first = true;
       boolean progressBarSet = false;
       AlignFrame af;
+      // Combine the OPEN and OPENNEW files into one list, along with whether it
+      // was OPEN or OPENNEW
       List<Entry<Arg, ArgValue>> openAvList = new ArrayList<>();
       avm.getArgValueList(Arg.OPEN).stream()
               .forEachOrdered(av -> openAvList.add(
@@ -231,73 +227,25 @@ public class Commands
                 || a == Arg.OPENNEW || format == FileFormat.Jalview)
         {
           /*
-           * this approach isn't working yet
-          // get default annotations before opening AlignFrame
-          if (m.get(Arg.SSANNOTATION) != null)
-          {
-            Console.debug("***** SSANNOTATION="
-                    + m.get(Arg.SSANNOTATION).getBoolean());
-          }
-          if (m.get(Arg.NOTEMPFAC) != null)
-          {
-            Console.debug(
-                    "***** NOTEMPFAC=" + m.get(Arg.NOTEMPFAC).getBoolean());
-          }
-          boolean showSecondaryStructure = (m.get(Arg.SSANNOTATION) != null)
-                  ? m.get(Arg.SSANNOTATION).getBoolean()
-                  : false;
-          boolean showTemperatureFactor = (m.get(Arg.NOTEMPFAC) != null)
-                  ? !m.get(Arg.NOTEMPFAC).getBoolean()
-                  : false;
-          Console.debug("***** tempfac=" + showTemperatureFactor
-                  + ", showSS=" + showSecondaryStructure);
-          StructureSelectionManager ssm = StructureSelectionManager
-                  .getStructureSelectionManager(Desktop.instance);
-          if (ssm != null)
-          {
-            ssm.setAddTempFacAnnot(showTemperatureFactor);
-            ssm.setProcessSecondaryStructure(showSecondaryStructure);
-          }
+           * this approach isn't working yet // get default annotations before opening
+           * AlignFrame if (m.get(Arg.SSANNOTATION) != null) {
+           * Console.debug("##### SSANNOTATION=" + m.get(Arg.SSANNOTATION).getBoolean());
+           * } if (m.get(Arg.NOTEMPFAC) != null) { Console.debug( "##### NOTEMPFAC=" +
+           * m.get(Arg.NOTEMPFAC).getBoolean()); } boolean showSecondaryStructure =
+           * (m.get(Arg.SSANNOTATION) != null) ? m.get(Arg.SSANNOTATION).getBoolean() :
+           * false; boolean showTemperatureFactor = (m.get(Arg.NOTEMPFAC) != null) ?
+           * !m.get(Arg.NOTEMPFAC).getBoolean() : false; Console.debug("##### tempfac=" +
+           * showTemperatureFactor + ", showSS=" + showSecondaryStructure);
+           * StructureSelectionManager ssm = StructureSelectionManager
+           * .getStructureSelectionManager(Desktop.instance); if (ssm != null) {
+           * ssm.setAddTempFacAnnot(showTemperatureFactor);
+           * ssm.setProcessSecondaryStructure(showSecondaryStructure); }
            */
 
-          // get kind of temperature factor annotation
-          StructureImportSettings.TFType tempfacType = TFType.DEFAULT;
-          if ((!avm.getBoolean(Arg.NOTEMPFAC))
-                  && avm.containsArg(Arg.TEMPFAC))
-          {
-            try
-            {
-              tempfacType = StructureImportSettings.TFType
-                      .valueOf(avm.getArgValue(Arg.TEMPFAC).getValue()
-                              .toUpperCase(Locale.ROOT));
-              Console.debug("Obtained Temperature Factor type of '"
-                      + tempfacType + "'");
-            } catch (IllegalArgumentException e)
-            {
-              // Just an error message!
-              StringBuilder sb = new StringBuilder().append("Cannot set --")
-                      .append(Arg.TEMPFAC.getName()).append(" to '")
-                      .append(tempfacType)
-                      .append("', ignoring.  Valid values are: ");
-              Iterator<StructureImportSettings.TFType> it = Arrays
-                      .stream(StructureImportSettings.TFType.values())
-                      .iterator();
-              while (it.hasNext())
-              {
-                sb.append(it.next().toString().toLowerCase(Locale.ROOT));
-                if (it.hasNext())
-                  sb.append(", ");
-              }
-              Console.warn(sb.toString());
-            }
-          }
-
           Console.debug(
                   "Opening '" + openFile + "' in new alignment frame");
           FileLoader fileLoader = new FileLoader(!headless);
 
-          StructureImportSettings.setTemperatureFactorType(tempfacType);
-
           af = fileLoader.LoadFileWaitTillLoaded(openFile, protocol,
                   format);
 
@@ -340,9 +288,10 @@ public class Commands
                     false, false);
           }
           else
-          /* comment out hacky approach up to here and add this line:
-           if (showTemperatureFactor)
-             */
+          /*
+           * comment out hacky approach up to here and add this line: if
+           * (showTemperatureFactor)
+           */
           {
             if (avm.containsArg(Arg.TEMPFAC_LABEL))
             {
@@ -413,38 +362,42 @@ public class Commands
         for (ArgValue av : avm.getArgValueList(Arg.STRUCTURE))
         {
           String val = av.getValue();
-          SubVals subId = new SubVals(val);
-          SequenceI seq = getSpecifiedSequence(af, subId);
+          SubVals subVals = av.getSubVals();
+          SequenceI seq = getSpecifiedSequence(af, subVals);
           if (seq == null)
           {
-            Console.warn("Could not find sequence for argument --"
-                    + Arg.STRUCTURE + "=" + val);
+            // Could not find sequence from subId, let's assume the first
+            // sequence in the alignframe
+            AlignmentI al = af.getCurrentView().getAlignment();
+            seq = al.getSequenceAt(0);
+          }
+
+          if (seq == null)
+          {
+            Console.warn("Could not find sequence for argument "
+                    + Arg.STRUCTURE.argString() + "=" + val);
             // you probably want to continue here, not break
             // break;
             continue;
           }
           File structureFile = null;
-          if (subId.getContent() != null
-                  && subId.getContent().length() != 0)
+          if (subVals.getContent() != null
+                  && subVals.getContent().length() != 0)
           {
-            structureFile = new File(subId.getContent());
+            structureFile = new File(subVals.getContent());
             Console.debug("Using structure file (from argument) '"
                     + structureFile.getAbsolutePath() + "'");
           }
-
           // TRY THIS
           /*
-           PDBEntry fileEntry = new AssociatePdbFileWithSeq()
-                  .associatePdbWithSeq(selectedPdbFileName,
-                          DataSourceType.FILE, selectedSequence, true,
-                          Desktop.instance);
-                          
-           sViewer = launchStructureViewer(ssm, new PDBEntry[] { fileEntry },
-                  ap, new SequenceI[]
-                  { selectedSequence });
-          
+           * PDBEntry fileEntry = new AssociatePdbFileWithSeq()
+           * .associatePdbWithSeq(selectedPdbFileName, DataSourceType.FILE,
+           * selectedSequence, true, Desktop.instance);
+           * 
+           * sViewer = launchStructureViewer(ssm, new PDBEntry[] { fileEntry }, ap, new
+           * SequenceI[] { selectedSequence });
+           * 
            */
-
           /* THIS DOESN'T WORK */
           else if (seq.getAllPDBEntries() != null
                   && seq.getAllPDBEntries().size() > 0)
@@ -483,98 +436,71 @@ public class Commands
                     StructureViewer.ViewerType.JMOL.toString());
           }
 
-          // get tft, paeFilename, label?
-          /*
-          ArgValue tftAv = avm.getArgValuesReferringTo("structid", structId,
-                  Arg.TEMPFAC);
-           */
-          StructureChooser.openStructureFileForSequence(null, null, ap, seq,
-                  false, structureFile.getAbsolutePath(), null, null); // tft,
-                                                                       // paeFilename);
-        }
-      }
-    }
+          String structureFilepath = structureFile.getAbsolutePath();
 
-    // load a pAE file if given
-    if (avm.containsArg(Arg.PAEMATRIX))
-    {
-      AlignFrame af = afMap.get(id);
-      if (af != null)
-      {
-        for (ArgValue av : avm.getArgValueList(Arg.PAEMATRIX))
-        {
-          String val = av.getValue();
-          SubVals subVals = ArgParser.getSubVals(val);
-          String paeLabel = subVals.get("label");
-          File paeFile = new File(subVals.getContent());
-          String paePath = null;
-          try
+          // get PAEMATRIX file and label from subvals or Arg.PAEMATRIX
+          String paeFilepath = subVals.getWithSubstitutions(argParser, id,
+                  "paematrix");
+          String paeLabel = subVals.get("paelabel");
+          ArgValue paeAv = getArgAssociatedWithStructure(Arg.PAEMATRIX, avm,
+                  af, structureFilepath);
+          if (paeFilepath == null && paeAv != null)
           {
-            paePath = paeFile.getCanonicalPath();
-          } catch (IOException e)
+            SubVals sv = paeAv.getSubVals();
+            File paeFile = new File(sv.getContent());
+
+            paeLabel = sv.get("label");
+            try
+            {
+              paeFilepath = paeFile.getCanonicalPath();
+            } catch (IOException e)
+            {
+              paeFilepath = paeFile.getAbsolutePath();
+              Console.warn("Problem with the PAE file path: '"
+                      + paeFile.getPath() + "'");
+            }
+          }
+
+          // get TEMPFAC type from subvals or Arg.TEMPFAC
+          String tftString = subVals.get("tempfac");
+          TFType tft = avm.getBoolean(Arg.NOTEMPFAC) ? null
+                  : TFType.DEFAULT;
+          ArgValue tftAv = getArgAssociatedWithStructure(Arg.TEMPFAC, avm,
+                  af, structureFilepath);
+          if (tftString == null && tftAv != null)
           {
-            paePath = paeFile.getAbsolutePath();
-            Console.warn(
-                    "Problem with the PAE file path: '" + paePath + "'");
+            tftString = tftAv.getSubVals().getContent();
           }
-          String structid = null;
-          String structfile = null;
-          String seqid = null;
-          if (subVals.notSet())
+          if (tftString != null)
           {
-            ArgValue likelyStructure = avm
-                    .getClosestPreviousArgValueOfArg(av, Arg.STRUCTURE);
-            if (likelyStructure != null)
+            // get kind of temperature factor annotation
+            try
             {
-              SubVals sv = likelyStructure.getSubVals();
-              if (sv != null && sv.has(ArgValues.ID))
-              {
-                structid = sv.get(ArgValues.ID);
-              }
-              else
+              tft = TFType.valueOf(tftString.toUpperCase(Locale.ROOT));
+              Console.debug("Obtained Temperature Factor type of '" + tft
+                      + "' for structure '" + structureFilepath + "'");
+            } catch (IllegalArgumentException e)
+            {
+              // Just an error message!
+              StringBuilder sb = new StringBuilder().append("Cannot set ")
+                      .append(Arg.TEMPFAC.argString()).append(" to '")
+                      .append(tft)
+                      .append("', ignoring.  Valid values are: ");
+              Iterator<TFType> it = Arrays.stream(TFType.values())
+                      .iterator();
+              while (it.hasNext())
               {
-                structfile = likelyStructure.getValue();
+                sb.append(it.next().toString().toLowerCase(Locale.ROOT));
+                if (it.hasNext())
+                  sb.append(", ");
               }
+              Console.warn(sb.toString());
             }
           }
-          else if (subVals.has("structfile"))
-          {
-            structfile = subVals.get("structfile");
-          }
-          else if (subVals.has("structid"))
-          {
-            structid = subVals.get("structid");
-          }
-          if (structfile != null)
-          {
-            Console.info("***** Attaching paeFile '" + paePath + "' to "
-                    + "structfile=" + subVals.get("structfile"));
-            EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
-                    paeFile, subVals.getIndex(), subVals.get("structfile"),
-                    true, false, paeLabel);
-          }
-          else if (structid != null)
-          {
-            Console.info("***** Attaching paeFile '" + paePath + "' to "
-                    + "structid=" + subVals.get("structid"));
-            EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
-                    paeFile, subVals.getIndex(), subVals.get("structid"),
-                    true, true, paeLabel);
-          }
-          else
-          {
-            Console.debug("***** Attaching paeFile '" + paePath
-                    + "' to sequence index " + subVals.getIndex());
-            EBIAlfaFold.addAlphaFoldPAE(af.getCurrentView().getAlignment(),
-                    paeFile, subVals.getIndex(), null, false, false,
-                    paeLabel);
-            // required to readjust the height and position of the pAE
-            // annotation
-          }
-          for (AlignmentViewPanel ap : af.getAlignPanels())
-          {
-            ap.adjustAnnotationHeight();
-          }
+
+          // TODO pass PAE label
+          StructureChooser.openStructureFileForSequence(null, null, ap, seq,
+                  false, structureFilepath, tft, paeFilepath);
         }
       }
     }
@@ -613,7 +539,7 @@ public class Commands
       for (ArgValue av : avm.getArgValueList(Arg.IMAGE))
       {
         String val = av.getValue();
-        SubVals subVal = new SubVals(val);
+        SubVals subVal = av.getSubVals();
         String type = "png"; // default
         String fileName = subVal.getContent();
         File file = new File(fileName);
@@ -651,7 +577,8 @@ public class Commands
           htmlSVG.exportHTML(fileName);
           break;
         default:
-          Console.warn("--image type '" + type + "' not known. Ignoring");
+          Console.warn(Arg.IMAGE.argString() + " type '" + type
+                  + "' not known. Ignoring");
           break;
         }
       }
@@ -661,15 +588,70 @@ public class Commands
 
   private SequenceI getSpecifiedSequence(AlignFrame af, SubVals subId)
   {
+    if (subId == null)
+      return null;
     AlignmentI al = af.getCurrentView().getAlignment();
-    if (-1 < subId.getIndex()
+    if (subId.has("seqid"))
+    {
+      return al.findName(subId.get("seqid"));
+    }
+    else if (-1 < subId.getIndex()
             && subId.getIndex() < al.getSequences().size())
     {
       return al.getSequenceAt(subId.getIndex());
     }
-    else if (subId.has("seqid"))
+    return null;
+  }
+
+  // returns the first Arg value intended for the structure structFilename
+  // (in the given AlignFrame from the ArgValuesMap)
+  private ArgValue getArgAssociatedWithStructure(Arg arg, ArgValuesMap avm,
+          AlignFrame af, String structFilename)
+  {
+    if (af != null)
     {
-      return al.findName(subId.get("seqid"));
+      for (ArgValue av : avm.getArgValueList(arg))
+      {
+        SubVals subVals = av.getSubVals();
+        String structid = subVals.get("structid");
+        String structfile = subVals.get("structfile");
+
+        // let's find a structure
+        if (structfile == null && structid == null)
+        {
+          ArgValue likelyStructure = avm.getClosestPreviousArgValueOfArg(av,
+                  Arg.STRUCTURE);
+          if (likelyStructure != null)
+          {
+            SubVals sv = likelyStructure.getSubVals();
+            if (sv != null && sv.has(ArgValues.ID))
+            {
+              structid = sv.get(ArgValues.ID);
+            }
+            else
+            {
+              structfile = likelyStructure.getValue();
+              Console.debug(
+                      "##### Comparing closest previous structure argument '"
+                              + structfile + "'");
+            }
+          }
+        }
+
+        if (structfile == null && structid != null)
+        {
+          StructureSelectionManager ssm = StructureSelectionManager
+                  .getStructureSelectionManager(Desktop.instance);
+          if (ssm != null)
+          {
+            structfile = ssm.findFileForPDBId(structid);
+          }
+        }
+        if (structfile != null && structfile.equals(structFilename))
+        {
+          return av;
+        }
+      }
     }
     return null;
   }