src/jalview/datamodel/SequenceDummy.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.datamodel;
  22
  23 public class SequenceDummy extends Sequence
  24 {
  25   public SequenceDummy(String sequenceId)
  26   {
  27     super(sequenceId, "THISAPLACEHOLDER");
  28   }
  29
  30   private boolean dummy = true;
  31
  32   /**
  33    * become a proxy for mseq, merging any existing annotation on this sequence
  34    *
  35    * @param mseq
  36    */
  37   public void become(SequenceI mseq)
  38   {
  39     initSeqFrom(mseq, null);
  40     dummy = false;
  41   }
  42
  43   /**
  44    * Test if the SequenceDummy has been promoted to a real sequence via
  45    * SequenceDummy.become
  46    *
  47    * @return true if this is a placeholder and contains no actual sequence data
  48    */
  49   public boolean isDummy()
  50   {
  51     return dummy;
  52   }
  53
  54   /**
  55    * Always suppress /start-end for display name as we don't know it
  56    */
  57   @Override
  58   public String getDisplayId(boolean jvsuffix)
  59   {
  60     // required for correct behaviour of SequenceIdMatcher
  61     return super.getDisplayId(false);
  62   }
  63 }