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