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