src/jalview/structure/AtomSpecModel.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.structure;
  22
  23 import java.util.ArrayList;
  24 import java.util.BitSet;
  25 import java.util.List;
  26 import java.util.Map;
  27 import java.util.TreeMap;
  28
  29 /**
  30  * A class to model a set of models, chains and atom range positions
  31  *
  32  */
  33 public class AtomSpecModel
  34 {
  35   /*
  36    * { modelNo, {chainCode, List<from-to> ranges} }
  37    */
  38   private Map<Integer, Map<String, BitSet>> atomSpec;
  39
  40   /**
  41    * Constructor
  42    */
  43   public AtomSpecModel()
  44   {
  45     atomSpec = new TreeMap<>();
  46   }
  47
  48   /**
  49    * Adds one contiguous range to this atom spec
  50    *
  51    * @param model
  52    * @param startPos
  53    * @param endPos
  54    * @param chain
  55    */
  56   public void addRange(int model, int startPos, int endPos, String chain)
  57   {
  58     /*
  59      * Get/initialize map of data for the colour and model
  60      */
  61     Map<String, BitSet> modelData = atomSpec.get(model);
  62     if (modelData == null)
  63     {
  64       atomSpec.put(model, modelData = new TreeMap<>());
  65     }
  66
  67     /*
  68      * Get/initialize map of data for colour, model and chain
  69      */
  70     BitSet chainData = modelData.get(chain);
  71     if (chainData == null)
  72     {
  73       chainData = new BitSet();
  74       modelData.put(chain, chainData);
  75     }
  76
  77     /*
  78      * Add the start/end positions
  79      */
  80     chainData.set(startPos, endPos + 1);
  81   }
  82
  83   public Iterable<Integer> getModels()
  84   {
  85     return atomSpec.keySet();
  86   }
  87
  88   public Iterable<String> getChains(Integer model)
  89   {
  90     return atomSpec.containsKey(model) ? atomSpec.get(model).keySet()
  91             : null;
  92   }
  93
  94   /**
  95    * Returns a (possibly empty) ordered list of contiguous atom ranges for the
  96    * given model and chain.
  97    *
  98    * @param model
  99    * @param chain
 100    * @return
 101    */
 102   public List<int[]> getRanges(Integer model, String chain)
 103   {
 104     List<int[]> ranges = new ArrayList<>();
 105     if (atomSpec.containsKey(model))
 106     {
 107       BitSet bs = atomSpec.get(model).get(chain);
 108       int start = 0;
 109       if (bs != null)
 110       {
 111         start = bs.nextSetBit(start);
 112         int end = 0;
 113         while (start != -1)
 114         {
 115           end = bs.nextClearBit(start);
 116           ranges.add(new int[] { start, end - 1 });
 117           start = bs.nextSetBit(end);
 118         }
 119       }
 120     }
 121     return ranges;
 122   }
 123 }