src/jalview/schemes/ColourSchemeI.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1)
   3  * Copyright (C) 2014 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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.schemes;
  20
  21 import java.awt.Color;
  22 import java.util.Map;
  23
  24 import jalview.datamodel.AlignmentI;
  25 import jalview.datamodel.AnnotatedCollectionI;
  26 import jalview.datamodel.SequenceCollectionI;
  27 import jalview.datamodel.SequenceGroup;
  28 import jalview.datamodel.SequenceI;
  29
  30 public interface ColourSchemeI
  31 {
  32   /**
  33    *
  34    * @param c
  35    * @return the colour for the given character
  36    */
  37   public Color findColour(char c);
  38
  39   /**
  40    *
  41    * @param c - sequence symbol or gap
  42    * @param j - position in seq
  43    * @param seq - sequence being coloured
  44    * @return context dependent colour for the given symbol at the position in the given sequence
  45    */
  46   public Color findColour(char c, int j, SequenceI seq);
  47
  48   /**
  49    * assign the given consensus profile for the colourscheme
  50    */
  51   public void setConsensus(java.util.Hashtable[] h);
  52
  53   /**
  54    * assign the given conservation to the colourscheme
  55    * @param c
  56    */
  57   public void setConservation(jalview.analysis.Conservation c);
  58
  59   /**
  60    * enable or disable conservation shading for this colourscheme
  61    * @param conservationApplied
  62    */
  63   public void setConservationApplied(boolean conservationApplied);
  64   /**
  65    *
  66    * @return true if conservation shading is enabled for this colourscheme
  67    */
  68   public boolean conservationApplied();
  69
  70   /**
  71    * set scale factor for bleaching of colour in unconserved regions
  72    * @param i
  73    */
  74   public void setConservationInc(int i);
  75
  76   /**
  77    *
  78    * @return scale factor for bleaching colour in unconserved regions
  79    */
  80   public int getConservationInc();
  81
  82   /**
  83    *
  84    * @return percentage identity threshold for applying colourscheme
  85    */
  86   public int getThreshold();
  87
  88   /**
  89    * set percentage identity threshold and type of %age identity calculation for shading
  90    * @param ct 0..100 percentage identity for applying this colourscheme
  91    * @param ignoreGaps when true, calculate PID without including gapped positions
  92    */
  93   public void setThreshold(int ct, boolean ignoreGaps);
  94
  95   /**
  96    * recalculate dependent data using the given sequence collection, taking account of hidden rows
  97    * @param alignment
  98    * @param hiddenReps
  99    */
 100   public void alignmentChanged(AnnotatedCollectionI alignment,
 101           Map<SequenceI, SequenceCollectionI> hiddenReps);
 102
 103   /**
 104    * create a new instance of the colourscheme configured to colour the given connection
 105    * @param sg
 106    * @param hiddenRepSequences
 107    * @return copy of current scheme with any inherited settings transfered
 108    */
 109   public ColourSchemeI applyTo(AnnotatedCollectionI sg,
 110           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
 111
 112 }