Merge branch 'bug/JAL-3574filterByPOS' into documentation/JAL-3407_2.11.1_release
authorJim Procter <jprocter@issues.jalview.org>
Tue, 21 Apr 2020 17:06:17 +0000 (18:06 +0100)
committerJim Procter <jprocter@issues.jalview.org>
Tue, 21 Apr 2020 17:06:17 +0000 (18:06 +0100)
29 files changed:
build.gradle
doc/building.md
examples/groovy/ComputePeptideVariants.groovy [new file with mode: 0644]
help/help/help.jhm
help/help/helpTOC.xml
help/help/html/features/importvcf.html
help/help/html/features/seqfeaturereport.html [new file with mode: 0644]
help/help/html/features/seqfeaturesrep.png [new file with mode: 0644]
help/help/html/features/splitView.html
help/help/html/menus/popupMenu.html
help/help/html/releases.html
help/help/html/whatsNew.html
src/jalview/appletgui/APopupMenu.java
src/jalview/datamodel/MappedFeatures.java
src/jalview/datamodel/SequenceFeature.java
src/jalview/gui/IdPanel.java
src/jalview/gui/PopupMenu.java
src/jalview/gui/SeqPanel.java
src/jalview/io/FeaturesFile.java
src/jalview/io/SequenceAnnotationReport.java
src/jalview/io/StockholmFile.java
src/jalview/util/DBRefUtils.java
src/jalview/viewmodel/seqfeatures/FeatureRendererModel.java
test/jalview/datamodel/SequenceFeatureTest.java
test/jalview/gui/FreeUpMemoryTest.java
test/jalview/io/SequenceAnnotationReportTest.java
test/jalview/io/StockholmFileTest.java
test/jalview/util/DBRefUtilsTest.java
utils/install4j/install4j8_template.install4j

index a3aaa67..f7233f1 100644 (file)
@@ -78,6 +78,26 @@ ext {
     }
   }
 
+  ////  
+  // Import releaseProps from the RELEASE file
+  // or a file specified via JALVIEW_RELEASE_FILE if defined
+  // Expect jalview.version and target release branch in jalview.release        
+  def releaseProps = new Properties();
+  def releasePropFile = findProperty("JALVIEW_RELEASE_FILE");
+  def defaultReleasePropFile = "${jalviewDirAbsolutePath}/RELEASE";
+  try {
+    (new File(releasePropFile!=null ? releasePropFile : defaultReleasePropFile)).withInputStream { 
+     releaseProps.load(it)
+    }
+  } catch (Exception fileLoadError) {
+    throw new Error("Couldn't load release properties file "+(releasePropFile==null ? defaultReleasePropFile : "from custom location: releasePropFile"),fileLoadError);
+  }
+  ////
+  // Set JALVIEW_VERSION if it is not already set
+  if (findProperty(JALVIEW_VERSION)==null || "".equals(JALVIEW_VERSION)) {
+    JALVIEW_VERSION = releaseProps.get("jalview.version")
+  }
+  
   // this property set when running Eclipse headlessly
   j2sHeadlessBuildProperty = string("net.sf.j2s.core.headlessbuild")
   // this property set by Eclipse
@@ -202,6 +222,11 @@ ext {
 
     case "DEVELOP":
     reportRsyncCommand = true
+    
+    // DEVELOP-RELEASE is usually associated with a Jalview release series so set the version
+    JALVIEW_VERSION=JALVIEW_VERSION+"-develop"
+    
+    install4jSuffix = "Develop"
     install4jDSStore = "DS_Store-DEVELOP"
     install4jDMGBackgroundImage = "jalview_dmg_background-DEVELOP.png"
     install4jExtraScheme = "jalviewd"
@@ -210,7 +235,10 @@ ext {
 
     case "TEST-RELEASE":
     reportRsyncCommand = true
-    JALVIEW_VERSION = "TEST"
+    
+    // TEST-RELEASE is usually associated with a Jalview release series so set the version
+    JALVIEW_VERSION=JALVIEW_VERSION+"-test"
+    
     install4jSuffix = "Test"
     install4jDSStore = "DS_Store-TEST-RELEASE"
     install4jDMGBackgroundImage = "jalview_dmg_background-TEST.png"
index 398181a..ad19979 100644 (file)
@@ -165,6 +165,7 @@ Within the `jalview` folder you will find (of possible interest):
  `utils/install4j/`  | files used by the packaging tool, install4j
  `build.gradle`      | the build file used by gradle
  `gradle.properties` | configurable properties for the build process
+ `RELEASE`          | propertyfile configuring JALVIEW_VERSION (from jalview.version) and the release branch (from jalview.release). An alternative file can be specified via JALVIEW_RELEASE_FILE property
 
 Note that you need a Java 11 JDK to compile Jalview whether your target build is Java 1.8 or Java 11.
 
@@ -422,7 +423,7 @@ There are several values of `CHANNEL` that can be chosen, with a default of `LOC
       Note that bamboo_planKey should be set by the build plan with `-Pbamboo_planKey=${bamboo.planKey}`
     - application subdir as `alt`
     - Getdown launcher cannot use a `file://` scheme appbase. 
-* `DEVELOP`: This is for creating a `develop` appbase channel on the main web server.  This won't become live until the actual getdown artefact is synced to the web server.
+* `DEVELOP`: This is for creating a `develop` appbase channel on the main web server. This won't become live until the actual getdown artefact is synced to the web server.
   It will set
     - `appbase` as `http://www.jalview.org/getdown/develop/JAVA_VERSION`
     - application subdir as `alt`
@@ -465,6 +466,13 @@ e.g.
 gradle getdown -PCHANNEL=SCRATCH-my_test_version
 ```
 
+#### JALVIEW_VERSION and the RELEASE file
+Any Jalview build will include the value of JALVIEW_VERSION in various places, including the 'About' and Jalview Desktop window title, and in filenames for the stand-alone executable jar. You can specify a custom version for a build via the JALVIEW_VERSION property, but for most situations, JALVIEW_VERSION will be automatically configured according to the value of the CHANNEL property, using the `jalview.version` property specified in the RELEASE file:
+  - `CHANNEL=RELEASE` will set version to jalview.version
+  - `CHANNEL=TEST or DEVELOP` will append '-test' or '-develop' to jalview.version
+  
+It is also possible to specify a custom location for the RELEASE file via an optional JALVIEW_RELEASE_FILE property.
+
 #### `install4jMediaTypes`
 If you are building *install4j* installers (requires *install4j* to be installed) then this property specifies a comma-separated 
 list of media types (i.e. platform specific installers) *install4j* should actually build.
diff --git a/examples/groovy/ComputePeptideVariants.groovy b/examples/groovy/ComputePeptideVariants.groovy
new file mode 100644 (file)
index 0000000..6caa69c
--- /dev/null
@@ -0,0 +1,32 @@
+import jalview.datamodel.SequenceFeature
+import jalview.gui.Desktop
+def af = jalview.bin.Jalview.currentAlignFrame
+def av = af.viewport
+def fr = Desktop.getAlignFrameFor(av.codingComplement).getFeatureRenderer()
+def counts = 0
+def countm = 0
+for (seq in av.alignment.sequences) 
+{
+   ds = seq.datasetSequence
+   for (res = ds.start ; res <= ds.end; res++) 
+   {
+     mf = fr.findComplementFeaturesAtResidue(seq, res)
+     if (mf != null)
+     {
+         for (feature in mf.features)
+         {
+           variant = mf.findProteinVariants(feature)
+           if (!"".equals(variant))
+           {
+               type = variant.contains("=") ? "synonymous_variant" : "missense_variant"
+               if (type.equals("synonymous_variant")) counts++ else countm++;
+               sf = new SequenceFeature(type, variant, res, res, null)
+               seq.addSequenceFeature(sf)
+           }
+         }
+     }
+   }
+}
+af.getFeatureRenderer().featuresAdded()
+af.alignPanel.paintAlignment(true, true)
+println "Added " + countm + " missense and " + counts + " synonymous variants"
\ No newline at end of file
index aecd1a4..99d010d 100755 (executable)
@@ -47,6 +47,7 @@
    <mapID target="seqfeatures" url="html/features/seqfeatures.html"/>
    <mapID target="seqfeatedit" url="html/features/editingFeatures.html"/>
    <mapID target="seqfeatcreat" url="html/features/creatinFeatures.html"/>
+   <mapID target="seqfeatures.report" url="html/features/seqfeaturereport.html"/>
    <mapID target="seqfeatures.settings" url="html/features/featuresettings.html"/>
    <mapID target="seqfeatures.settings.selcols" url="html/features/featuresettings.html#selectbyfeature"/>
    <mapID target="viewingpdbs" url="html/features/viewingpdbs.html"/>
index 5802ddb..a0c7fe6 100755 (executable)
@@ -63,6 +63,7 @@
                        <tocitem text="Feature Colourschemes" target="features.featureschemes" />
                        <tocitem text="User Defined Sequence Features" target="seqfeatcreat" />
                        <tocitem text="Editing Sequence Features" target="seqfeatedit" />
+                       <tocitem text="HTML Feature Attributes report" target="seqfeatures.report" />
                        <tocitem text="HTML annotation report" target="io.seqreport" />
                </tocitem>
                
index 511ff2e..7b699eb 100755 (executable)
     for more information.
   </p>
   <p>
+    <strong>Working with variants without CSQ fields</strong>
+  </p>
+  <p>
+    <a name="computepepvariants">Jalview 2.11.1's new virtual
+      features</a> mean that peptide sequences are no longer annotated
+    directly with protein missense variants. This makes it harder to
+    filter variants when they do not already include the CSQ field. You
+    can rescue the pre-2.11.1 functionality by:
+  </p>
+  <ol>
+    <li>Download the script at
+      https://www.jalview.org/examples/groovy/ComputePeptideVariants.groovy</li>
+    <li>Executing the script via the <a href="groovy.html">Groovy
+        Console</a> on a linked CDS/Protein view to create missense and
+      synonymous peptide variant features.
+    </li>
+  </ol>
+  <p>
     <strong>Working with variants from organisms other than
       H.sapiens.</strong>
   </p>
diff --git a/help/help/html/features/seqfeaturereport.html b/help/help/html/features/seqfeaturereport.html
new file mode 100644 (file)
index 0000000..340df5c
--- /dev/null
@@ -0,0 +1,54 @@
+<html>
+<!--
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ * 
+ * This file is part of Jalview.
+ * 
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License 
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *  
+ * Jalview is distributed in the hope that it will be useful, but 
+ * WITHOUT ANY WARRANTY; without even the implied warranty 
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+ * PURPOSE.  See the GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ -->
+<head>
+<title>Sequence Feature Reports</title>
+</head>
+<body>
+  <p>
+    <strong>Sequence Feature Reports</strong> <br /> Sequence features
+    can carry a number of attributes. To view all the attributes for a
+    particular sequence feature, mouse over the feature and <em>right-click</em>
+    to open the <a href="../menus/popupMenu.html#featuredetails">Popup Menu</a> and
+    select the feature's entry from the <em>Feature Details</em>
+    submenu.
+  </p>
+  <img src="seqfeaturesrep.png" width="460"
+    alt="Full details for a particular Sequence Feature can be displayed as HTML in a report window" />
+  <p>
+    <em>Virtual Feature Reports</em><br /> When a sequence feature
+    report is shown for features mapped between CDS and Protein
+    sequences, the report will include both the original and mapped
+    feature's location.
+  </p>
+  <p>
+    <strong>Copying and pasting annotation to other programs</strong><br>
+    The <strong>File&rarr;Save</strong> option in the sequence
+    annotation report window allows the report to be saved as HTML,
+    which will preserve links and any other metadata. It is also
+    possible to copy and paste the text to other programs, but in some
+    cases, the HTML will not be preserved. In that case, you can toggle
+    the display of HTML source code with the <strong>Edit&rarr;Show
+      HTML Source</strong> drop down menu entry.
+  </p>
+  <em>Feature Reports were added in Jalview 2.11.</em>
+</body>
+</html>
diff --git a/help/help/html/features/seqfeaturesrep.png b/help/help/html/features/seqfeaturesrep.png
new file mode 100644 (file)
index 0000000..f5995a1
Binary files /dev/null and b/help/help/html/features/seqfeaturesrep.png differ
index 03b9ced..bb379ed 100644 (file)
       settings tabs and corresponding views showing 'Virtual Features'
       from each view overlaid on the other (created with Jalview 2.11.1.0).</em>
   </p>
-  <p>When virtual features are enabled, they are also shown on any
-    linked 3D structure views when 'Colour by Sequence' is enabled, and
+  <p>
+    When virtual features are enabled, they are also shown on any linked
+    3D structure views when 'Colour by Sequence' is enabled, and
     exported as GFF and Jalview Features files (mapped to their
-    associated virtual coordinates).</p>
+    associated virtual coordinates). Both the original and the mapped
+    locations are also included in <a href="seqfeaturereport.html">Sequence
+      Feature Reports</a>.
+  </p>
   <p>
     <strong>Operations supported in Split Frame Mode</strong>
   </p>
index 7625606..9c65e1a 100755 (executable)
   <p>
     <strong>Popup Menu</strong><br> <em>This menu is visible
       when right clicking either within a selected region on the
-      alignment or on a selected sequence name. It may not be accessible
+      alignment, on a sequence name, and also when right-clicking a sequence feature. It may not be accessible
       when in 'Cursor Mode' (toggled with the F2 key).</em><br /> <em><strong>Mac
         Users:</strong> pressing CTRL whilst clicking the mouse/track pad is the
       same as a right-click. See your system's settings to configure
       your track-pad's corners to generate right-clicks.</em>
   </p>
   <ul>
-    <li><strong>Selection</strong>
+    <li><strong>Selection<br/></strong>
+    <em>This menu is only visible when right-clicking a selected sequence or region of the alignment. </em>
       <ul>
         <li><a name="sqreport"><strong>Sequence
               Details...<br>
         according to gaps in just the current sequence)</em></li>
     <li><strong>Hide Sequences</strong><br> <em>Hides the
         currently selected sequences in this alignment view.</em><strong><br>
-    </strong></li>
+    </strong><br/>&nbsp;<br/></li>
+    
+    <li><strong><a name="featuredetails"> Feature Details</a><br /></strong>
+    <em>Each entry opens a <a
+      href="../features/seqfeaturereport.html">Sequence Feature
+        Report</a> for visible features under the mouse.<br />Only visible
+      when right-clicking a region where <a
+      href="../features/seqfeatures.html">Sequence Features</a> are
+      shown.
+    </em>
+  </li>
   </ul>
+  
 </body>
 </html>
index 0097655..60e3179 100755 (executable)
@@ -58,13 +58,13 @@ li:before {
     <tr>
       <td width="60" align="center" nowrap><strong><a
           id="Jalview.2.11.1">2.11.1</a><a id="Jalview.2.11.1.0">.0</a><br />
-          <em>9/04/2020</em></strong></td>
+          <em>22/04/2020</em></strong></td>
       <td align="left" valign="top">
         <ul>
           <li>
-            <!-- JAL-3187,JAL-3305,JAL-3304,JAL-3302 -->Map 'virtual'
+            <!-- JAL-3187,JAL-3305,JAL-3304,JAL-3302,JAL-3567 -->Map 'virtual'
             codon features shown on protein (or vice versa) for display
-            in alignments, on structure views and for export.
+            in alignments, on structure views, in feature reports and for export.
           </li>
           <li>
             <!-- JAL-3121 -->Feature attributes from VCF files can be
@@ -139,6 +139,11 @@ li:before {
             to stdout containing the consensus sequence for each
             alignment in a Jalview session
           </li>
+          <li>
+            <!-- JAL-3578 -->ComputePeptideVariants.groovy to translate
+            genomic sequence_variant annotation from CDS as
+            missense_variant or synonymous_variant on protein products.
+          </li>
         </ul>
       </td>
       <td align="left" valign="top">
@@ -201,6 +206,11 @@ li:before {
             <!-- JAL-3406 -->Credits missing some authors in Jalview
             help documentation for 2.11.0 release
           </li>
+          <li>
+            <!-- JAL-3529 -->Export of Pfam alignment as Stockholm
+            includes Pfam ID as sequence's accession rather than its
+            Uniprot Accession
+          </li>
         </ul> <em>Java 11 Compatibility issues</em>
         <ul>
           <li>
@@ -243,6 +253,9 @@ li:before {
             <!-- JAL-3562 -->Test Suite: Certain Functional tests fail on jalview's
             bamboo server but run fine locally.
           </li>
+          <li>
+            <!-- JAL-3574 -->Filtering features by genomic location (POS) is broken by rounding
+          </li>
         </ul>
       </td>
     </tr>
index 00f9466..0f0c7f1 100755 (executable)
       <a href="features/splitView.html#virtualfeats">Sequence
         Features dialog</a>. This allows more analyses of nucleotide and
       peptide sequence features on alignments in a more flexible and
-      memory efficient way than in earlier versions.</li>
+      memory efficient way than in earlier versions.<br />
+    <em>Note: Virtual features work best when variants are
+        annotated with CSQ fields. Please <a
+        href="features/importvcf.html#computepepvariants">see this
+          Groovy script workaround</a> if you are working with VCF files
+        without CSQ fields.
+    </em></li>
     <li><strong>Improved VCF data import</strong><br /> <a
       href="features/importvcf.html#attribs">Standard attributes for
         filtering variants</a> (e.g. position, QUAL field etc) are now
index 76f2705..6299c62 100644 (file)
  */
 package jalview.appletgui;
 
+import java.awt.CheckboxMenuItem;
+import java.awt.Frame;
+import java.awt.Menu;
+import java.awt.MenuItem;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.ItemEvent;
+import java.awt.event.ItemListener;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.SortedMap;
+import java.util.TreeMap;
+import java.util.Vector;
+
 import jalview.analysis.AAFrequency;
 import jalview.analysis.AlignmentAnnotationUtils;
 import jalview.analysis.AlignmentUtils;
@@ -57,25 +76,6 @@ import jalview.schemes.ZappoColourScheme;
 import jalview.util.MessageManager;
 import jalview.util.UrlLink;
 
-import java.awt.CheckboxMenuItem;
-import java.awt.Frame;
-import java.awt.Menu;
-import java.awt.MenuItem;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
-import java.awt.event.ItemEvent;
-import java.awt.event.ItemListener;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.SortedMap;
-import java.util.TreeMap;
-import java.util.Vector;
-
 public class APopupMenu extends java.awt.PopupMenu
         implements ActionListener, ItemListener
 {
@@ -900,7 +900,7 @@ public class APopupMenu extends java.awt.PopupMenu
       contents.append(MessageManager
               .formatMessage("label.annotation_for_displayid", new Object[]
               { seq.getDisplayId(true) }));
-      new SequenceAnnotationReport(null).createSequenceAnnotationReport(
+      new SequenceAnnotationReport(false).createSequenceAnnotationReport(
               contents, seq, true, true, ap.seqPanel.seqCanvas.fr);
       contents.append("</p>");
     }
index 0fa03cf..87609c6 100644 (file)
@@ -1,14 +1,15 @@
 package jalview.datamodel;
 
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
 import jalview.io.gff.Gff3Helper;
 import jalview.schemes.ResidueProperties;
+import jalview.util.MapList;
 import jalview.util.MappingUtils;
 import jalview.util.StringUtils;
 
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-
 /**
  * A data bean to hold a list of mapped sequence features (e.g. CDS features
  * mapped from protein), and the mapping between the sequences. It also provides
@@ -18,22 +19,26 @@ import java.util.Set;
  */
 public class MappedFeatures
 {
+  /*
+   * VEP CSQ:HGVSp (if present) is a short-cut to the protein variant consequence
+   */
   private static final String HGV_SP = "HGVSp";
 
   private static final String CSQ = "CSQ";
 
   /*
-   * the mapping from one sequence to another
+   * the sequence the mapped features are on
    */
-  public final Mapping mapping;
+  private final SequenceI featureSequence;
 
-  /**
-   * the sequence mapped from
+  /*
+   * the mapping between sequences;
+   * NB this could be in either sense (from or to featureSequence)
    */
-  public final SequenceI fromSeq;
+  private final Mapping mapping;
 
   /*
-   * features on the sequence mapped to that overlap the mapped positions
+   * features on featureSequence that overlap the mapped positions
    */
   public final List<SequenceFeature> features;
 
@@ -60,21 +65,23 @@ public class MappedFeatures
    * Constructor
    * 
    * @param theMapping
-   * @param from
-   *                      the sequence mapped from (e.g. CDS)
+   *          sequence mapping (which may be either to, or from, the sequence
+   *          holding the linked features)
+   * @param featureSeq
+   *          the sequence hosting the virtual features
    * @param pos
-   *                      the residue position in the sequence mapped to
+   *          the residue position in the sequence mapped to
    * @param res
-   *                      the residue character at position pos
+   *          the residue character at position pos
    * @param theFeatures
-   *                      list of mapped features found in the 'from' sequence at
-   *                      the mapped position(s)
+   *          list of mapped features found in the 'featureSeq' sequence at the
+   *          mapped position(s)
    */
-  public MappedFeatures(Mapping theMapping, SequenceI from, int pos,
+  public MappedFeatures(Mapping theMapping, SequenceI featureSeq, int pos,
           char res, List<SequenceFeature> theFeatures)
   {
     mapping = theMapping;
-    fromSeq = from;
+    featureSequence = featureSeq;
     toPosition = pos;
     toResidue = res;
     features = theFeatures;
@@ -90,13 +97,13 @@ public class MappedFeatures
     {
       codonPos = codonPositions;
       baseCodon = new char[3];
-      int cdsStart = fromSeq.getStart();
+      int cdsStart = featureSequence.getStart();
       baseCodon[0] = Character
-              .toUpperCase(fromSeq.getCharAt(codonPos[0] - cdsStart));
+              .toUpperCase(featureSequence.getCharAt(codonPos[0] - cdsStart));
       baseCodon[1] = Character
-              .toUpperCase(fromSeq.getCharAt(codonPos[1] - cdsStart));
+              .toUpperCase(featureSequence.getCharAt(codonPos[1] - cdsStart));
       baseCodon[2] = Character
-              .toUpperCase(fromSeq.getCharAt(codonPos[2] - cdsStart));
+              .toUpperCase(featureSequence.getCharAt(codonPos[2] - cdsStart));
     }
     else
     {
@@ -108,11 +115,14 @@ public class MappedFeatures
   /**
    * Computes and returns comma-delimited HGVS notation peptide variants derived
    * from codon allele variants. If no variants are found, answers an empty
-   * string.
+   * string. The peptide variant is either simply read from the "CSQ:HGVSp"
+   * attribute if present, else computed based on the "alleles" attribute if
+   * present. If neither attribute is found, no variant (empty string) is
+   * returned.
    * 
    * @param sf
-   *             a sequence feature (which must be one of those held in this
-   *             object)
+   *          a sequence feature (which must be one of those held in this
+   *          object)
    * @return
    */
   public String findProteinVariants(SequenceFeature sf)
@@ -233,4 +243,53 @@ public class MappedFeatures
 
     return vars.toString();
   }
+
+  /**
+   * Answers the name of the linked sequence holding any mapped features
+   * 
+   * @return
+   */
+  public String getLinkedSequenceName()
+  {
+    return featureSequence == null ? null : featureSequence.getName();
+  }
+
+  /**
+   * Answers the mapped ranges (as one or more [start, end] positions) which
+   * correspond to the given [begin, end] range of the linked sequence.
+   * 
+   * <pre>
+   * Example: MappedFeatures with CDS features mapped to peptide 
+   * CDS/200-220 gtc aac TGa acGt att AAC tta
+   * mapped to PEP/6-7 WN by mapping [206, 207, 210, 210, 215, 217] to [6, 7]
+   * getMappedPositions(206, 206) should return [6, 6]
+   * getMappedPositions(200, 214) should return [6, 6]
+   * getMappedPositions(210, 215) should return [6, 7]
+   * </pre>
+   * 
+   * @param begin
+   * @param end
+   * @return
+   */
+  public int[] getMappedPositions(int begin, int end)
+  {
+    MapList map = mapping.getMap();
+    return mapping.to == featureSequence ? map.locateInFrom(begin, end)
+            : map.locateInTo(begin, end);
+  }
+
+  /**
+   * Answers true if the linked features are on coding sequence, false if on
+   * peptide
+   * 
+   * @return
+   */
+  public boolean isFromCds()
+  {
+    if (mapping.getMap().getFromRatio() == 3)
+    {
+      return mapping.to != featureSequence;
+    }
+    return mapping.to == featureSequence;
+  }
 }
index 2dd9cf0..6eeba2f 100755 (executable)
  */
 package jalview.datamodel;
 
-import jalview.datamodel.features.FeatureAttributeType;
-import jalview.datamodel.features.FeatureAttributes;
-import jalview.datamodel.features.FeatureLocationI;
-import jalview.datamodel.features.FeatureSourceI;
-import jalview.datamodel.features.FeatureSources;
-import jalview.util.StringUtils;
-
 import java.util.Comparator;
 import java.util.LinkedHashMap;
 import java.util.Map;
@@ -35,6 +28,13 @@ import java.util.SortedMap;
 import java.util.TreeMap;
 import java.util.Vector;
 
+import jalview.datamodel.features.FeatureAttributeType;
+import jalview.datamodel.features.FeatureAttributes;
+import jalview.datamodel.features.FeatureLocationI;
+import jalview.datamodel.features.FeatureSourceI;
+import jalview.datamodel.features.FeatureSources;
+import jalview.util.StringUtils;
+
 /**
  * A class that models a single contiguous feature on a sequence. If flag
  * 'contactFeature' is true, the start and end positions are interpreted instead
@@ -586,13 +586,17 @@ public class SequenceFeature implements FeatureLocationI
   }
 
   /**
-   * Answers an html-formatted report of feature details
+   * Answers an html-formatted report of feature details. If parameter
+   * {@code mf} is not null, the feature is a virtual linked feature, and
+   * details included both the original location and the mapped location
+   * (CDS/peptide).
    * 
    * @param seqName
+   * @param mf
    * 
    * @return
    */
-  public String getDetailsReport(String seqName)
+  public String getDetailsReport(String seqName, MappedFeatures mf)
   {
     FeatureSourceI metadata = FeatureSources.getInstance()
             .getSource(source);
@@ -600,9 +604,26 @@ public class SequenceFeature implements FeatureLocationI
     StringBuilder sb = new StringBuilder(128);
     sb.append("<br>");
     sb.append("<table>");
-    sb.append(String.format(ROW_DATA, "Location", seqName,
+    String name = mf == null ? seqName : mf.getLinkedSequenceName();
+    sb.append(String.format(ROW_DATA, "Location", name,
             begin == end ? begin
                     : begin + (isContactFeature() ? ":" : "-") + end));
+
+    String consequence = "";
+    if (mf != null)
+    {
+      int[] beginRange = mf.getMappedPositions(begin, begin);
+      int[] endRange = mf.getMappedPositions(end, end);
+      int from = beginRange[0];
+      int to = endRange[endRange.length - 1];
+      String s = mf.isFromCds() ? "Peptide Location" : "Coding location";
+      sb.append(String.format(ROW_DATA, s, seqName, from == to ? from
+              : from + (isContactFeature() ? ":" : "-") + to));
+      if (mf.isFromCds())
+      {
+        consequence = mf.findProteinVariants(this);
+      }
+    }
     sb.append(String.format(ROW_DATA, "Type", type, ""));
     String desc = StringUtils.stripHtmlTags(description);
     sb.append(String.format(ROW_DATA, "Description", desc, ""));
@@ -615,6 +636,12 @@ public class SequenceFeature implements FeatureLocationI
       sb.append(String.format(ROW_DATA, "Group", featureGroup, ""));
     }
 
+    if (!consequence.isEmpty())
+    {
+      sb.append(String.format(ROW_DATA, "Consequence",
+              "<i>Translated by Jalview</i>", consequence));
+    }
+
     if (otherDetails != null)
     {
       TreeMap<String, Object> ordered = new TreeMap<>(
index 2b1507a..3ce9d4d 100755 (executable)
  */
 package jalview.gui;
 
-import jalview.datamodel.AlignmentAnnotation;
-import jalview.datamodel.Sequence;
-import jalview.datamodel.SequenceGroup;
-import jalview.datamodel.SequenceI;
-import jalview.gui.SeqPanel.MousePos;
-import jalview.io.SequenceAnnotationReport;
-import jalview.util.MessageManager;
-import jalview.util.Platform;
-import jalview.viewmodel.AlignmentViewport;
-import jalview.viewmodel.ViewportRanges;
-
 import java.awt.BorderLayout;
 import java.awt.event.MouseEvent;
 import java.awt.event.MouseListener;
@@ -44,6 +33,17 @@ import javax.swing.JPopupMenu;
 import javax.swing.SwingUtilities;
 import javax.swing.ToolTipManager;
 
+import jalview.datamodel.AlignmentAnnotation;
+import jalview.datamodel.Sequence;
+import jalview.datamodel.SequenceGroup;
+import jalview.datamodel.SequenceI;
+import jalview.gui.SeqPanel.MousePos;
+import jalview.io.SequenceAnnotationReport;
+import jalview.util.MessageManager;
+import jalview.util.Platform;
+import jalview.viewmodel.AlignmentViewport;
+import jalview.viewmodel.ViewportRanges;
+
 /**
  * This panel hosts alignment sequence ids and responds to mouse clicks on them,
  * as well as highlighting ids matched by a search from the Find menu.
@@ -62,8 +62,6 @@ public class IdPanel extends JPanel
 
   ScrollThread scrollThread = null;
 
-  String linkImageURL;
-
   int offy;
 
   // int width;
@@ -84,8 +82,7 @@ public class IdPanel extends JPanel
     this.av = av;
     alignPanel = parent;
     setIdCanvas(new IdCanvas(av));
-    linkImageURL = getClass().getResource("/images/link.gif").toString();
-    seqAnnotReport = new SequenceAnnotationReport(linkImageURL);
+    seqAnnotReport = new SequenceAnnotationReport(true);
     setLayout(new BorderLayout());
     add(getIdCanvas(), BorderLayout.CENTER);
     addMouseListener(this);
index 187090b..568f7f1 100644 (file)
  */
 package jalview.gui;
 
+import java.awt.Color;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.BitSet;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Hashtable;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.SortedMap;
+import java.util.TreeMap;
+import java.util.Vector;
+
+import javax.swing.ButtonGroup;
+import javax.swing.JCheckBoxMenuItem;
+import javax.swing.JColorChooser;
+import javax.swing.JMenu;
+import javax.swing.JMenuItem;
+import javax.swing.JPopupMenu;
+import javax.swing.JRadioButtonMenuItem;
+
 import jalview.analysis.AAFrequency;
 import jalview.analysis.AlignmentAnnotationUtils;
 import jalview.analysis.AlignmentUtils;
@@ -56,31 +81,6 @@ import jalview.util.StringUtils;
 import jalview.util.UrlLink;
 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
 
-import java.awt.Color;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.BitSet;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.Hashtable;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-import java.util.SortedMap;
-import java.util.TreeMap;
-import java.util.Vector;
-
-import javax.swing.ButtonGroup;
-import javax.swing.JCheckBoxMenuItem;
-import javax.swing.JColorChooser;
-import javax.swing.JMenu;
-import javax.swing.JMenuItem;
-import javax.swing.JPopupMenu;
-import javax.swing.JRadioButtonMenuItem;
-
 /**
  * The popup menu that is displayed on right-click on a sequence id, or in the
  * sequence alignment.
@@ -755,14 +755,16 @@ public class PopupMenu extends JPopupMenu implements ColourChangeListener
   }
 
   /**
-   * Add a link to show feature details for each sequence feature
+   * Add a menu item to show feature details for each sequence feature. Any
+   * linked 'virtual' features (CDS/protein) are also optionally found and
+   * included.
    * 
    * @param features
-   * @param column
    * @param seq
+   * @param column
    */
   protected void addFeatureDetails(List<SequenceFeature> features,
-          SequenceI seq, int column)
+          final SequenceI seq, final int column)
   {
     /*
      * add features in CDS/protein complement at the corresponding
@@ -797,39 +799,49 @@ public class PopupMenu extends JPopupMenu implements ColourChangeListener
     String name = seq.getName();
     for (final SequenceFeature sf : features)
     {
-      addFeatureDetailsMenuItem(details, name, sf);
+      addFeatureDetailsMenuItem(details, name, sf, null);
     }
 
     if (mf != null)
     {
-      name = mf.fromSeq == seq ? mf.mapping.getTo().getName()
-              : mf.fromSeq.getName();
       for (final SequenceFeature sf : mf.features)
       {
-        addFeatureDetailsMenuItem(details, name, sf);
+        addFeatureDetailsMenuItem(details, name, sf, mf);
       }
     }
   }
 
   /**
-   * A helper method to add one menu item whose action is to show details for one
-   * feature. The menu text includes feature description, but this may be
+   * A helper method to add one menu item whose action is to show details for
+   * one feature. The menu text includes feature description, but this may be
    * truncated.
    * 
    * @param details
    * @param seqName
    * @param sf
+   * @param mf
    */
   void addFeatureDetailsMenuItem(JMenu details, final String seqName,
-          final SequenceFeature sf)
+          final SequenceFeature sf, MappedFeatures mf)
   {
     int start = sf.getBegin();
     int end = sf.getEnd();
+    if (mf != null)
+    {
+      /*
+       * show local rather than linked feature coordinates
+       */
+      int[] beginRange = mf.getMappedPositions(start, start);
+      start = beginRange[0];
+      int[] endRange = mf.getMappedPositions(end, end);
+      end = endRange[endRange.length - 1];
+    }
     StringBuilder desc = new StringBuilder();
     desc.append(sf.getType()).append(" ").append(String.valueOf(start));
     if (start != end)
     {
-      desc.append("-").append(String.valueOf(end));
+      desc.append(sf.isContactFeature() ? ":" : "-");
+      desc.append(String.valueOf(end));
     }
     String description = sf.getDescription();
     if (description != null)
@@ -860,26 +872,27 @@ public class PopupMenu extends JPopupMenu implements ColourChangeListener
       @Override
       public void actionPerformed(ActionEvent e)
       {
-        showFeatureDetails(seqName, sf);
+        showFeatureDetails(sf, seqName, mf);
       }
     });
     details.add(item);
   }
 
   /**
-   * Opens a panel showing a text report of feature dteails
-   * 
-   * @param seqName
+   * Opens a panel showing a text report of feature details
    * 
    * @param sf
+   * @param seqName
+   * @param mf
    */
-  protected void showFeatureDetails(String seqName, SequenceFeature sf)
+  protected void showFeatureDetails(SequenceFeature sf, String seqName,
+          MappedFeatures mf)
   {
     CutAndPasteHtmlTransfer cap = new CutAndPasteHtmlTransfer();
     // it appears Java's CSS does not support border-collapse :-(
     cap.addStylesheetRule("table { border-collapse: collapse;}");
     cap.addStylesheetRule("table, td, th {border: 1px solid black;}");
-    cap.setText(sf.getDetailsReport(seqName));
+    cap.setText(sf.getDetailsReport(seqName, mf));
 
     Desktop.addInternalFrame(cap,
             MessageManager.getString("label.feature_details"), 500, 500);
@@ -1763,7 +1776,7 @@ public class PopupMenu extends JPopupMenu implements ColourChangeListener
               "label.create_sequence_details_report_annotation_for",
               new Object[]
               { seq.getDisplayId(true) }) + "</h2></p><p>");
-      new SequenceAnnotationReport(null).createSequenceAnnotationReport(
+      new SequenceAnnotationReport(false).createSequenceAnnotationReport(
               contents, seq, true, true, ap.getSeqPanel().seqCanvas.fr);
       contents.append("</p>");
     }
index 27ceb27..f28217d 100644 (file)
@@ -207,8 +207,6 @@ public class SeqPanel extends JPanel
 
   StringBuffer keyboardNo2;
 
-  java.net.URL linkImageURL;
-
   private final SequenceAnnotationReport seqARep;
 
   StringBuilder tooltipText = new StringBuilder();
@@ -229,8 +227,7 @@ public class SeqPanel extends JPanel
    */
   public SeqPanel(AlignViewport viewport, AlignmentPanel alignPanel)
   {
-    linkImageURL = getClass().getResource("/images/link.gif");
-    seqARep = new SequenceAnnotationReport(linkImageURL.toString());
+    seqARep = new SequenceAnnotationReport(true);
     ToolTipManager.sharedInstance().registerComponent(this);
     ToolTipManager.sharedInstance().setInitialDelay(0);
     ToolTipManager.sharedInstance().setDismissDelay(10000);
@@ -1047,9 +1044,9 @@ public class SeqPanel extends JPanel
     {
       List<SequenceFeature> features = ap.getFeatureRenderer()
               .findFeaturesAtColumn(sequence, column + 1);
-      unshownFeatures = seqARep.appendFeaturesLengthLimit(tooltipText, pos,
-              features,
-              this.ap.getSeqPanel().seqCanvas.fr, MAX_TOOLTIP_LENGTH);
+      unshownFeatures = seqARep.appendFeatures(tooltipText, pos,
+              features, this.ap.getSeqPanel().seqCanvas.fr,
+              MAX_TOOLTIP_LENGTH);
 
       /*
        * add features in CDS/protein complement at the corresponding
@@ -1067,9 +1064,8 @@ public class SeqPanel extends JPanel
                   pos);
           if (mf != null)
           {
-            unshownFeatures = seqARep.appendFeaturesLengthLimit(
-                    tooltipText, pos, mf, fr2,
-                    MAX_TOOLTIP_LENGTH);
+            unshownFeatures = seqARep.appendFeatures(tooltipText,
+                    pos, mf, fr2, MAX_TOOLTIP_LENGTH);
           }
         }
       }
index a8a3746..92473ec 100755 (executable)
  */
 package jalview.io;
 
+import java.awt.Color;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.TreeMap;
+
 import jalview.analysis.AlignmentUtils;
 import jalview.analysis.SequenceIdMatcher;
 import jalview.api.AlignViewportI;
@@ -44,18 +56,6 @@ import jalview.util.MapList;
 import jalview.util.ParseHtmlBodyAndLinks;
 import jalview.util.StringUtils;
 
-import java.awt.Color;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Map.Entry;
-import java.util.TreeMap;
-
 /**
  * Parses and writes features files, which may be in Jalview, GFF2 or GFF3
  * format. These are tab-delimited formats but with differences in the use of
@@ -736,7 +736,6 @@ public class FeaturesFile extends AlignFile implements FeaturesSourceI
 
       if (mf != null)
       {
-        MapList mapping = mf.mapping.getMap();
         for (SequenceFeature sf : mf.features)
         {
           /*
@@ -752,9 +751,7 @@ public class FeaturesFile extends AlignFile implements FeaturesSourceI
             found.add(sf);
             int begin = sf.getBegin();
             int end = sf.getEnd();
-            int[] range = mf.mapping.getTo() == seq.getDatasetSequence()
-                    ? mapping.locateInTo(begin, end)
-                    : mapping.locateInFrom(begin, end);
+            int[] range = mf.getMappedPositions(begin, end);
             SequenceFeature sf2 = new SequenceFeature(sf, range[0],
                     range[1], group, sf.getScore());
             complementary.add(sf2);
index 0125277..27c1652 100644 (file)
  */
 package jalview.io;
 
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Comparator;
+import java.util.LinkedHashMap;
+import java.util.List;
+import java.util.Map;
+
 import jalview.api.FeatureColourI;
 import jalview.datamodel.DBRefEntry;
 import jalview.datamodel.DBRefSource;
@@ -32,13 +39,6 @@ import jalview.util.StringUtils;
 import jalview.util.UrlLink;
 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
 
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Comparator;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-
 /**
  * generate HTML reports for a sequence
  * 
@@ -56,12 +56,12 @@ public class SequenceAnnotationReport
 
   private static final int MAX_SOURCES = 40;
 
+  private static String linkImageURL;
+
   private static final String[][] PRIMARY_SOURCES = new String[][] {
       DBRefSource.CODINGDBS, DBRefSource.DNACODINGDBS,
       DBRefSource.PROTEINDBS };
 
-  final String linkImageURL;
-
   /*
    * Comparator to order DBRefEntry by Source + accession id (case-insensitive),
    * with 'Primary' sources placed before others, and 'chromosome' first of all
@@ -120,14 +120,30 @@ public class SequenceAnnotationReport
     }
   };
 
-  public SequenceAnnotationReport(String linkURL)
+  private boolean forTooltip;
+
+  /**
+   * Constructor given a flag which affects behaviour
+   * <ul>
+   * <li>if true, generates feature details suitable to show in a tooltip</li>
+   * <li>if false, generates feature details in a form suitable for the sequence
+   * details report</li>
+   * </ul>
+   * 
+   * @param isForTooltip
+   */
+  public SequenceAnnotationReport(boolean isForTooltip)
   {
-    this.linkImageURL = linkURL;
+    this.forTooltip = isForTooltip;
+    if (linkImageURL == null)
+    {
+      linkImageURL = getClass().getResource("/images/link.gif").toString();
+    }
   }
 
   /**
-   * Append text for the list of features to the tooltip Returns number of
-   * features left if maxlength limit is (or would have been) reached
+   * Append text for the list of features to the tooltip. Returns the number of
+   * features not added if maxlength limit is (or would have been) reached.
    * 
    * @param sb
    * @param residuePos
@@ -135,7 +151,7 @@ public class SequenceAnnotationReport
    * @param minmax
    * @param maxlength
    */
-  public int appendFeaturesLengthLimit(final StringBuilder sb,
+  public int appendFeatures(final StringBuilder sb,
           int residuePos, List<SequenceFeature> features,
           FeatureRendererModel fr, int maxlength)
   {
@@ -150,16 +166,10 @@ public class SequenceAnnotationReport
     return 0;
   }
 
-  public void appendFeatures(final StringBuilder sb, int residuePos,
-          List<SequenceFeature> features, FeatureRendererModel fr)
-  {
-    appendFeaturesLengthLimit(sb, residuePos, features, fr, 0);
-  }
-
   /**
-   * Appends text for mapped features (e.g. CDS feature for peptide or vice versa)
-   * Returns number of features left if maxlength limit is (or would have been)
-   * reached
+   * Appends text for mapped features (e.g. CDS feature for peptide or vice
+   * versa) Returns number of features left if maxlength limit is (or would have
+   * been) reached.
    * 
    * @param sb
    * @param residuePos
@@ -167,7 +177,7 @@ public class SequenceAnnotationReport
    * @param fr
    * @param maxlength
    */
-  public int appendFeaturesLengthLimit(StringBuilder sb, int residuePos,
+  public int appendFeatures(StringBuilder sb, int residuePos,
           MappedFeatures mf, FeatureRendererModel fr, int maxlength)
   {
     for (int i = 0; i < mf.features.size(); i++)
@@ -181,12 +191,6 @@ public class SequenceAnnotationReport
     return 0;
   }
 
-  public void appendFeatures(StringBuilder sb, int residuePos,
-          MappedFeatures mf, FeatureRendererModel fr)
-  {
-    appendFeaturesLengthLimit(sb, residuePos, mf, fr, 0);
-  }
-
   /**
    * Appends the feature at rpos to the given buffer
    * 
@@ -199,19 +203,49 @@ public class SequenceAnnotationReport
           FeatureRendererModel fr, SequenceFeature feature,
           MappedFeatures mf, int maxlength)
   {
+    int begin = feature.getBegin();
+    int end = feature.getEnd();
+
+    /*
+     * if this is a virtual features, convert begin/end to the
+     * coordinates of the sequence it is mapped to
+     */
+    int[] beginRange = null;
+    int[] endRange = null;
+    if (mf != null)
+    {
+      beginRange = mf.getMappedPositions(begin, begin);
+      endRange = mf.getMappedPositions(end, end);
+      if (beginRange == null || endRange == null)
+      {
+        // something went wrong
+        return false;
+      }
+      begin = beginRange[0];
+      end = endRange[endRange.length - 1];
+    }
+
     StringBuilder sb = new StringBuilder();
     if (feature.isContactFeature())
     {
-      if (feature.getBegin() == rpos || feature.getEnd() == rpos)
+      /*
+       * include if rpos is at start or end position of [mapped] feature
+       */
+      boolean showContact = (mf == null) && (rpos == begin || rpos == end);
+      boolean showMappedContact = (mf != null) && ((rpos >= beginRange[0]
+              && rpos <= beginRange[beginRange.length - 1])
+              || (rpos >= endRange[0]
+                      && rpos <= endRange[endRange.length - 1]));
+      if (showContact || showMappedContact)
       {
         if (sb0.length() > 6)
         {
           sb.append("<br/>");
         }
-        sb.append(feature.getType()).append(" ").append(feature.getBegin())
-                .append(":").append(feature.getEnd());
+        sb.append(feature.getType()).append(" ").append(begin).append(":")
+                .append(end);
       }
-      return appendTextMaxLengthReached(sb0, sb, maxlength);
+      return appendText(sb0, sb, maxlength);
     }
 
     if (sb0.length() > 6)
@@ -226,11 +260,11 @@ public class SequenceAnnotationReport
       if (rpos != 0)
       {
         // we are marking a positional feature
-        sb.append(feature.begin);
-      }
-      if (feature.begin != feature.end)
-      {
-        sb.append(" ").append(feature.end);
+        sb.append(begin);
+        if (begin != end)
+        {
+          sb.append(" ").append(end);
+        }
       }
 
       String description = feature.getDescription();
@@ -291,27 +325,28 @@ public class SequenceAnnotationReport
         }
       }
     }
-    return appendTextMaxLengthReached(sb0, sb, maxlength);
+    return appendText(sb0, sb, maxlength);
   }
 
-  void appendFeature(final StringBuilder sb, int rpos,
-          FeatureRendererModel fr, SequenceFeature feature,
-          MappedFeatures mf)
-  {
-    appendFeature(sb, rpos, fr, feature, mf, 0);
-  }
-
-  private static boolean appendTextMaxLengthReached(StringBuilder sb0,
-          StringBuilder sb, int maxlength)
+  /**
+   * Appends sb to sb0, and returns false, unless maxlength is not zero and
+   * appending would make the result longer than or equal to maxlength, in which
+   * case the append is not done and returns true
+   * 
+   * @param sb0
+   * @param sb
+   * @param maxlength
+   * @return
+   */
+  private static boolean appendText(StringBuilder sb0, StringBuilder sb,
+          int maxlength)
   {
-    boolean ret = false;
     if (maxlength == 0 || sb0.length() + sb.length() < maxlength)
     {
       sb0.append(sb);
       return false;
-    } else {
-      return true;
     }
+    return true;
   }
 
   /**
@@ -466,7 +501,7 @@ public class SequenceAnnotationReport
               .getNonPositionalFeatures())
       {
         int sz = -sb.length();
-        appendFeature(sb, 0, fr, sf, null);
+        appendFeature(sb, 0, fr, sf, null, 0);
         sz += sb.length();
         maxWidth = Math.max(maxWidth, sz);
       }
index 0e73af1..4697262 100644 (file)
@@ -28,12 +28,14 @@ import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.Annotation;
 import jalview.datamodel.DBRefEntry;
+import jalview.datamodel.DBRefSource;
 import jalview.datamodel.Mapping;
 import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
 import jalview.schemes.ResidueProperties;
 import jalview.util.Comparison;
+import jalview.util.DBRefUtils;
 import jalview.util.Format;
 import jalview.util.MessageManager;
 
@@ -332,17 +334,14 @@ public class StockholmFile extends AlignFile
 
           if (accAnnotations != null && accAnnotations.containsKey("AC"))
           {
-            if (dbsource != null)
+            String dbr = (String) accAnnotations.get("AC");
+            if (dbr != null)
             {
-              String dbr = (String) accAnnotations.get("AC");
-              if (dbr != null)
-              {
-                // we could get very clever here - but for now - just try to
-                // guess accession type from source of alignment plus structure
-                // of accession
-                guessDatabaseFor(seqO, dbr, dbsource);
-
-              }
+              // we could get very clever here - but for now - just try to
+              // guess accession type from type of sequence, source of alignment plus
+              // structure
+              // of accession
+              guessDatabaseFor(seqO, dbr, dbsource);
             }
             // else - do what ? add the data anyway and prompt the user to
             // specify what references these are ?
@@ -527,6 +526,9 @@ public class StockholmFile extends AlignFile
               treeName = an.stringMatched(2);
               treeString = new StringBuffer();
             }
+            // TODO: JAL-3532 - this is where GF comments and database references are lost
+            // suggest overriding this method for Stockholm files to catch and properly
+            // process CC, DR etc into multivalued properties
             setAlignmentProperty(an.stringMatched(1), an.stringMatched(2));
           }
         }
@@ -755,6 +757,12 @@ public class StockholmFile extends AlignFile
         st = -1;
       }
     }
+    if (dbsource == null)
+    {
+      // make up an origin based on whether the sequence looks like it is nucleotide
+      // or protein
+      dbsource = (seqO.isProtein()) ? "PFAM" : "RFAM";
+    }
     if (dbsource.equals("PFAM"))
     {
       seqdb = "UNIPROT";
@@ -930,6 +938,11 @@ public class StockholmFile extends AlignFile
     return annot;
   }
 
+  private String dbref_to_ac_record(DBRefEntry ref)
+  {
+    return ref.getSource().toString() + " ; "
+            + ref.getAccessionId().toString();
+  }
   @Override
   public String print(SequenceI[] s, boolean jvSuffix)
   {
@@ -942,8 +955,10 @@ public class StockholmFile extends AlignFile
     int maxid = 0;
     int in = 0;
     Hashtable dataRef = null;
+    boolean isAA = s[in].isProtein();
     while ((in < s.length) && (s[in] != null))
     {
+
       String tmp = printId(s[in], jvSuffix);
       max = Math.max(max, s[in].getLength());
 
@@ -953,17 +968,33 @@ public class StockholmFile extends AlignFile
       }
       if (s[in].getDBRefs() != null)
       {
-        for (int idb = 0; idb < s[in].getDBRefs().length; idb++)
+        if (dataRef == null)
+        {
+          dataRef = new Hashtable();
+        }
+        List<DBRefEntry> primrefs = s[in].getPrimaryDBRefs();
+        if (primrefs.size() >= 1)
         {
-          if (dataRef == null)
+          dataRef.put(tmp, dbref_to_ac_record(primrefs.get(0)));
+        }
+        else
+        {
+          for (int idb = 0; idb < s[in].getDBRefs().length; idb++)
           {
-            dataRef = new Hashtable();
+            DBRefEntry dbref = s[in].getDBRefs()[idb];
+            dataRef.put(tmp, dbref_to_ac_record(dbref));
+            // if we put in a uniprot or EMBL record then we're done:
+            if (isAA && DBRefSource.UNIPROT
+                    .equals(DBRefUtils.getCanonicalName(dbref.getSource())))
+            {
+              break;
+            }
+            if (!isAA && DBRefSource.EMBL
+                    .equals(DBRefUtils.getCanonicalName(dbref.getSource())))
+            {
+              break;
+            }
           }
-
-          String datAs1 = s[in].getDBRefs()[idb].getSource().toString()
-                  + " ; "
-                  + s[in].getDBRefs()[idb].getAccessionId().toString();
-          dataRef.put(tmp, datAs1);
         }
       }
       in++;
@@ -996,7 +1027,8 @@ public class StockholmFile extends AlignFile
         String type = (String) dataRef.remove(idd);
         out.append(new Format("%-" + (maxid - 2) + "s")
                 .form("#=GS " + idd.toString() + " "));
-        if (type.contains("PFAM") || type.contains("RFAM"))
+        if (isAA && type.contains("UNIPROT")
+                || (!isAA && type.contains("EMBL")))
         {
 
           out.append(" AC " + type.substring(type.indexOf(";") + 1));
index 5afbca5..4d5a025 100755 (executable)
@@ -488,7 +488,7 @@ public class DBRefUtils
       else
       {
         // default:
-        ref = new DBRefEntry(locsrc, version, acn);
+        ref = new DBRefEntry(locsrc, version, acn.trim());
       }
     }
     if (ref != null)
index 9a8a086..426ec1f 100644 (file)
  */
 package jalview.viewmodel.seqfeatures;
 
+import java.awt.Color;
+import java.beans.PropertyChangeListener;
+import java.beans.PropertyChangeSupport;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Hashtable;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+
 import jalview.api.AlignViewportI;
 import jalview.api.FeatureColourI;
 import jalview.api.FeaturesDisplayedI;
@@ -38,20 +52,6 @@ import jalview.renderer.seqfeatures.FeatureRenderer;
 import jalview.schemes.FeatureColour;
 import jalview.util.ColorUtils;
 
-import java.awt.Color;
-import java.beans.PropertyChangeListener;
-import java.beans.PropertyChangeSupport;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Hashtable;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.concurrent.ConcurrentHashMap;
-
 public abstract class FeatureRendererModel
         implements jalview.api.FeatureRenderer
 {
@@ -1162,8 +1162,8 @@ public abstract class FeatureRendererModel
   }
 
   @Override
-  public MappedFeatures findComplementFeaturesAtResidue(SequenceI sequence,
-          int pos)
+  public MappedFeatures findComplementFeaturesAtResidue(
+          final SequenceI sequence, final int pos)
   {
     SequenceI ds = sequence.getDatasetSequence();
     if (ds == null)
@@ -1232,9 +1232,12 @@ public abstract class FeatureRendererModel
     }
 
     /*
-     * sort by renderorder, inefficiently
+     * sort by renderorder (inefficiently but ok for small scale);
+     * NB this sorts 'on top' feature to end, for rendering
      */
     List<SequenceFeature> result = new ArrayList<>();
+    final int toAdd = found.size();
+    int added = 0;
     for (String type : renderOrder)
     {
       for (SequenceFeature sf : found)
@@ -1242,11 +1245,11 @@ public abstract class FeatureRendererModel
         if (type.equals(sf.getType()))
         {
           result.add(sf);
-          if (result.size() == found.size())
-          {
-            return new MappedFeatures(mapping, mapFrom, pos, residue,
-                    result);
-          }
+          added++;
+        }
+        if (added == toAdd)
+        {
+          break;
         }
       }
     }
index cd8f9eb..f8479a3 100644 (file)
@@ -26,11 +26,15 @@ import static org.testng.AssertJUnit.assertNull;
 import static org.testng.AssertJUnit.assertSame;
 import static org.testng.AssertJUnit.assertTrue;
 
-import jalview.gui.JvOptionPane;
+import java.util.ArrayList;
+import java.util.List;
 
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
 
+import jalview.gui.JvOptionPane;
+import jalview.util.MapList;
+
 public class SequenceFeatureTest
 {
 
@@ -285,7 +289,7 @@ public class SequenceFeatureTest
     String expected = "<br><table><tr><td>Location</td><td>TestSeq</td><td>22</td></tr>"
             + "<tr><td>Type</td><td>variant</td><td></td></tr>"
             + "<tr><td>Description</td><td>G,C</td><td></td></tr></table>";
-    assertEquals(expected, sf.getDetailsReport(seqName));
+    assertEquals(expected, sf.getDetailsReport(seqName, null));
 
     // contact feature
     sf = new SequenceFeature("Disulphide Bond", "a description", 28, 31,
@@ -293,7 +297,7 @@ public class SequenceFeatureTest
     expected = "<br><table><tr><td>Location</td><td>TestSeq</td><td>28:31</td></tr>"
             + "<tr><td>Type</td><td>Disulphide Bond</td><td></td></tr>"
             + "<tr><td>Description</td><td>a description</td><td></td></tr></table>";
-    assertEquals(expected, sf.getDetailsReport(seqName));
+    assertEquals(expected, sf.getDetailsReport(seqName, null));
 
     sf = new SequenceFeature("variant", "G,C", 22, 33,
             12.5f, "group");
@@ -306,7 +310,7 @@ public class SequenceFeatureTest
             + "<tr><td>Group</td><td>group</td><td></td></tr>"
             + "<tr><td>Child</td><td></td><td>ENSP002</td></tr>"
             + "<tr><td>Parent</td><td></td><td>ENSG001</td></tr></table>";
-    assertEquals(expected, sf.getDetailsReport(seqName));
+    assertEquals(expected, sf.getDetailsReport(seqName, null));
 
     /*
      * feature with embedded html link in description
@@ -317,6 +321,39 @@ public class SequenceFeatureTest
             + "<tr><td>Type</td><td>Pfam</td><td></td></tr>"
             + "<tr><td>Description</td><td>Fer2 Status: True Positive <a href=\"http://pfam.xfam.org/family/PF00111\">Pfam 8_8</a></td><td></td></tr>"
             + "<tr><td>Group</td><td>Uniprot</td><td></td></tr></table>";
-    assertEquals(expected, sf.getDetailsReport(seqName));
+    assertEquals(expected, sf.getDetailsReport(seqName, null));
+  }
+
+  /**
+   * Feature details report for a virtual feature should include original and
+   * mapped locations, and also derived peptide consequence if it can be
+   * determined
+   */
+  @Test(groups = { "Functional" })
+  public void testGetDetailsReport_virtualFeature()
+  {
+    SequenceI cds = new Sequence("Cds/101-121", "CCTttgAGAtttCAAatgGAT");
+    SequenceI seq = new Sequence("TestSeq/8-14", "PLRFQMD");
+    MapList map = new MapList(new int[] { 101, 118 }, new int[] { 8, 13 },
+            3, 1);
+    Mapping mapping = new Mapping(seq, map);
+    List<SequenceFeature> features = new ArrayList<>();
+    // vary ttg (Leu) to ttc (Phe)
+    SequenceFeature sf = new SequenceFeature("variant", "G,C", 106, 106,
+            null);
+    sf.setValue("alleles", "G,C"); // needed to compute peptide consequence!
+    features.add(sf);
+
+    MappedFeatures mf = new MappedFeatures(mapping, cds, 9, 'L', features);
+
+    String expected = "<br><table><tr><td>Location</td><td>Cds</td><td>106</td></tr>"
+            + "<tr><td>Peptide Location</td><td>TestSeq</td><td>9</td></tr>"
+            + "<tr><td>Type</td><td>variant</td><td></td></tr>"
+            + "<tr><td>Description</td><td>G,C</td><td></td></tr>"
+            + "<tr><td>Consequence</td><td><i>Translated by Jalview</i></td><td>p.Leu9Phe</td></tr>"
+            + "<tr><td>alleles</td><td></td><td>G,C</td></tr>"
+            + "</table>";
+
+    assertEquals(expected, sf.getDetailsReport(seq.getName(), mf));
   }
 }
index 9b21274..24697c0 100644 (file)
@@ -68,13 +68,27 @@ public class FreeUpMemoryTest
     File f = generateAlignment();
     f.deleteOnExit();
 
+    long expectedMin = 35L;
+    long usedMemoryAtStart=getUsedMemory();
+    if (usedMemoryAtStart>expectedMin)
+    {
+      System.err.println("used memory before test is "+usedMemoryAtStart+" > "+expectedMin+"MB .. adjusting minimum.");
+      expectedMin = usedMemoryAtStart;
+    }
     doStuffInJalview(f);
 
     Desktop.instance.closeAll_actionPerformed(null);
 
-    checkUsedMemory(35L);
+    checkUsedMemory(expectedMin);
   }
 
+  private static long getUsedMemory()
+  {
+    long availableMemory = Runtime.getRuntime().totalMemory() / ONE_MB;
+    long freeMemory = Runtime.getRuntime().freeMemory() / ONE_MB;
+    long usedMemory = availableMemory - freeMemory;
+    return usedMemory;
+  }
   /**
    * Requests garbage collection and then checks whether remaining memory in use
    * is less than the expected value (in Megabytes)
@@ -101,10 +115,7 @@ public class FreeUpMemoryTest
     /*
      * check used memory is 'reasonably low'
      */
-    long availableMemory = Runtime.getRuntime().totalMemory() / ONE_MB;
-    long freeMemory = Runtime.getRuntime().freeMemory() / ONE_MB;
-    long usedMemory = availableMemory - freeMemory;
-
+    long usedMemory = getUsedMemory();
     /*
      * sanity check - fails if any frame was added after
      * closeAll_actionPerformed
index 42183ca..772ed2b 100644 (file)
@@ -23,8 +23,18 @@ package jalview.io;
 import static org.testng.AssertJUnit.assertEquals;
 import static org.testng.AssertJUnit.assertTrue;
 
+import java.awt.Color;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
 import jalview.api.FeatureColourI;
 import jalview.datamodel.DBRefEntry;
+import jalview.datamodel.MappedFeatures;
+import jalview.datamodel.Mapping;
 import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
@@ -32,16 +42,8 @@ import jalview.gui.JvOptionPane;
 import jalview.io.gff.GffConstants;
 import jalview.renderer.seqfeatures.FeatureRenderer;
 import jalview.schemes.FeatureColour;
+import jalview.util.MapList;
 import jalview.viewmodel.seqfeatures.FeatureRendererModel;
-
-import java.awt.Color;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-
-import org.testng.annotations.BeforeClass;
-import org.testng.annotations.Test;
-
 import junit.extensions.PA;
 
 public class SequenceAnnotationReportTest
@@ -57,24 +59,24 @@ public class SequenceAnnotationReportTest
   @Test(groups = "Functional")
   public void testAppendFeature_disulfideBond()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     sb.append("123456");
     SequenceFeature sf = new SequenceFeature("disulfide bond", "desc", 1,
             3, 1.2f, "group");
 
     // residuePos == 2 does not match start or end of feature, nothing done:
-    sar.appendFeature(sb, 2, null, sf, null);
+    sar.appendFeature(sb, 2, null, sf, null, 0);
     assertEquals("123456", sb.toString());
 
     // residuePos == 1 matches start of feature, text appended (but no <br/>)
     // feature score is not included
-    sar.appendFeature(sb, 1, null, sf, null);
+    sar.appendFeature(sb, 1, null, sf, null, 0);
     assertEquals("123456disulfide bond 1:3", sb.toString());
 
     // residuePos == 3 matches end of feature, text appended
     // <br/> is prefixed once sb.length() > 6
-    sar.appendFeature(sb, 3, null, sf, null);
+    sar.appendFeature(sb, 3, null, sf, null, 0);
     assertEquals("123456disulfide bond 1:3<br/>disulfide bond 1:3",
             sb.toString());
   }
@@ -82,13 +84,13 @@ public class SequenceAnnotationReportTest
   @Test(groups = "Functional")
   public void testAppendFeatures_longText()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     String longString = "Abcd".repeat(50);
     SequenceFeature sf = new SequenceFeature("sequence", longString, 1, 3,
             "group");
 
-    sar.appendFeature(sb, 1, null, sf, null);
+    sar.appendFeature(sb, 1, null, sf, null, 0);
     assertTrue(sb.length() < 100);
 
     List<SequenceFeature> sfl = new ArrayList<>();
@@ -103,7 +105,7 @@ public class SequenceAnnotationReportTest
     sfl.add(sf);
     sfl.add(sf);
     sfl.add(sf);
-    int n = sar.appendFeaturesLengthLimit(sb, 1, sfl,
+    int n = sar.appendFeatures(sb, 1, sfl,
             new FeatureRenderer(null), 200); // text should terminate before 200 characters
     String s = sb.toString();
     assertTrue(s.length() < 200);
@@ -114,27 +116,27 @@ public class SequenceAnnotationReportTest
   @Test(groups = "Functional")
   public void testAppendFeature_status()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
             Float.NaN, "group");
     sf.setStatus("Confirmed");
 
-    sar.appendFeature(sb, 1, null, sf, null);
+    sar.appendFeature(sb, 1, null, sf, null, 0);
     assertEquals("METAL 1 3; Fe2-S; (Confirmed)", sb.toString());
   }
 
   @Test(groups = "Functional")
   public void testAppendFeature_withScore()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3, 1.3f,
             "group");
 
     FeatureRendererModel fr = new FeatureRenderer(null);
     Map<String, float[][]> minmax = fr.getMinMax();
-    sar.appendFeature(sb, 1, fr, sf, null);
+    sar.appendFeature(sb, 1, fr, sf, null, 0);
     /*
      * map has no entry for this feature type - score is not shown:
      */
@@ -144,7 +146,7 @@ public class SequenceAnnotationReportTest
      * map has entry for this feature type - score is shown:
      */
     minmax.put("METAL", new float[][] { { 0f, 1f }, null });
-    sar.appendFeature(sb, 1, fr, sf, null);
+    sar.appendFeature(sb, 1, fr, sf, null, 0);
     // <br/> is appended to a buffer > 6 in length
     assertEquals("METAL 1 3; Fe2-S<br/>METAL 1 3; Fe2-S Score=1.3",
             sb.toString());
@@ -154,19 +156,19 @@ public class SequenceAnnotationReportTest
      */
     minmax.put("METAL", new float[][] { { 2f, 2f }, null });
     sb.setLength(0);
-    sar.appendFeature(sb, 1, fr, sf, null);
+    sar.appendFeature(sb, 1, fr, sf, null, 0);
     assertEquals("METAL 1 3; Fe2-S", sb.toString());
   }
 
   @Test(groups = "Functional")
   public void testAppendFeature_noScore()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
             Float.NaN, "group");
 
-    sar.appendFeature(sb, 1, null, sf, null);
+    sar.appendFeature(sb, 1, null, sf, null, 0);
     assertEquals("METAL 1 3; Fe2-S", sb.toString());
   }
 
@@ -176,7 +178,7 @@ public class SequenceAnnotationReportTest
   @Test(groups = "Functional")
   public void testAppendFeature_colouredByAttribute()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3,
             Float.NaN, "group");
@@ -186,7 +188,7 @@ public class SequenceAnnotationReportTest
      * first with no colour by attribute
      */
     FeatureRendererModel fr = new FeatureRenderer(null);
-    sar.appendFeature(sb, 1, fr, sf, null);
+    sar.appendFeature(sb, 1, fr, sf, null, 0);
     assertEquals("METAL 1 3; Fe2-S", sb.toString());
 
     /*
@@ -197,7 +199,7 @@ public class SequenceAnnotationReportTest
     fc.setAttributeName("Pfam");
     fr.setColour("METAL", fc);
     sb.setLength(0);
-    sar.appendFeature(sb, 1, fr, sf, null);
+    sar.appendFeature(sb, 1, fr, sf, null, 0);
     assertEquals("METAL 1 3; Fe2-S", sb.toString()); // no change
 
     /*
@@ -205,7 +207,7 @@ public class SequenceAnnotationReportTest
      */
     fc.setAttributeName("clinical_significance");
     sb.setLength(0);
-    sar.appendFeature(sb, 1, fr, sf, null);
+    sar.appendFeature(sb, 1, fr, sf, null, 0);
     assertEquals("METAL 1 3; Fe2-S; clinical_significance=Benign",
             sb.toString());
   }
@@ -213,7 +215,7 @@ public class SequenceAnnotationReportTest
   @Test(groups = "Functional")
   public void testAppendFeature_withScoreStatusAttribute()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     SequenceFeature sf = new SequenceFeature("METAL", "Fe2-S", 1, 3, 1.3f,
             "group");
@@ -227,7 +229,7 @@ public class SequenceAnnotationReportTest
     fc.setAttributeName("clinical_significance");
     fr.setColour("METAL", fc);
     minmax.put("METAL", new float[][] { { 0f, 1f }, null });
-    sar.appendFeature(sb, 1, fr, sf, null);
+    sar.appendFeature(sb, 1, fr, sf, null, 0);
 
     assertEquals(
             "METAL 1 3; Fe2-S Score=1.3; (Confirmed); clinical_significance=Benign",
@@ -237,38 +239,38 @@ public class SequenceAnnotationReportTest
   @Test(groups = "Functional")
   public void testAppendFeature_DescEqualsType()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     SequenceFeature sf = new SequenceFeature("METAL", "METAL", 1, 3,
             Float.NaN, "group");
 
     // description is not included if it duplicates type:
-    sar.appendFeature(sb, 1, null, sf, null);
+    sar.appendFeature(sb, 1, null, sf, null, 0);
     assertEquals("METAL 1 3", sb.toString());
 
     sb.setLength(0);
     sf.setDescription("Metal");
     // test is case-sensitive:
-    sar.appendFeature(sb, 1, null, sf, null);
+    sar.appendFeature(sb, 1, null, sf, null, 0);
     assertEquals("METAL 1 3; Metal", sb.toString());
   }
 
   @Test(groups = "Functional")
   public void testAppendFeature_stripHtml()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
     SequenceFeature sf = new SequenceFeature("METAL",
             "<html><body>hello<em>world</em></body></html>", 1, 3,
             Float.NaN, "group");
 
-    sar.appendFeature(sb, 1, null, sf, null);
+    sar.appendFeature(sb, 1, null, sf, null, 0);
     // !! strips off </body> but not <body> ??
     assertEquals("METAL 1 3; <body>hello<em>world</em>", sb.toString());
 
     sb.setLength(0);
     sf.setDescription("<br>&kHD>6");
-    sar.appendFeature(sb, 1, null, sf, null);
+    sar.appendFeature(sb, 1, null, sf, null, 0);
     // if no <html> tag, html-encodes > and < (only):
     assertEquals("METAL 1 3; &lt;br&gt;&kHD&gt;6", sb.toString());
   }
@@ -276,7 +278,7 @@ public class SequenceAnnotationReportTest
   @Test(groups = "Functional")
   public void testCreateSequenceAnnotationReport()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
 
     SequenceI seq = new Sequence("s1", "MAKLKRFQSSTLL");
@@ -398,7 +400,7 @@ public class SequenceAnnotationReportTest
   @Test(groups = "Functional")
   public void testCreateSequenceAnnotationReport_withEllipsis()
   {
-    SequenceAnnotationReport sar = new SequenceAnnotationReport(null);
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
     StringBuilder sb = new StringBuilder();
   
     SequenceI seq = new Sequence("s1", "ABC");
@@ -424,4 +426,63 @@ public class SequenceAnnotationReportTest
             .endsWith(
                     "<br/>PDB7 3iu1<br/>PDB8,...<br/>(Output Sequence Details to list all database references)</i>"));
   }
+
+  /**
+   * Test adding a linked feature to the tooltip
+   */
+  @Test(groups = "Functional")
+  public void testAppendFeature_virtualFeature()
+  {
+    /*
+     * map CDS to peptide sequence
+     */
+    SequenceI cds = new Sequence("Cds/101-121", "CCTttgAGAtttCAAatgGAT");
+    SequenceI peptide = new Sequence("Peptide/8-14", "PLRFQMD");
+    MapList map = new MapList(new int[] { 101, 118 }, new int[] { 8, 13 },
+            3, 1);
+    Mapping mapping = new Mapping(peptide, map);
+
+    /*
+     * assume variant feature found at CDS position 106 G>C
+     */
+    List<SequenceFeature> features = new ArrayList<>();
+    // vary ttg (Leu) to ttc (Phe)
+    SequenceFeature sf = new SequenceFeature("variant", "G,C", 106, 106,
+            Float.NaN, null);
+    features.add(sf);
+    MappedFeatures mf = new MappedFeatures(mapping, cds, 9, 'L', features);
+
+    StringBuilder sb = new StringBuilder();
+    SequenceAnnotationReport sar = new SequenceAnnotationReport(false);
+    sar.appendFeature(sb, 1, null, sf, mf, 0);
+
+    /*
+     * linked feature shown in tooltip in protein coordinates
+     */
+    assertEquals("variant 9; G,C", sb.toString());
+
+    /*
+     * adding "alleles" attribute to variant allows peptide consequence
+     * to be calculated and added to the tooltip
+     */
+    sf.setValue("alleles", "G,C");
+    sb = new StringBuilder();
+    sar.appendFeature(sb, 1, null, sf, mf, 0);
+    assertEquals("variant 9; G,C p.Leu9Phe", sb.toString());
+
+    /*
+     * now a virtual peptide feature on CDS
+     * feature at 11-12 on peptide maps to 110-115 on CDS
+     * here we test for tooltip at 113 (t)
+     */
+    SequenceFeature sf2 = new SequenceFeature("metal", "Fe", 11, 12,
+            2.3f, "Uniprot");
+    features.clear();
+    features.add(sf2);
+    mapping = new Mapping(peptide, map);
+    mf = new MappedFeatures(mapping, peptide, 113, 't', features);
+    sb = new StringBuilder();
+    sar.appendFeature(sb, 1, null, sf2, mf, 0);
+    assertEquals("metal 110 115; Fe Score=2.3", sb.toString());
+  }
 }
index ba4312a..9fdd7b9 100644 (file)
  */
 package jalview.io;
 
+import static org.testng.Assert.assertTrue;
 import static org.testng.AssertJUnit.assertEquals;
 import static org.testng.AssertJUnit.assertNotNull;
 import static org.testng.AssertJUnit.assertTrue;
 import static org.testng.AssertJUnit.fail;
 
+import jalview.datamodel.Alignment;
 import jalview.datamodel.AlignmentAnnotation;
 import jalview.datamodel.AlignmentI;
 import jalview.datamodel.Annotation;
+import jalview.datamodel.DBRefEntry;
+import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
 import jalview.gui.JvOptionPane;
+import jalview.util.DBRefUtils;
 
 import java.io.File;
 import java.util.Arrays;
@@ -93,14 +98,55 @@ public class StockholmFileTest
   }
 
   /**
+   * JAL-3529 - verify uniprot refs for sequences are output for sequences
+   * retrieved via Pfam
+   */
+  @Test(groups = { "Functional" })
+  public void dbrefOutput() throws Exception
+  {
+    // sequences retrieved in a Pfam domain alignment also have a PFAM database
+    // reference
+    SequenceI sq = new Sequence("FER2_SPIOL", "AASSDDDFFF");
+    sq.addDBRef(new DBRefEntry("UNIPROT", "1", "P00224"));
+    sq.addDBRef(new DBRefEntry("PFAM", "1", "P00224.1"));
+    sq.addDBRef(new DBRefEntry("PFAM", "1", "PF00111"));
+    AppletFormatAdapter af = new AppletFormatAdapter();
+    String toStockholm = af.formatSequences(FileFormat.Stockholm,
+            new Alignment(new SequenceI[]
+            { sq }), false);
+    System.out.println(toStockholm);
+    // bleh - java.util.Regex sucks
+    assertTrue(
+            Pattern.compile(
+                    "^#=GS\\s+FER2_SPIOL(/\\d+-\\d+)?\\s+AC\\s+P00224$",
+                    Pattern.MULTILINE).matcher(toStockholm)
+                    .find(),
+            "Couldn't locate UNIPROT Accession in generated Stockholm file.");
+    AlignmentI fromStockholm = af.readFile(toStockholm,
+            DataSourceType.PASTE, FileFormat.Stockholm);
+    SequenceI importedSeq = fromStockholm.getSequenceAt(0);
+    assertTrue(importedSeq.getDBRefs().length == 1,
+            "Expected just one database reference to be added to sequence.");
+    assertTrue(
+            importedSeq.getDBRefs()[0].getAccessionId().indexOf(" ") == -1,
+            "Spaces were found in accession ID.");
+    List<DBRefEntry> dbrefs = DBRefUtils.searchRefs(importedSeq.getDBRefs(),
+            "P00224");
+    assertTrue(dbrefs.size() == 1,
+            "Couldn't find Uniprot DBRef on re-imported sequence.");
+
+  }
+
+  /**
    * test alignment data in given file can be imported, exported and reimported
    * with no dataloss
    * 
    * @param f
-   *          - source datafile (IdentifyFile.identify() should work with it)
+   *                               - source datafile (IdentifyFile.identify()
+   *                               should work with it)
    * @param ioformat
-   *          - label for IO class used to write and read back in the data from
-   *          f
+   *                               - label for IO class used to write and read
+   *                               back in the data from f
    * @param ignoreFeatures
    * @param ignoreRowVisibility
    * @param allowNullAnnotations
index 0368d1e..ca5bca3 100644 (file)
@@ -135,6 +135,11 @@ public class DBRefUtilsTest
     assertEquals("1.2", ref.getVersion());
     assertEquals("a7890", ref.getAccessionId());
     assertTrue(seq.getAllPDBEntries().isEmpty());
+    SequenceI seq2 = new Sequence("Seq2", "ABCD");
+    // Check that whitespace doesn't confuse parseToDbRef
+    DBRefEntry ref2 = DBRefUtils.parseToDbRef(seq2, "EMBL", "1.2",
+            " a7890");
+    assertEquals(ref, ref2);
   }
 
   /**
index eb585d9..a02cd6d 100644 (file)
@@ -684,7 +684,7 @@ return console.askYesNo(message, true);
               </action>
               <action id="1525" beanClass="com.install4j.runtime.beans.actions.files.DeleteFileAction" actionElevationType="elevated" rollbackBarrierExitCode="0">
                 <serializedBean>
-                  <property name="files" type="array" class="java.io.File" length="32">
+                  <property name="files" type="array" class="java.io.File" length="36">
                     <element index="0">
                       <object class="java.io.File">
                         <string>jre</string>
@@ -702,117 +702,117 @@ return console.askYesNo(message, true);
                     </element>
                     <element index="3">
                       <object class="java.io.File">
-                        <string>${compiler:GETDOWN_DIST_DIR}</string>
+                        <string>getdown-launcher.jar</string>
                       </object>
                     </element>
                     <element index="4">
                       <object class="java.io.File">
-                        <string>${compiler:GETDOWN_ALT_DIR}</string>
+                        <string>getdown-launcher-old.jar</string>
                       </object>
                     </element>
                     <element index="5">
                       <object class="java.io.File">
-                        <string>${compiler:GETDOWN_RESOURCE_DIR}</string>
+                        <string>getdown-launcher-new.jar</string>
                       </object>
                     </element>
                     <element index="6">
                       <object class="java.io.File">
-                        <string>getdown-launcher.jar</string>
+                        <string>gettingdown.lock</string>
                       </object>
                     </element>
                     <element index="7">
                       <object class="java.io.File">
-                        <string>getdown-launcher-old.jar</string>
+                        <string>jre.zip</string>
                       </object>
                     </element>
                     <element index="8">
                       <object class="java.io.File">
-                        <string>getdown-launcher-new.jar</string>
+                        <string>digest.txt</string>
                       </object>
                     </element>
                     <element index="9">
                       <object class="java.io.File">
-                        <string>*.jarv</string>
+                        <string>digest2.txt</string>
                       </object>
                     </element>
                     <element index="10">
                       <object class="java.io.File">
-                        <string>gettingdown.lock</string>
+                        <string>getdown-launcher.jarv</string>
                       </object>
                     </element>
                     <element index="11">
                       <object class="java.io.File">
-                        <string>*.log</string>
+                        <string>getdown-launcher-new.jarv</string>
                       </object>
                     </element>
                     <element index="12">
                       <object class="java.io.File">
-                        <string>*.txt</string>
+                        <string>launcher.log</string>
                       </object>
                     </element>
                     <element index="13">
                       <object class="java.io.File">
-                        <string>*_new</string>
+                        <string>proxy.txt</string>
                       </object>
                     </element>
                     <element index="14">
                       <object class="java.io.File">
-                        <string>digest.txt</string>
+                        <string>build_properties</string>
                       </object>
                     </element>
                     <element index="15">
                       <object class="java.io.File">
-                        <string>digest2.txt</string>
+                        <string>channel_launch*.jvl</string>
                       </object>
                     </element>
                     <element index="16">
                       <object class="java.io.File">
-                        <string>getdown-launcher.jarv</string>
+                        <string>jalview*.jvl</string>
                       </object>
                     </element>
                     <element index="17">
                       <object class="java.io.File">
-                        <string>getdown-launcher-new.jarv</string>
+                        <string>*.jarv</string>
                       </object>
                     </element>
                     <element index="18">
                       <object class="java.io.File">
-                        <string>channel_launch*.jvl</string>
+                        <string>*.log</string>
                       </object>
                     </element>
                     <element index="19">
                       <object class="java.io.File">
-                        <string>launcher.log</string>
+                        <string>*.txt</string>
                       </object>
                     </element>
                     <element index="20">
                       <object class="java.io.File">
-                        <string>proxy.txt</string>
+                        <string>*_new</string>
                       </object>
                     </element>
                     <element index="21">
                       <object class="java.io.File">
-                        <string>META-INF</string>
+                        <string>hs_err_*.*</string>
                       </object>
                     </element>
                     <element index="22">
                       <object class="java.io.File">
-                        <string>install/getdown-launcher.jar</string>
+                        <string>${compiler:GETDOWN_DIST_DIR}</string>
                       </object>
                     </element>
                     <element index="23">
                       <object class="java.io.File">
-                        <string>install/getdown.txt</string>
+                        <string>${compiler:GETDOWN_ALT_DIR}</string>
                       </object>
                     </element>
                     <element index="24">
                       <object class="java.io.File">
-                        <string>install/build_properties</string>
+                        <string>${compiler:GETDOWN_RESOURCE_DIR}</string>
                       </object>
                     </element>
                     <element index="25">
                       <object class="java.io.File">
-                        <string>build_properties</string>
+                        <string>META-INF</string>
                       </object>
                     </element>
                     <element index="26">
@@ -822,27 +822,47 @@ return console.askYesNo(message, true);
                     </element>
                     <element index="27">
                       <object class="java.io.File">
-                        <string>dist</string>
+                        <string>resource</string>
                       </object>
                     </element>
                     <element index="28">
                       <object class="java.io.File">
-                        <string>release</string>
+                        <string>dist</string>
                       </object>
                     </element>
                     <element index="29">
                       <object class="java.io.File">
-                        <string>alt</string>
+                        <string>release</string>
                       </object>
                     </element>
                     <element index="30">
                       <object class="java.io.File">
-                        <string>resource</string>
+                        <string>alt</string>
                       </object>
                     </element>
                     <element index="31">
                       <object class="java.io.File">
-                        <string>hs_err_*.*</string>
+                        <string>dev</string>
+                      </object>
+                    </element>
+                    <element index="32">
+                      <object class="java.io.File">
+                        <string>build</string>
+                      </object>
+                    </element>
+                    <element index="33">
+                      <object class="java.io.File">
+                        <string>alt_*</string>
+                      </object>
+                    </element>
+                    <element index="34">
+                      <object class="java.io.File">
+                        <string>dev_*</string>
+                      </object>
+                    </element>
+                    <element index="35">
+                      <object class="java.io.File">
+                        <string>build_*</string>
                       </object>
                     </element>
                   </property>