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