Merge branch 'develop' into features/JAL-2446NCList
[jalview.git] / src / jalview / viewmodel / seqfeatures / FeatureRendererModel.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  * 
5  * This file is part of Jalview.
6  * 
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *  
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  * 
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 package jalview.viewmodel.seqfeatures;
22
23 import jalview.api.AlignViewportI;
24 import jalview.api.FeatureColourI;
25 import jalview.api.FeaturesDisplayedI;
26 import jalview.datamodel.AlignmentI;
27 import jalview.datamodel.SequenceFeature;
28 import jalview.datamodel.SequenceI;
29 import jalview.renderer.seqfeatures.FeatureRenderer;
30 import jalview.schemes.FeatureColour;
31 import jalview.util.ColorUtils;
32
33 import java.awt.Color;
34 import java.beans.PropertyChangeListener;
35 import java.beans.PropertyChangeSupport;
36 import java.util.ArrayList;
37 import java.util.Arrays;
38 import java.util.Collections;
39 import java.util.HashMap;
40 import java.util.HashSet;
41 import java.util.Hashtable;
42 import java.util.List;
43 import java.util.Map;
44 import java.util.Set;
45 import java.util.concurrent.ConcurrentHashMap;
46
47 public abstract class FeatureRendererModel implements
48         jalview.api.FeatureRenderer
49 {
50
51   /**
52    * global transparency for feature
53    */
54   protected float transparency = 1.0f;
55
56   protected Map<String, FeatureColourI> featureColours = new ConcurrentHashMap<String, FeatureColourI>();
57
58   protected Map<String, Boolean> featureGroups = new ConcurrentHashMap<String, Boolean>();
59
60   protected String[] renderOrder;
61
62   Map<String, Float> featureOrder = null;
63
64   protected PropertyChangeSupport changeSupport = new PropertyChangeSupport(
65           this);
66
67   protected AlignViewportI av;
68
69   @Override
70   public AlignViewportI getViewport()
71   {
72     return av;
73   }
74
75   public FeatureRendererSettings getSettings()
76   {
77     return new FeatureRendererSettings(this);
78   }
79
80   public void transferSettings(FeatureRendererSettings fr)
81   {
82     this.renderOrder = fr.renderOrder;
83     this.featureGroups = fr.featureGroups;
84     this.featureColours = fr.featureColours;
85     this.transparency = fr.transparency;
86     this.featureOrder = fr.featureOrder;
87   }
88
89   /**
90    * update from another feature renderer
91    * 
92    * @param fr
93    *          settings to copy
94    */
95   public void transferSettings(jalview.api.FeatureRenderer _fr)
96   {
97     FeatureRenderer fr = (FeatureRenderer) _fr;
98     FeatureRendererSettings frs = new FeatureRendererSettings(fr);
99     this.renderOrder = frs.renderOrder;
100     this.featureGroups = frs.featureGroups;
101     this.featureColours = frs.featureColours;
102     this.transparency = frs.transparency;
103     this.featureOrder = frs.featureOrder;
104     if (av != null && av != fr.getViewport())
105     {
106       // copy over the displayed feature settings
107       if (_fr.getFeaturesDisplayed() != null)
108       {
109         FeaturesDisplayedI fd = getFeaturesDisplayed();
110         if (fd == null)
111         {
112           setFeaturesDisplayedFrom(_fr.getFeaturesDisplayed());
113         }
114         else
115         {
116           synchronized (fd)
117           {
118             fd.clear();
119             for (String type : _fr.getFeaturesDisplayed()
120                     .getVisibleFeatures())
121             {
122               fd.setVisible(type);
123             }
124           }
125         }
126       }
127     }
128   }
129
130   public void setFeaturesDisplayedFrom(FeaturesDisplayedI featuresDisplayed)
131   {
132     av.setFeaturesDisplayed(new FeaturesDisplayed(featuresDisplayed));
133   }
134
135   @Override
136   public void setVisible(String featureType)
137   {
138     FeaturesDisplayedI fdi = av.getFeaturesDisplayed();
139     if (fdi == null)
140     {
141       av.setFeaturesDisplayed(fdi = new FeaturesDisplayed());
142     }
143     if (!fdi.isRegistered(featureType))
144     {
145       pushFeatureType(Arrays.asList(new String[] { featureType }));
146     }
147     fdi.setVisible(featureType);
148   }
149
150   @Override
151   public void setAllVisible(List<String> featureTypes)
152   {
153     FeaturesDisplayedI fdi = av.getFeaturesDisplayed();
154     if (fdi == null)
155     {
156       av.setFeaturesDisplayed(fdi = new FeaturesDisplayed());
157     }
158     List<String> nft = new ArrayList<String>();
159     for (String featureType : featureTypes)
160     {
161       if (!fdi.isRegistered(featureType))
162       {
163         nft.add(featureType);
164       }
165     }
166     if (nft.size() > 0)
167     {
168       pushFeatureType(nft);
169     }
170     fdi.setAllVisible(featureTypes);
171   }
172
173   /**
174    * push a set of new types onto the render order stack. Note - this is a
175    * direct mechanism rather than the one employed in updateRenderOrder
176    * 
177    * @param types
178    */
179   private void pushFeatureType(List<String> types)
180   {
181
182     int ts = types.size();
183     String neworder[] = new String[(renderOrder == null ? 0
184             : renderOrder.length) + ts];
185     types.toArray(neworder);
186     if (renderOrder != null)
187     {
188       System.arraycopy(neworder, 0, neworder, renderOrder.length, ts);
189       System.arraycopy(renderOrder, 0, neworder, 0, renderOrder.length);
190     }
191     renderOrder = neworder;
192   }
193
194   protected Map<String, float[][]> minmax = new Hashtable<String, float[][]>();
195
196   public Map<String, float[][]> getMinMax()
197   {
198     return minmax;
199   }
200
201   /**
202    * normalise a score against the max/min bounds for the feature type.
203    * 
204    * @param sequenceFeature
205    * @return byte[] { signed, normalised signed (-127 to 127) or unsigned
206    *         (0-255) value.
207    */
208   protected final byte[] normaliseScore(SequenceFeature sequenceFeature)
209   {
210     float[] mm = minmax.get(sequenceFeature.type)[0];
211     final byte[] r = new byte[] { 0, (byte) 255 };
212     if (mm != null)
213     {
214       if (r[0] != 0 || mm[0] < 0.0)
215       {
216         r[0] = 1;
217         r[1] = (byte) ((int) 128.0 + 127.0 * (sequenceFeature.score / mm[1]));
218       }
219       else
220       {
221         r[1] = (byte) ((int) 255.0 * (sequenceFeature.score / mm[1]));
222       }
223     }
224     return r;
225   }
226
227   boolean newFeatureAdded = false;
228
229   boolean findingFeatures = false;
230
231   protected boolean updateFeatures()
232   {
233     if (av.getFeaturesDisplayed() == null || renderOrder == null
234             || newFeatureAdded)
235     {
236       findAllFeatures();
237       if (av.getFeaturesDisplayed().getVisibleFeatureCount() < 1)
238       {
239         return false;
240       }
241     }
242     // TODO: decide if we should check for the visible feature count first
243     return true;
244   }
245
246   /**
247    * search the alignment for all new features, give them a colour and display
248    * them. Then fires a PropertyChangeEvent on the changeSupport object.
249    * 
250    */
251   protected void findAllFeatures()
252   {
253     synchronized (firing)
254     {
255       if (firing.equals(Boolean.FALSE))
256       {
257         firing = Boolean.TRUE;
258         findAllFeatures(true); // add all new features as visible
259         changeSupport.firePropertyChange("changeSupport", null, null);
260         firing = Boolean.FALSE;
261       }
262     }
263   }
264
265   @Override
266   public List<SequenceFeature> findFeaturesAtRes(SequenceI sequence, int res)
267   {
268     List<SequenceFeature> result = new ArrayList<SequenceFeature>();
269     if (!av.areFeaturesDisplayed())
270     {
271       return result;
272     }
273
274     Set<String> visibleFeatures = getFeaturesDisplayed()
275             .getVisibleFeatures();
276     String[] visibleTypes = visibleFeatures
277             .toArray(new String[visibleFeatures.size()]);
278
279     /*
280      * include features at the position provided their feature type is 
281      * displayed, and feature group is null or marked for display
282      */
283     List<SequenceFeature> features = sequence.getFeatures().findFeatures(
284             res, res, visibleTypes);
285
286     for (SequenceFeature sf : features)
287     {
288       if (!featureGroupNotShown(sf))
289       {
290         result.add(sf);
291       }
292     }
293     return result;
294   }
295
296   /**
297    * Searches alignment for all features and updates colours
298    * 
299    * @param newMadeVisible
300    *          if true newly added feature types will be rendered immediately
301    *          TODO: check to see if this method should actually be proxied so
302    *          repaint events can be propagated by the renderer code
303    */
304   @Override
305   public synchronized void findAllFeatures(boolean newMadeVisible)
306   {
307     newFeatureAdded = false;
308
309     if (findingFeatures)
310     {
311       newFeatureAdded = true;
312       return;
313     }
314
315     findingFeatures = true;
316     if (av.getFeaturesDisplayed() == null)
317     {
318       av.setFeaturesDisplayed(new FeaturesDisplayed());
319     }
320     FeaturesDisplayedI featuresDisplayed = av.getFeaturesDisplayed();
321
322     Set<String> oldfeatures = new HashSet<String>();
323     if (renderOrder != null)
324     {
325       for (int i = 0; i < renderOrder.length; i++)
326       {
327         if (renderOrder[i] != null)
328         {
329           oldfeatures.add(renderOrder[i]);
330         }
331       }
332     }
333     // <<<<<<< HEAD
334     //
335     // =======
336     // if (minmax == null)
337     // {
338     // minmax = new Hashtable<String, float[][]>();
339     // }
340     //
341     // Set<String> oldGroups = new HashSet<String>(featureGroups.keySet());
342     // >>>>>>> refs/heads/develop
343     AlignmentI alignment = av.getAlignment();
344     List<String> allfeatures = new ArrayList<String>(); // or HashSet?
345
346     for (int i = 0; i < alignment.getHeight(); i++)
347     {
348       SequenceI asq = alignment.getSequenceAt(i);
349       for (String group : asq.getFeatures().getFeatureGroups(true))
350       {
351         // <<<<<<< HEAD
352         /*
353          * features in null group are always displayed; other groups
354          * keep their current visibility; new groups as 'newMadeVisible'
355          */
356         boolean groupDisplayed = true;
357         if (group != null)
358         // =======
359         // continue;
360         // }
361         //
362         // int index = 0;
363         // while (index < features.length)
364         // {
365         // String fgrp = features[index].getFeatureGroup();
366         // oldGroups.remove(fgrp);
367         // if (!featuresDisplayed.isRegistered(features[index].getType()))
368         // >>>>>>> refs/heads/develop
369         {
370           // <<<<<<< HEAD
371           if (featureGroups.containsKey(group))
372           // =======
373           // if (fgrp != null)
374           // >>>>>>> refs/heads/develop
375           {
376             groupDisplayed = featureGroups.get(group);
377           }
378           else
379           {
380             groupDisplayed = newMadeVisible;
381             featureGroups.put(group, groupDisplayed);
382           }
383         }
384         if (groupDisplayed)
385         {
386           Set<String> types = asq.getFeatures().getFeatureTypesForGroups(
387                   true, group);
388           for (String type : types)
389           {
390             if (!allfeatures.contains(type)) // or use HashSet and no test?
391             {
392               allfeatures.add(type);
393             }
394             updateMinMax(asq, type, true); // todo: for all features?
395           }
396         }
397       }
398     }
399
400     /*
401     //<<<<<<< HEAD
402      * mark any new feature types as visible
403      */
404     Collections.sort(allfeatures, String.CASE_INSENSITIVE_ORDER);
405     if (newMadeVisible)
406     {
407       for (String type : allfeatures)
408       {
409         if (!oldfeatures.contains(type))
410         {
411           featuresDisplayed.setVisible(type);
412           setOrder(type, 0);
413         }
414       }
415       // =======
416       // * oldGroups now consists of groups that no longer
417       // * have any feature in them - remove these
418       // */
419       // for (String grp : oldGroups)
420       // {
421       // featureGroups.remove(grp);
422       // >>>>>>> refs/heads/develop
423     }
424
425     updateRenderOrder(allfeatures);
426     findingFeatures = false;
427   }
428
429   /**
430    * Updates the global (alignment) min and max values for a feature type from
431    * the score for a sequence, if the score is not NaN. Values are stored
432    * separately for positional and non-positional features.
433    * 
434    * @param seq
435    * @param featureType
436    * @param positional
437    */
438   protected void updateMinMax(SequenceI seq, String featureType,
439           boolean positional)
440   {
441     float min = seq.getFeatures().getMinimumScore(featureType, positional);
442     if (Float.isNaN(min))
443     {
444       return;
445     }
446
447     float max = seq.getFeatures().getMaximumScore(featureType, positional);
448
449     /*
450      * stored values are 
451      * { {positionalMin, positionalMax}, {nonPositionalMin, nonPositionalMax} }
452      */
453     if (minmax == null)
454     {
455       minmax = new Hashtable<String, float[][]>();
456     }
457     synchronized (minmax)
458     {
459       float[][] mm = minmax.get(featureType);
460       int index = positional ? 0 : 1;
461       if (mm == null)
462       {
463         mm = new float[][] { null, null };
464         minmax.put(featureType, mm);
465       }
466       if (mm[index] == null)
467       {
468         mm[index] = new float[] { min, max };
469       }
470       else
471       {
472         mm[index][0] = Math.min(mm[index][0], min);
473         mm[index][1] = Math.max(mm[index][1], max);
474       }
475     }
476   }
477   protected Boolean firing = Boolean.FALSE;
478
479   /**
480    * replaces the current renderOrder with the unordered features in
481    * allfeatures. The ordering of any types in both renderOrder and allfeatures
482    * is preserved, and all new feature types are rendered on top of the existing
483    * types, in the order given by getOrder or the order given in allFeatures.
484    * Note. this operates directly on the featureOrder hash for efficiency. TODO:
485    * eliminate the float storage for computing/recalling the persistent ordering
486    * New Cability: updates min/max for colourscheme range if its dynamic
487    * 
488    * @param allFeatures
489    */
490   private void updateRenderOrder(List<String> allFeatures)
491   {
492     List<String> allfeatures = new ArrayList<String>(allFeatures);
493     String[] oldRender = renderOrder;
494     renderOrder = new String[allfeatures.size()];
495     boolean initOrders = (featureOrder == null);
496     int opos = 0;
497     if (oldRender != null && oldRender.length > 0)
498     {
499       for (int j = 0; j < oldRender.length; j++)
500       {
501         if (oldRender[j] != null)
502         {
503           if (initOrders)
504           {
505             setOrder(oldRender[j], (1 - (1 + (float) j) / oldRender.length));
506           }
507           if (allfeatures.contains(oldRender[j]))
508           {
509             renderOrder[opos++] = oldRender[j]; // existing features always
510             // appear below new features
511             allfeatures.remove(oldRender[j]);
512             if (minmax != null)
513             {
514               float[][] mmrange = minmax.get(oldRender[j]);
515               if (mmrange != null)
516               {
517                 FeatureColourI fc = featureColours.get(oldRender[j]);
518                 if (fc != null && !fc.isSimpleColour() && fc.isAutoScaled())
519                 {
520                   fc.updateBounds(mmrange[0][0], mmrange[0][1]);
521                 }
522               }
523             }
524           }
525         }
526       }
527     }
528     if (allfeatures.size() == 0)
529     {
530       // no new features - leave order unchanged.
531       return;
532     }
533     int i = allfeatures.size() - 1;
534     int iSize = i;
535     boolean sort = false;
536     String[] newf = new String[allfeatures.size()];
537     float[] sortOrder = new float[allfeatures.size()];
538     for (String newfeat : allfeatures)
539     {
540       newf[i] = newfeat;
541       if (minmax != null)
542       {
543         // update from new features minmax if necessary
544         float[][] mmrange = minmax.get(newf[i]);
545         if (mmrange != null)
546         {
547           FeatureColourI fc = featureColours.get(newf[i]);
548           if (fc != null && !fc.isSimpleColour() && fc.isAutoScaled())
549           {
550             fc.updateBounds(mmrange[0][0], mmrange[0][1]);
551           }
552         }
553       }
554       if (initOrders || !featureOrder.containsKey(newf[i]))
555       {
556         int denom = initOrders ? allfeatures.size() : featureOrder.size();
557         // new unordered feature - compute persistent ordering at head of
558         // existing features.
559         setOrder(newf[i], i / (float) denom);
560       }
561       // set order from newly found feature from persisted ordering.
562       sortOrder[i] = 2 - featureOrder.get(newf[i]).floatValue();
563       if (i < iSize)
564       {
565         // only sort if we need to
566         sort = sort || sortOrder[i] > sortOrder[i + 1];
567       }
568       i--;
569     }
570     if (iSize > 1 && sort)
571     {
572       jalview.util.QuickSort.sort(sortOrder, newf);
573     }
574     sortOrder = null;
575     System.arraycopy(newf, 0, renderOrder, opos, newf.length);
576   }
577
578   /**
579    * get a feature style object for the given type string. Creates a
580    * java.awt.Color for a featureType with no existing colourscheme.
581    * 
582    * @param featureType
583    * @return
584    */
585   @Override
586   public FeatureColourI getFeatureStyle(String featureType)
587   {
588     FeatureColourI fc = featureColours.get(featureType);
589     if (fc == null)
590     {
591       Color col = ColorUtils.createColourFromName(featureType);
592       fc = new FeatureColour(col);
593       featureColours.put(featureType, fc);
594     }
595     return fc;
596   }
597
598   /**
599    * Returns the configured colour for a particular feature instance. This
600    * includes calculation of 'colour by label', or of a graduated score colour,
601    * if applicable. It does not take into account feature visibility or colour
602    * transparency.
603    * 
604    * @param feature
605    * @return
606    */
607   public Color getColour(SequenceFeature feature)
608   {
609     FeatureColourI fc = getFeatureStyle(feature.getType());
610     return fc.getColor(feature);
611   }
612
613   /**
614    * Answers true unless the feature has a graduated colour scheme and the
615    * feature value lies outside the current threshold for display
616    * 
617    * @param sequenceFeature
618    * @return
619    */
620   protected boolean showFeature(SequenceFeature sequenceFeature)
621   {
622     FeatureColourI fc = getFeatureStyle(sequenceFeature.type);
623     return fc.isColored(sequenceFeature);
624   }
625
626   /**
627    * Answers true if the feature type is currently selected to be displayed,
628    * else false
629    * 
630    * @param type
631    * @return
632    */
633   protected boolean showFeatureOfType(String type)
634   {
635     return type == null ? false : av.getFeaturesDisplayed().isVisible(type);
636   }
637
638   @Override
639   public void setColour(String featureType, FeatureColourI col)
640   {
641     featureColours.put(featureType, col);
642   }
643
644   @Override
645   public void setTransparency(float value)
646   {
647     transparency = value;
648   }
649
650   @Override
651   public float getTransparency()
652   {
653     return transparency;
654   }
655
656   /**
657    * analogous to colour - store a normalized ordering for all feature types in
658    * this rendering context.
659    * 
660    * @param type
661    *          Feature type string
662    * @param position
663    *          normalized priority - 0 means always appears on top, 1 means
664    *          always last.
665    */
666   public float setOrder(String type, float position)
667   {
668     if (featureOrder == null)
669     {
670       featureOrder = new Hashtable<String, Float>();
671     }
672     featureOrder.put(type, new Float(position));
673     return position;
674   }
675
676   /**
677    * get the global priority (0 (top) to 1 (bottom))
678    * 
679    * @param type
680    * @return [0,1] or -1 for a type without a priority
681    */
682   public float getOrder(String type)
683   {
684     if (featureOrder != null)
685     {
686       if (featureOrder.containsKey(type))
687       {
688         return featureOrder.get(type).floatValue();
689       }
690     }
691     return -1;
692   }
693
694   @Override
695   public Map<String, FeatureColourI> getFeatureColours()
696   {
697     return featureColours;
698   }
699
700   /**
701    * Replace current ordering with new ordering
702    * 
703    * @param data
704    *          { String(Type), Colour(Type), Boolean(Displayed) }
705    * @return true if any visible features have been reordered, else false
706    */
707   public boolean setFeaturePriority(Object[][] data)
708   {
709     return setFeaturePriority(data, true);
710   }
711
712   /**
713    * Sets the priority order for features, with the highest priority (displayed
714    * on top) at the start of the data array
715    * 
716    * @param data
717    *          { String(Type), Colour(Type), Boolean(Displayed) }
718    * @param visibleNew
719    *          when true current featureDisplay list will be cleared
720    * @return true if any visible features have been reordered or recoloured,
721    *         else false (i.e. no need to repaint)
722    */
723   public boolean setFeaturePriority(Object[][] data, boolean visibleNew)
724   {
725     /*
726      * note visible feature ordering and colours before update
727      */
728     List<String> visibleFeatures = getDisplayedFeatureTypes();
729     Map<String, FeatureColourI> visibleColours = new HashMap<String, FeatureColourI>(
730             getFeatureColours());
731
732     FeaturesDisplayedI av_featuresdisplayed = null;
733     if (visibleNew)
734     {
735       if ((av_featuresdisplayed = av.getFeaturesDisplayed()) != null)
736       {
737         av.getFeaturesDisplayed().clear();
738       }
739       else
740       {
741         av.setFeaturesDisplayed(av_featuresdisplayed = new FeaturesDisplayed());
742       }
743     }
744     else
745     {
746       av_featuresdisplayed = av.getFeaturesDisplayed();
747     }
748     if (data == null)
749     {
750       return false;
751     }
752     // The feature table will display high priority
753     // features at the top, but these are the ones
754     // we need to render last, so invert the data
755     renderOrder = new String[data.length];
756
757     if (data.length > 0)
758     {
759       for (int i = 0; i < data.length; i++)
760       {
761         String type = data[i][0].toString();
762         setColour(type, (FeatureColourI) data[i][1]);
763         if (((Boolean) data[i][2]).booleanValue())
764         {
765           av_featuresdisplayed.setVisible(type);
766         }
767
768         renderOrder[data.length - i - 1] = type;
769       }
770     }
771
772     /*
773      * get the new visible ordering and return true if it has changed
774      * order or any colour has changed
775      */
776     List<String> reorderedVisibleFeatures = getDisplayedFeatureTypes();
777     if (!visibleFeatures.equals(reorderedVisibleFeatures))
778     {
779       /*
780        * the list of ordered visible features has changed
781        */
782       return true;
783     }
784
785     /*
786      * return true if any feature colour has changed
787      */
788     for (String feature : visibleFeatures)
789     {
790       if (visibleColours.get(feature) != getFeatureStyle(feature))
791       {
792         return true;
793       }
794     }
795     return false;
796   }
797
798   /**
799    * @param listener
800    * @see java.beans.PropertyChangeSupport#addPropertyChangeListener(java.beans.PropertyChangeListener)
801    */
802   public void addPropertyChangeListener(PropertyChangeListener listener)
803   {
804     changeSupport.addPropertyChangeListener(listener);
805   }
806
807   /**
808    * @param listener
809    * @see java.beans.PropertyChangeSupport#removePropertyChangeListener(java.beans.PropertyChangeListener)
810    */
811   public void removePropertyChangeListener(PropertyChangeListener listener)
812   {
813     changeSupport.removePropertyChangeListener(listener);
814   }
815
816   public Set<String> getAllFeatureColours()
817   {
818     return featureColours.keySet();
819   }
820
821   public void clearRenderOrder()
822   {
823     renderOrder = null;
824   }
825
826   public boolean hasRenderOrder()
827   {
828     return renderOrder != null;
829   }
830
831   /**
832    * Returns feature types in ordering of rendering, where last means on top
833    */
834   public List<String> getRenderOrder()
835   {
836     if (renderOrder == null)
837     {
838       return Arrays.asList(new String[] {});
839     }
840     return Arrays.asList(renderOrder);
841   }
842
843   public int getFeatureGroupsSize()
844   {
845     return featureGroups != null ? 0 : featureGroups.size();
846   }
847
848   @Override
849   public List<String> getFeatureGroups()
850   {
851     // conflict between applet and desktop - featureGroups returns the map in
852     // the desktop featureRenderer
853     return (featureGroups == null) ? Arrays.asList(new String[0]) : Arrays
854             .asList(featureGroups.keySet().toArray(new String[0]));
855   }
856
857   public boolean checkGroupVisibility(String group, boolean newGroupsVisible)
858   {
859     if (featureGroups == null)
860     {
861       // then an exception happens next..
862     }
863     if (featureGroups.containsKey(group))
864     {
865       return featureGroups.get(group).booleanValue();
866     }
867     if (newGroupsVisible)
868     {
869       featureGroups.put(group, new Boolean(true));
870       return true;
871     }
872     return false;
873   }
874
875   /**
876    * get visible or invisible groups
877    * 
878    * @param visible
879    *          true to return visible groups, false to return hidden ones.
880    * @return list of groups
881    */
882   @Override
883   public List<String> getGroups(boolean visible)
884   {
885     if (featureGroups != null)
886     {
887       List<String> gp = new ArrayList<String>();
888
889       for (String grp : featureGroups.keySet())
890       {
891         Boolean state = featureGroups.get(grp);
892         if (state.booleanValue() == visible)
893         {
894           gp.add(grp);
895         }
896       }
897       return gp;
898     }
899     return null;
900   }
901
902   @Override
903   public void setGroupVisibility(String group, boolean visible)
904   {
905     featureGroups.put(group, new Boolean(visible));
906   }
907
908   @Override
909   public void setGroupVisibility(List<String> toset, boolean visible)
910   {
911     if (toset != null && toset.size() > 0 && featureGroups != null)
912     {
913       boolean rdrw = false;
914       for (String gst : toset)
915       {
916         Boolean st = featureGroups.get(gst);
917         featureGroups.put(gst, new Boolean(visible));
918         if (st != null)
919         {
920           rdrw = rdrw || (visible != st.booleanValue());
921         }
922       }
923       if (rdrw)
924       {
925         // set local flag indicating redraw needed ?
926       }
927     }
928   }
929
930   @Override
931   public Map<String, FeatureColourI> getDisplayedFeatureCols()
932   {
933     Map<String, FeatureColourI> fcols = new Hashtable<String, FeatureColourI>();
934     if (getViewport().getFeaturesDisplayed() == null)
935     {
936       return fcols;
937     }
938     Set<String> features = getViewport().getFeaturesDisplayed()
939             .getVisibleFeatures();
940     for (String feature : features)
941     {
942       fcols.put(feature, getFeatureStyle(feature));
943     }
944     return fcols;
945   }
946
947   @Override
948   public FeaturesDisplayedI getFeaturesDisplayed()
949   {
950     return av.getFeaturesDisplayed();
951   }
952
953   /**
954    * Returns a (possibly empty) list of visible feature types, in render order
955    * (last is on top)
956    */
957   @Override
958   public List<String> getDisplayedFeatureTypes()
959   {
960     List<String> typ = getRenderOrder();
961     List<String> displayed = new ArrayList<String>();
962     FeaturesDisplayedI feature_disp = av.getFeaturesDisplayed();
963     if (feature_disp != null)
964     {
965       synchronized (feature_disp)
966       {
967         for (String type : typ)
968         {
969           if (feature_disp.isVisible(type))
970           {
971             displayed.add(type);
972           }
973         }
974       }
975     }
976     return displayed;
977   }
978
979   @Override
980   public List<String> getDisplayedFeatureGroups()
981   {
982     List<String> _gps = new ArrayList<String>();
983     boolean valid = false;
984     for (String gp : getFeatureGroups())
985     {
986       if (checkGroupVisibility(gp, false))
987       {
988         valid = true;
989         _gps.add(gp);
990       }
991       if (!valid)
992       {
993         return null;
994       }
995       else
996       {
997         // gps = new String[_gps.size()];
998         // _gps.toArray(gps);
999       }
1000     }
1001     return _gps;
1002   }
1003
1004   /**
1005    * Answers true if the feature belongs to a feature group which is not
1006    * currently displayed, else false
1007    * 
1008    * @param sequenceFeature
1009    * @return
1010    */
1011   protected boolean featureGroupNotShown(final SequenceFeature sequenceFeature)
1012   {
1013     return featureGroups != null
1014             && sequenceFeature.featureGroup != null
1015             && sequenceFeature.featureGroup.length() != 0
1016             && featureGroups.containsKey(sequenceFeature.featureGroup)
1017             && !featureGroups.get(sequenceFeature.featureGroup)
1018                     .booleanValue();
1019   }
1020
1021 }