JAL-2282 Refactor SequenceAnnotationReport to use refactored UrlLink
authorkiramt <k.mourao@dundee.ac.uk>
Tue, 1 Nov 2016 14:55:02 +0000 (14:55 +0000)
committerkiramt <k.mourao@dundee.ac.uk>
Tue, 1 Nov 2016 14:55:02 +0000 (14:55 +0000)
code.

src/jalview/gui/PopupMenu.java
src/jalview/io/SequenceAnnotationReport.java
src/jalview/util/UrlLink.java

index aa3cad4..a487fc7 100644 (file)
@@ -616,7 +616,7 @@ public class PopupMenu extends JPopupMenu
   void addFeatureLinks(final SequenceI seq, List<String> links)
   {
     JMenu linkMenu = new JMenu(MessageManager.getString("action.link"));
-    Map<String, String[]> linkset = new LinkedHashMap<String, String[]>();
+    Map<String, List<String>> linkset = new LinkedHashMap<String, List<String>>();
 
     for (String link : links)
     {
@@ -927,12 +927,12 @@ public class PopupMenu extends JPopupMenu
     }
   }
 
-  private void addshowLinks(JMenu linkMenu, Collection<String[]> linkset)
+  private void addshowLinks(JMenu linkMenu, Collection<List<String>> linkset)
   {
-    for (String[] linkstrset : linkset)
+    for (List<String> linkstrset : linkset)
     {
       // split linkstr into label and url
-      addshowLink(linkMenu, linkstrset[1], linkstrset[3]);
+      addshowLink(linkMenu, linkstrset.get(1), linkstrset.get(3));
     }
   }
 
index 07b88bf..89f1068 100644 (file)
@@ -24,10 +24,11 @@ import jalview.datamodel.DBRefEntry;
 import jalview.datamodel.SequenceFeature;
 import jalview.datamodel.SequenceI;
 import jalview.io.gff.GffConstants;
-import jalview.util.DBRefUtils;
 import jalview.util.UrlLink;
 
 import java.util.ArrayList;
+import java.util.Collection;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -206,16 +207,17 @@ public class SequenceAnnotationReport
         {
           try
           {
-            for (String[] urllink : createLinksFrom(null, urlstring))
+            for (List<String> urllink : createLinksFrom(null, urlstring))
             {
               sb.append("<br/> <a href=\""
-                      + urllink[3]
+                      + urllink.get(3)
                       + "\" target=\""
-                      + urllink[0]
+                      + urllink.get(0)
                       + "\">"
-                      + (urllink[0].toLowerCase().equals(
-                              urllink[1].toLowerCase()) ? urllink[0]
-                              : (urllink[0] + ":" + urllink[1]))
+                      + (urllink.get(0).toLowerCase()
+                              .equals(urllink.get(1).toLowerCase()) ? urllink
+                              .get(0) : (urllink.get(0) + ":" + urllink
+                              .get(1)))
                       + "</a></br>");
             }
           } catch (Exception x)
@@ -234,124 +236,22 @@ public class SequenceAnnotationReport
    * 
    * @param seq
    * @param link
-   * @return String[][] { String[] { link target, link label, dynamic component
-   *         inserted (if any), url }}
+   * @return Collection< List<String> > { List<String> { link target, link
+   *         label, dynamic component inserted (if any), url }}
    */
-  String[][] createLinksFrom(SequenceI seq, String link)
+  Collection<List<String>> createLinksFrom(SequenceI seq, String link)
   {
-    List<String[]> urlSets = new ArrayList<String[]>();
-    List<String> uniques = new ArrayList<String>();
+    Map<String, List<String>> urlSets = new LinkedHashMap<String, List<String>>();
     UrlLink urlLink = new UrlLink(link);
     if (!urlLink.isValid())
     {
       System.err.println(urlLink.getInvalidMessage());
       return null;
     }
-    if (seq != null && urlLink.isDynamic())
-    {
-      urlSets.addAll(createDynamicLinks(seq, urlLink, uniques));
-    }
-    else
-    {
-      String target = urlLink.getTarget();
-      String label = urlLink.getLabel();
-      String unq = label + "|" + urlLink.getUrl_prefix();
-      if (!uniques.contains(unq))
-      {
-        uniques.add(unq);
-        urlSets.add(new String[] { target, label, null,
-            urlLink.getUrl_prefix() });
-      }
-    }
-
-    return urlSets.toArray(new String[][] {});
-  }
 
-  /**
-   * Formats and returns a list of dynamic href links
-   * 
-   * @param seq
-   * @param urlLink
-   * @param uniques
-   */
-  List<String[]> createDynamicLinks(SequenceI seq, UrlLink urlLink,
-          List<String> uniques)
-  {
-    List<String[]> result = new ArrayList<String[]>();
-    final String target = urlLink.getTarget();
-    final String label = urlLink.getLabel();
+    urlLink.createLinksFromSeq(seq, urlSets);
 
-    // collect matching db-refs
-    DBRefEntry[] dbr = DBRefUtils.selectRefs(seq.getDBRefs(),
-            new String[] { target });
-    // collect id string too
-    String id = seq.getName();
-    String descr = seq.getDescription();
-    if (descr != null && descr.length() < 1)
-    {
-      descr = null;
-    }
-    if (dbr != null)
-    {
-      for (int r = 0; r < dbr.length; r++)
-      {
-        if (id != null && dbr[r].getAccessionId().equals(id))
-        {
-          // suppress duplicate link creation for the bare sequence ID
-          // string with this link
-          id = null;
-        }
-        // create Bare ID link for this URL
-        String[] urls = urlLink.makeUrls(dbr[r].getAccessionId(), true);
-        if (urls != null)
-        {
-          for (int u = 0; u < urls.length; u += 2)
-          {
-            String unq = urls[u] + "|" + urls[u + 1];
-            if (!uniques.contains(unq))
-            {
-              result.add(new String[] { target, label, urls[u], urls[u + 1] });
-              uniques.add(unq);
-            }
-          }
-        }
-      }
-    }
-    if (id != null)
-    {
-      // create Bare ID link for this URL
-      String[] urls = urlLink.makeUrls(id, true);
-      if (urls != null)
-      {
-        for (int u = 0; u < urls.length; u += 2)
-        {
-          String unq = urls[u] + "|" + urls[u + 1];
-          if (!uniques.contains(unq))
-          {
-            result.add(new String[] { target, label, urls[u], urls[u + 1] });
-            uniques.add(unq);
-          }
-        }
-      }
-    }
-    if (descr != null && urlLink.getRegexReplace() != null)
-    {
-      // create link for this URL from description only if regex matches
-      String[] urls = urlLink.makeUrls(descr, true);
-      if (urls != null)
-      {
-        for (int u = 0; u < urls.length; u += 2)
-        {
-          String unq = urls[u] + "|" + urls[u + 1];
-          if (!uniques.contains(unq))
-          {
-            result.add(new String[] { target, label, urls[u], urls[u + 1] });
-            uniques.add(unq);
-          }
-        }
-      }
-    }
-    return result;
+    return urlSets.values();
   }
 
   public void createSequenceAnnotationReport(final StringBuffer tip,
index 0968d36..e14ff63 100644 (file)
@@ -26,6 +26,8 @@ import static jalview.util.UrlConstants.SEQUENCE_NAME;
 import jalview.datamodel.DBRefEntry;
 import jalview.datamodel.SequenceI;
 
+import java.util.Arrays;
+import java.util.List;
 import java.util.Map;
 import java.util.Vector;
 
@@ -388,7 +390,7 @@ public class UrlLink
    * @param linkset
    */
   public void createLinksFromSeq(final SequenceI seq,
-          Map<String, String[]> linkset)
+          Map<String, List<String>> linkset)
   {
     if (seq != null && dynamic)
     {
@@ -405,13 +407,13 @@ public class UrlLink
    * 
    * @param linkset
    */
-  public void createStaticLink(Map<String, String[]> linkset)
+  public void createStaticLink(Map<String, List<String>> linkset)
   {
     if (!linkset.containsKey(label + "|" + getUrl_prefix()))
     {
       // Add a non-dynamic link
-      linkset.put(label + "|" + getUrl_prefix(), new String[] { "", label,
-          "", getUrl_prefix() });
+      linkset.put(label + "|" + getUrl_prefix(),
+              Arrays.asList(target, label, null, getUrl_prefix()));
     }
   }
 
@@ -422,7 +424,7 @@ public class UrlLink
    * @param linkset
    */
   public void createDynamicLinks(final SequenceI seq,
-          Map<String, String[]> linkset)
+          Map<String, List<String>> linkset)
   {
     // collect id string too
     String id = seq.getName();
@@ -467,7 +469,7 @@ public class UrlLink
    * Create a bare URL Link
    */
   protected void createBareURLLink(String id,
-          Map<String, String[]> linkset, Boolean combineLabel)
+          Map<String, List<String>> linkset, Boolean combineLabel)
   {
     String[] urls = makeUrls(id, true);
     if (urls != null)
@@ -482,8 +484,8 @@ public class UrlLink
             thisLabel = label + "|" + urls[u];
           }
 
-          linkset.put(urls[u] + "|" + urls[u + 1], new String[] { target,
-              thisLabel, urls[u], urls[u + 1] });
+          linkset.put(urls[u] + "|" + urls[u + 1],
+                  Arrays.asList(target, thisLabel, urls[u], urls[u + 1]));
         }
       }
     }