+ * Add annotation types to a 'Show annotations' or 'Hide annotations' menu.
+ * "All" is added first, followed by a separator. Then add any annotation
+ * types associated with the current selection.
+ * <p>
+ * Some annotation rows are always rendered together - these can be identified
+ * by a common graphGroup property > -1. Only one of each group will be marked
+ * as visible (to avoid duplication of the display). For such groups we add a
+ * composite type name, e.g.
+ * <p>
+ * IUPredWS (Long), IUPredWS (Short)
+ */
+ protected void buildAnnotationTypesMenus()
+ {
+ showAnnotationsMenu.removeAll();
+ hideAnnotationsMenu.removeAll();
+ final List<String> all = Arrays.asList(ALL_ANNOTATIONS);
+ addAnnotationTypeToShowHide(showAnnotationsMenu, all, true, true);
+ addAnnotationTypeToShowHide(hideAnnotationsMenu, all, true, false);
+ showAnnotationsMenu.addSeparator();
+ hideAnnotationsMenu.addSeparator();
+
+ final AlignmentAnnotation[] annotations = ap.getAlignment()
+ .getAlignmentAnnotation();
+ BitSet visibleGraphGroups = PopupMenu
+ .getVisibleLineGraphGroups(annotations);
+
+ List<List<String>> shownTypes = new ArrayList<List<String>>();
+ List<List<String>> hiddenTypes = new ArrayList<List<String>>();
+ PopupMenu.getAnnotationTypesForShowHide(shownTypes, hiddenTypes,
+ visibleGraphGroups, annotations, ap.av.getSelectionGroup());
+
+ for (List<String> types : hiddenTypes)
+ {
+ addAnnotationTypeToShowHide(showAnnotationsMenu, types, false, true);
+ }
+
+ for (List<String> types : shownTypes)
+ {
+ addAnnotationTypeToShowHide(hideAnnotationsMenu, types, false, false);
+ }
+ }
+
+ /**
+ * Helper method to populate lists of annotation types for the Show/Hide
+ * Annotations menus. If sequenceGroup is not null, this is restricted to
+ * annotations which are associated with sequences in the selection group.
+ * <p/>
+ * If an annotation row is currently visible, its type (label) is added (once
+ * only per type), to the shownTypes list. If it is currently hidden, it is
+ * added to the hiddenTypesList.
+ * <p/>
+ * For rows that belong to a line graph group, so are always rendered
+ * together:
+ * <ul>
+ * <li>Treat all rows in the group as visible, if at least one of them is</li>
+ * <li>Build a comma-separated label with all the types that belong to the
+ * group</li>
+ * </ul>
+ *
+ * @param shownTypes
+ * @param hiddenTypes
+ * @param visibleGraphGroups
+ * @param annotations
+ * @param sequenceGroup
+ */
+ public static void getAnnotationTypesForShowHide(
+ List<List<String>> shownTypes, List<List<String>> hiddenTypes,
+ BitSet visibleGraphGroups, AlignmentAnnotation[] annotations,
+ SequenceGroup sequenceGroup)
+ {
+ // lookup table, key = graph group, value = list of types in the group
+ Map<Integer, List<String>> groupLabels = new LinkedHashMap<Integer, List<String>>();
+
+ List<String> addedToShown = new ArrayList<String>();
+ List<String> addedToHidden = new ArrayList<String>();
+
+ for (AlignmentAnnotation aa : annotations)
+ {
+
+ if (sequenceGroup == null
+ || (aa.sequenceRef != null && sequenceGroup.getSequences()
+ .contains(aa.sequenceRef)))
+ {
+ /*
+ * Build a 'composite label' for types in line graph groups.
+ */
+ final List<String> labelAsList = new ArrayList<String>();
+ labelAsList.add(aa.label);
+ if (aa.graph == AlignmentAnnotation.LINE_GRAPH
+ && aa.graphGroup > -1)
+ {
+ if (groupLabels.containsKey(aa.graphGroup))
+ {
+ if (!groupLabels.get(aa.graphGroup).contains(aa.label))
+ {
+ groupLabels.get(aa.graphGroup).add(aa.label);
+ }
+ }
+ else
+ {
+ groupLabels.put(aa.graphGroup, labelAsList);
+ }
+ }
+ else if (aa.visible && !addedToShown.contains(aa.label))
+ {
+ shownTypes.add(labelAsList);
+ addedToShown.add(aa.label);
+ }
+ else
+ {
+ if (!aa.visible && !addedToHidden.contains(aa.label))
+ {
+ hiddenTypes.add(labelAsList);
+ addedToHidden.add(aa.label);
+ }
+ }
+ }
+ }
+ /*
+ * finally add the 'composite group labels' to the appropriate lists,
+ * depending on whether the group is identified as visible or hidden
+ */
+ for (int group : groupLabels.keySet())
+ {
+ final List<String> groupLabel = groupLabels.get(group);
+ if (visibleGraphGroups.get(group))
+ {
+ if (!shownTypes.contains(groupLabel))
+ {
+ shownTypes.add(groupLabel);
+ }
+ }
+ else if (!hiddenTypes.contains(groupLabel))
+ {
+ hiddenTypes.add(groupLabel);
+ }
+ }
+ }
+
+ /**
+ * Returns a BitSet (possibly empty) of those graphGroups for line graph
+ * annotations, which have at least one member annotation row marked visible.
+ * The logic is that only one row in the group is marked visible, but when it
+ * is drawn, so are all the other rows in the same group.
+ * <p/>
+ * This lookup set allows us to check whether rows marked not visible are in
+ * fact shown.
+ *
+ * @see AnnotationRenderer#drawComponent
+ * @param annotations
+ * @return
+ */
+ public static BitSet getVisibleLineGraphGroups(
+ AlignmentAnnotation[] annotations)
+ {
+ // todo move to a utility class
+ BitSet result = new BitSet();
+ for (AlignmentAnnotation ann : annotations)
+ {
+ if (ann.graph == AlignmentAnnotation.LINE_GRAPH && ann.visible)
+ {
+ int gg = ann.graphGroup;
+ if (gg > -1)
+ {
+ result.set(gg);
+ }
+ }
+ }
+ return result;
+ }
+
+ /**
+ * Add one annotation type to the 'Show Annotations' or 'Hide Annotations'
+ * menus.
+ *
+ * @param showOrHideMenu
+ * the menu to add to
+ * @param types
+ * the label to add
+ * @param allTypes
+ * if true this is a special label meaning 'All'
+ * @param actionIsShow
+ * if true, the select menu item action is to show the annotation
+ * type, else hide
+ */
+ protected void addAnnotationTypeToShowHide(JMenu showOrHideMenu,
+ final Collection<String> types, final boolean allTypes,
+ final boolean actionIsShow)
+ {
+ String label = types.toString(); // [a, b, c]
+ label = label.substring(1, label.length() - 1);
+ final JMenuItem item = new JMenuItem(label);
+ item.addActionListener(new java.awt.event.ActionListener()
+ {
+ @Override
+ public void actionPerformed(ActionEvent e)
+ {
+ showHideAnnotation_actionPerformed(types, allTypes, actionIsShow);
+ }
+ });
+ showOrHideMenu.add(item);
+ }
+
+ /**
+ * Action on selecting a list of annotation type (or the 'all types' values)
+ * to show or hide for the selection.
+ *
+ * @param types
+ * @param anyType
+ * @param doShow
+ */
+ protected void showHideAnnotation_actionPerformed(
+ Collection<String> types, boolean anyType, boolean doShow)
+ {
+ for (AlignmentAnnotation aa : ap.getAlignment()
+ .getAlignmentAnnotation())
+ {
+ if (anyType || types.contains(aa.label))
+ {
+ if ((aa.sequenceRef != null)
+ && ap.av.getSelectionGroup().getSequences()
+ .contains(aa.sequenceRef))
+ {
+ aa.visible = doShow;
+ }
+ }
+ }
+ refresh();
+ }
+
+ private void buildGroupURLMenu(SequenceGroup sg, Vector groupLinks)
+ {
+
+ // TODO: usability: thread off the generation of group url content so root
+ // menu appears asap
+ // sequence only URLs
+ // ID/regex match URLs
+ groupLinksMenu = new JMenu(
+ MessageManager.getString("action.group_link"));
+ JMenu[] linkMenus = new JMenu[]
+ { null, new JMenu(MessageManager.getString("action.ids")),
+ new JMenu(MessageManager.getString("action.sequences")),
+ new JMenu(MessageManager.getString("action.ids_sequences")) }; // three
+ // types
+ // of url
+ // that
+ // might
+ // be
+ // created.
+ SequenceI[] seqs = ap.av.getSelectionAsNewSequence();
+ String[][] idandseqs = GroupUrlLink.formStrings(seqs);
+ Hashtable commonDbrefs = new Hashtable();
+ for (int sq = 0; sq < seqs.length; sq++)
+ {
+
+ int start = seqs[sq].findPosition(sg.getStartRes()), end = seqs[sq]
+ .findPosition(sg.getEndRes());
+ // just collect ids from dataset sequence
+ // TODO: check if IDs collected from selecton group intersects with the
+ // current selection, too
+ SequenceI sqi = seqs[sq];
+ while (sqi.getDatasetSequence() != null)
+ {
+ sqi = sqi.getDatasetSequence();
+ }
+ DBRefEntry[] dbr = sqi.getDBRef();
+ if (dbr != null && dbr.length > 0)
+ {
+ for (int d = 0; d < dbr.length; d++)
+ {
+ String src = dbr[d].getSource(); // jalview.util.DBRefUtils.getCanonicalName(dbr[d].getSource()).toUpperCase();
+ Object[] sarray = (Object[]) commonDbrefs.get(src);
+ if (sarray == null)
+ {
+ sarray = new Object[2];
+ sarray[0] = new int[]
+ { 0 };
+ sarray[1] = new String[seqs.length];
+
+ commonDbrefs.put(src, sarray);
+ }
+
+ if (((String[]) sarray[1])[sq] == null)
+ {
+ if (!dbr[d].hasMap()
+ || (dbr[d].getMap().locateMappedRange(start, end) != null))
+ {
+ ((String[]) sarray[1])[sq] = dbr[d].getAccessionId();
+ ((int[]) sarray[0])[0]++;
+ }
+ }
+ }
+ }
+ }
+ // now create group links for all distinct ID/sequence sets.
+ boolean addMenu = false; // indicates if there are any group links to give
+ // to user
+ for (int i = 0; i < groupLinks.size(); i++)
+ {
+ String link = groupLinks.elementAt(i).toString();
+ GroupUrlLink urlLink = null;
+ try
+ {
+ urlLink = new GroupUrlLink(link);
+ } catch (Exception foo)
+ {
+ jalview.bin.Cache.log.error("Exception for GroupURLLink '" + link
+ + "'", foo);
+ continue;
+ }
+ ;
+ if (!urlLink.isValid())
+ {
+ jalview.bin.Cache.log.error(urlLink.getInvalidMessage());
+ continue;
+ }
+ final String label = urlLink.getLabel();
+ boolean usingNames = false;
+ // Now see which parts of the group apply for this URL
+ String ltarget = urlLink.getTarget(); // jalview.util.DBRefUtils.getCanonicalName(urlLink.getTarget());
+ Object[] idset = (Object[]) commonDbrefs.get(ltarget.toUpperCase());
+ String[] seqstr, ids; // input to makeUrl
+ if (idset != null)
+ {
+ int numinput = ((int[]) idset[0])[0];
+ String[] allids = ((String[]) idset[1]);
+ seqstr = new String[numinput];
+ ids = new String[numinput];
+ for (int sq = 0, idcount = 0; sq < seqs.length; sq++)
+ {
+ if (allids[sq] != null)
+ {
+ ids[idcount] = allids[sq];
+ seqstr[idcount++] = idandseqs[1][sq];
+ }
+ }
+ }
+ else
+ {
+ // just use the id/seq set
+ seqstr = idandseqs[1];
+ ids = idandseqs[0];
+ usingNames = true;
+ }
+ // and try and make the groupURL!
+
+ Object[] urlset = null;
+ try
+ {
+ urlset = urlLink.makeUrlStubs(ids, seqstr,
+ "FromJalview" + System.currentTimeMillis(), false);
+ } catch (UrlStringTooLongException e)
+ {
+ }
+ if (urlset != null)
+ {
+ int type = urlLink.getGroupURLType() & 3;
+ // System.out.println(urlLink.getGroupURLType()
+ // +" "+((String[])urlset[3])[0]);
+ // first two bits ofurlLink type bitfield are sequenceids and sequences
+ // TODO: FUTURE: ensure the groupURL menu structure can be generalised
+ addshowLink(linkMenus[type], label
+ + (((type & 1) == 1) ? ("("
+ + (usingNames ? "Names" : ltarget) + ")") : ""),
+ urlLink, urlset);
+ addMenu = true;
+ }
+ }
+ if (addMenu)
+ {
+ groupLinksMenu = new JMenu(
+ MessageManager.getString("action.group_link"));
+ for (int m = 0; m < linkMenus.length; m++)
+ {
+ if (linkMenus[m] != null
+ && linkMenus[m].getMenuComponentCount() > 0)
+ {
+ groupLinksMenu.add(linkMenus[m]);
+ }
+ }
+
+ groupMenu.add(groupLinksMenu);
+ }
+ }
+
+ /**