src/jalview/schemes/ColourSchemeI.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.schemes;
  22
  23 import jalview.datamodel.AnnotatedCollectionI;
  24 import jalview.datamodel.ProfilesI;
  25 import jalview.datamodel.SequenceCollectionI;
  26 import jalview.datamodel.SequenceI;
  27
  28 import java.awt.Color;
  29 import java.util.Map;
  30
  31 public interface ColourSchemeI
  32 {
  33   /**
  34    *
  35    * @param c
  36    * @return the colour for the given character
  37    */
  38   public Color findColour(char c);
  39
  40   /**
  41    *
  42    * @param c
  43    *          - sequence symbol or gap
  44    * @param j
  45    *          - position in seq
  46    * @param seq
  47    *          - sequence being coloured
  48    * @return context dependent colour for the given symbol at the position in
  49    *         the given sequence
  50    */
  51   public Color findColour(char c, int j, SequenceI seq);
  52
  53   /**
  54    * assign the given consensus profile for the colourscheme
  55    */
  56   public void setConsensus(ProfilesI hconsensus);
  57
  58   /**
  59    * assign the given conservation to the colourscheme
  60    *
  61    * @param c
  62    */
  63   public void setConservation(jalview.analysis.Conservation c);
  64
  65   /**
  66    * enable or disable conservation shading for this colourscheme
  67    *
  68    * @param conservationApplied
  69    */
  70   public void setConservationApplied(boolean conservationApplied);
  71
  72   /**
  73    *
  74    * @return true if conservation shading is enabled for this colourscheme
  75    */
  76   public boolean conservationApplied();
  77
  78   /**
  79    * set scale factor for bleaching of colour in unconserved regions
  80    *
  81    * @param i
  82    */
  83   public void setConservationInc(int i);
  84
  85   /**
  86    *
  87    * @return scale factor for bleaching colour in unconserved regions
  88    */
  89   public int getConservationInc();
  90
  91   /**
  92    *
  93    * @return percentage identity threshold for applying colourscheme
  94    */
  95   public int getThreshold();
  96
  97   /**
  98    * set percentage identity threshold and type of %age identity calculation for
  99    * shading
 100    *
 101    * @param ct
 102    *          0..100 percentage identity for applying this colourscheme
 103    * @param ignoreGaps
 104    *          when true, calculate PID without including gapped positions
 105    */
 106   public void setThreshold(int ct, boolean ignoreGaps);
 107
 108   /**
 109    * recalculate dependent data using the given sequence collection, taking
 110    * account of hidden rows
 111    *
 112    * @param alignment
 113    * @param hiddenReps
 114    */
 115   public void alignmentChanged(AnnotatedCollectionI alignment,
 116           Map<SequenceI, SequenceCollectionI> hiddenReps);
 117
 118   /**
 119    * create a new instance of the colourscheme configured to colour the given
 120    * connection
 121    *
 122    * @param sg
 123    * @param hiddenRepSequences
 124    * @return copy of current scheme with any inherited settings transfered
 125    */
 126   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
 127           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
 128
 129 }