src/jalview/schemes/ColourSchemeI.java

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