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 import org.apache.logging.log4j.util.Strings;
  24
  25 public class SequenceDummy extends Sequence
  26 {
  27   public SequenceDummy(String sequenceId)
  28   {
  29     super(sequenceId, "THISAPLACEHOLDER");
  30   }
  31
  32   private boolean dummy = true;
  33
  34   /**
  35    * become a proxy for mseq, merging any existing annotation on this sequence
  36    *
  37    * @param mseq
  38    */
  39   public void become(SequenceI mseq)
  40   {
  41     initSeqFrom(mseq, null);
  42     dummy = false;
  43   }
  44
  45   /**
  46    * Test if the SequenceDummy has been promoted to a real sequence via
  47    * SequenceDummy.become
  48    *
  49    * @return true if this is a placeholder and contains no actual sequence data
  50    */
  51   public boolean isDummy()
  52   {
  53     return dummy;
  54   }
  55
  56   /**
  57    * Always suppress /start-end for display name as we don't know it
  58    */
  59   @Override
  60   public String getDisplayId(boolean jvsuffix)
  61   {
  62     // required for correct behaviour of SequenceIdMatcher
  63     return super.getDisplayId(false);
  64   }
  65
  66   @Override
  67   public int getStart()
  68   {
  69     return super.getStart();
  70   }
  71
  72   @Override
  73   public int getEnd()
  74   {
  75     if (datasetSequence == null && dummy && getFeatures() != null
  76             && getFeatures().hasFeatures())
  77     {
  78       return getFeatures().getFeatureExtent().get(1);
  79     }
  80     return super.getEnd();
  81   }
  82
  83   @Override
  84   public char[] getSequence()
  85   {
  86     checkSeqData();
  87     return super.getSequence();
  88   }
  89
  90   @Override
  91   public String getSequenceAsString(int start, int end)
  92   {
  93     checkSeqData();
  94     return super.getSequenceAsString(start, end);
  95   }
  96
  97   private void checkSeqData()
  98   {
  99     // materialise a dummy sequence of the correct length
 100     if (datasetSequence == null && dummy && getFeatures() != null
 101             && getFeatures().hasFeatures())
 102     {
 103       int endS = getEnd();
 104       char[] sq = super.getSequence();
 105       if (endS > sq.length)
 106       {
 107         setSequence(
 108                 String.valueOf(sq) + Strings.repeat("X", endS - sq.length));
 109       }
 110     }
 111   }
 112
 113   @Override
 114   public String getSequenceAsString()
 115   {
 116     checkSeqData();
 117     return super.getSequenceAsString();
 118   }
 119
 120   @Override
 121   public SequenceI createDatasetSequence()
 122   {
 123     if (dummy && datasetSequence == null)
 124     {
 125       checkSeqData();
 126       datasetSequence = new SequenceDummy(this.getName());
 127       super.updateDatasetFrom((Sequence) datasetSequence, this);
 128       super.setEnd(datasetSequence.getEnd());
 129     }
 130     return super.createDatasetSequence();
 131   }
 132 }