src/jalview/api/AlignViewportI.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.api;
  22
  23 import jalview.analysis.Conservation;
  24 import jalview.datamodel.AlignmentAnnotation;
  25 import jalview.datamodel.AlignmentI;
  26 import jalview.datamodel.AlignmentView;
  27 import jalview.datamodel.CigarArray;
  28 import jalview.datamodel.ColumnSelection;
  29 import jalview.datamodel.SequenceCollectionI;
  30 import jalview.datamodel.SequenceGroup;
  31 import jalview.datamodel.SequenceI;
  32 import jalview.schemes.ColourSchemeI;
  33
  34 import java.awt.Color;
  35 import java.util.Hashtable;
  36 import java.util.List;
  37 import java.util.Map;
  38
  39 /**
  40  * @author jimp
  41  *
  42  */
  43 public interface AlignViewportI extends ViewStyleI
  44 {
  45
  46   int getCharWidth();
  47
  48   int getEndRes();
  49
  50   int getCharHeight();
  51
  52   /**
  53    * calculate the height for visible annotation, revalidating bounds where
  54    * necessary ABSTRACT GUI METHOD
  55    *
  56    * @return total height of annotation
  57    */
  58   public int calcPanelHeight();
  59
  60   boolean hasHiddenColumns();
  61
  62   boolean isValidCharWidth();
  63
  64   boolean isShowConsensusHistogram();
  65
  66   boolean isShowSequenceLogo();
  67
  68   boolean isNormaliseSequenceLogo();
  69
  70   ColourSchemeI getGlobalColourScheme();
  71
  72   AlignmentI getAlignment();
  73
  74   ColumnSelection getColumnSelection();
  75
  76   Hashtable[] getSequenceConsensusHash();
  77
  78   Hashtable[] getRnaStructureConsensusHash();
  79
  80   boolean isIgnoreGapsConsensus();
  81
  82   boolean isCalculationInProgress(AlignmentAnnotation alignmentAnnotation);
  83
  84   AlignmentAnnotation getAlignmentQualityAnnot();
  85
  86   AlignmentAnnotation getAlignmentConservationAnnotation();
  87
  88   /**
  89    * get the container for alignment consensus annotation
  90    *
  91    * @return
  92    */
  93   AlignmentAnnotation getAlignmentConsensusAnnotation();
  94
  95   /**
  96    * Test to see if viewport is still open and active
  97    *
  98    * @return true indicates that all references to viewport should be dropped
  99    */
 100   boolean isClosed();
 101
 102   /**
 103    * get the associated calculation thread manager for the view
 104    *
 105    * @return
 106    */
 107   AlignCalcManagerI getCalcManager();
 108
 109   /**
 110    * get the percentage gaps allowed in a conservation calculation
 111    *
 112    */
 113   public int getConsPercGaps();
 114
 115   /**
 116    * set the consensus result object for the viewport
 117    *
 118    * @param hconsensus
 119    */
 120   void setSequenceConsensusHash(Hashtable[] hconsensus);
 121
 122   /**
 123    *
 124    * @return the alignment annotatino row for the structure consensus
 125    *         calculation
 126    */
 127   AlignmentAnnotation getAlignmentStrucConsensusAnnotation();
 128
 129   /**
 130    * set the Rna structure consensus result object for the viewport
 131    *
 132    * @param hStrucConsensus
 133    */
 134   void setRnaStructureConsensusHash(Hashtable[] hStrucConsensus);
 135
 136   /**
 137    * set global colourscheme
 138    *
 139    * @param rhc
 140    */
 141   void setGlobalColourScheme(ColourSchemeI rhc);
 142
 143   Map<SequenceI, SequenceCollectionI> getHiddenRepSequences();
 144
 145   void setHiddenRepSequences(
 146           Map<SequenceI, SequenceCollectionI> hiddenRepSequences);
 147
 148   /**
 149    * hides or shows dynamic annotation rows based on groups and group and
 150    * alignment associated auto-annotation state flags apply the current
 151    * group/autoannotation settings to the alignment view. Usually you should
 152    * call the AlignmentViewPanel.adjustAnnotationHeight() method afterwards to
 153    * ensure the annotation panel bounds are set correctly.
 154    *
 155    * @param applyGlobalSettings
 156    *          - apply to all autoannotation rows or just the ones associated
 157    *          with the current visible region
 158    * @param preserveNewGroupSettings
 159    *          - don't apply global settings to groups which don't already have
 160    *          group associated annotation
 161    */
 162   void updateGroupAnnotationSettings(boolean applyGlobalSettings,
 163           boolean preserveNewGroupSettings);
 164
 165   /**
 166    * @return true if a reference sequence is set and should be displayed
 167    */
 168   public boolean isDisplayReferenceSeq();
 169
 170   /**
 171    * @return set the flag for displaying reference sequences when they are
 172    *         available
 173    */
 174   public void setDisplayReferenceSeq(boolean displayReferenceSeq);
 175
 176   /**
 177    * @return true if colourschemes should render according to reference sequence
 178    *         rather than consensus if available
 179    */
 180   public boolean isColourByReferenceSeq();
 181
 182   /**
 183    * @return true set flag for deciding if colourschemes should render according
 184    *         to reference sequence rather than consensus if available
 185    */
 186   public void setColourByReferenceSeq(boolean colourByReferenceSeq);
 187
 188   void setSequenceColour(SequenceI seq, Color col);
 189
 190   Color getSequenceColour(SequenceI seq);
 191
 192   void updateSequenceIdColours();
 193
 194   SequenceGroup getSelectionGroup();
 195
 196   /**
 197    * get the currently selected sequence objects or all the sequences in the
 198    * alignment. TODO: change to List<>
 199    *
 200    * @return array of references to sequence objects
 201    */
 202   SequenceI[] getSequenceSelection();
 203
 204   void clearSequenceColours();
 205
 206   /**
 207    * This method returns the visible alignment as text, as seen on the GUI, ie
 208    * if columns are hidden they will not be returned in the result. Use this for
 209    * calculating trees, PCA, redundancy etc on views which contain hidden
 210    * columns.
 211    *
 212    * @return String[]
 213    */
 214   CigarArray getViewAsCigars(boolean selectedRegionOnly);
 215
 216   /**
 217    * return a compact representation of the current alignment selection to pass
 218    * to an analysis function
 219    *
 220    * @param selectedOnly
 221    *          boolean true to just return the selected view
 222    * @return AlignmentView
 223    */
 224   AlignmentView getAlignmentView(boolean selectedOnly);
 225
 226   /**
 227    * return a compact representation of the current alignment selection to pass
 228    * to an analysis function
 229    *
 230    * @param selectedOnly
 231    *          boolean true to just return the selected view
 232    * @param markGroups
 233    *          boolean true to annotate the alignment view with groups on the
 234    *          alignment (and intersecting with selected region if selectedOnly
 235    *          is true)
 236    * @return AlignmentView
 237    */
 238   AlignmentView getAlignmentView(boolean selectedOnly, boolean markGroups);
 239
 240   /**
 241    * This method returns the visible alignment as text, as seen on the GUI, ie
 242    * if columns are hidden they will not be returned in the result. Use this for
 243    * calculating trees, PCA, redundancy etc on views which contain hidden
 244    * columns.
 245    *
 246    * @return String[]
 247    */
 248   String[] getViewAsString(boolean selectedRegionOnly);
 249
 250   void setSelectionGroup(SequenceGroup sg);
 251
 252   char getGapCharacter();
 253
 254   void setColumnSelection(ColumnSelection cs);
 255
 256   void setConservation(Conservation cons);
 257
 258   /**
 259    * get a copy of the currently visible alignment annotation
 260    * @param selectedOnly if true - trim to selected regions on the alignment
 261    * @return an empty list or new alignment annotation objects shown only visible columns trimmed to selected region only
 262    */
 263   List<AlignmentAnnotation> getVisibleAlignmentAnnotation(
 264           boolean selectedOnly);
 265
 266   FeaturesDisplayedI getFeaturesDisplayed();
 267
 268   String getSequenceSetId();
 269
 270   boolean isShowSequenceFeatures();
 271
 272   void setShowSequenceFeatures(boolean b);
 273
 274   /**
 275    *
 276    * @param flag
 277    *          indicating if annotation panel shown below alignment
 278    *
 279    */
 280   void setShowAnnotation(boolean b);
 281
 282   /**
 283    * flag indicating if annotation panel shown below alignment
 284    *
 285    * @return
 286    */
 287   boolean isShowAnnotation();
 288
 289   boolean isRightAlignIds();
 290
 291   void setRightAlignIds(boolean rightAlignIds);
 292
 293   boolean areFeaturesDisplayed();
 294
 295   void setShowSequenceFeaturesHeight(boolean selected);
 296
 297   boolean isShowSequenceFeaturesHeight();
 298
 299   void setFeaturesDisplayed(FeaturesDisplayedI featuresDisplayedI);
 300
 301   void alignmentChanged(AlignmentViewPanel ap);
 302
 303   /**
 304    * @return the padGaps
 305    */
 306   boolean isPadGaps();
 307
 308   /**
 309    * @param padGaps
 310    *          the padGaps to set
 311    */
 312   void setPadGaps(boolean padGaps);
 313
 314   /**
 315    * return visible region boundaries within given column range
 316    *
 317    * @param min
 318    *          first column (inclusive, from 0)
 319    * @param max
 320    *          last column (exclusive)
 321    * @return int[][] range of {start,end} visible positions
 322    */
 323   List<int[]> getVisibleRegionBoundaries(int min, int max);
 324
 325   /**
 326    * This method returns an array of new SequenceI objects derived from the
 327    * whole alignment or just the current selection with start and end points
 328    * adjusted
 329    *
 330    * @note if you need references to the actual SequenceI objects in the
 331    *       alignment or currently selected then use getSequenceSelection()
 332    * @return selection as new sequenceI objects
 333    */
 334   SequenceI[] getSelectionAsNewSequence();
 335
 336   void invertColumnSelection();
 337
 338   /**
 339    * broadcast selection to any interested parties
 340    */
 341   void sendSelection();
 342
 343   /**
 344    * calculate the row position for alignmentIndex if all hidden sequences were
 345    * shown
 346    *
 347    * @param alignmentIndex
 348    * @return adjusted row position
 349    */
 350   int adjustForHiddenSeqs(int alignmentIndex);
 351
 352   boolean hasHiddenRows();
 353
 354   /**
 355    *
 356    * @return a copy of this view's current display settings
 357    */
 358   public ViewStyleI getViewStyle();
 359
 360   /**
 361    * update the view's display settings with the given style set
 362    *
 363    * @param settingsForView
 364    */
 365   public void setViewStyle(ViewStyleI settingsForView);
 366
 367   /**
 368    * Returns a viewport which holds the cDna for this (protein), or vice versa,
 369    * or null if none is set.
 370    *
 371    * @return
 372    */
 373   AlignViewportI getCodingComplement();
 374
 375   /**
 376    * Sets the viewport which holds the cDna for this (protein), or vice versa.
 377    * Implementation should guarantee that the reciprocal relationship is always
 378    * set, i.e. each viewport is the complement of the other.
 379    */
 380   void setCodingComplement(AlignViewportI sl);
 381
 382   /**
 383    * Answers true if viewport hosts DNA/RNA, else false.
 384    *
 385    * @return
 386    */
 387   boolean isNucleotide();
 388
 389   /**
 390    * Returns an id guaranteed to be unique for this viewport.
 391    *
 392    * @return
 393    */
 394   String getViewId();
 395 }