src/jalview/io/vamsas/Rangetype.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.0b1)
   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 of the License, or (at your option) any later version.
  10  *
  11  * Jalview is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty
  13  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14  * PURPOSE.  See the GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  17  * The Jalview Authors are detailed in the 'AUTHORS' file.
  18  */
  19 package jalview.io.vamsas;
  20
  21 import java.util.Vector;
  22
  23 import uk.ac.vamsas.client.Vobject;
  24 import uk.ac.vamsas.objects.core.Local;
  25 import uk.ac.vamsas.objects.core.MapType;
  26 import uk.ac.vamsas.objects.core.Mapped;
  27 import uk.ac.vamsas.objects.core.RangeType;
  28 import uk.ac.vamsas.objects.core.Seg;
  29 import jalview.io.VamsasAppDatastore;
  30
  31 /**
  32  * Enhances DatastoreItem objects with additional functions to do with RangeType
  33  * objects
  34  *
  35  * @author JimP
  36  *
  37  */
  38 public abstract class Rangetype extends DatastoreItem
  39 {
  40
  41   public Rangetype()
  42   {
  43     super();
  44   }
  45
  46   public Rangetype(VamsasAppDatastore datastore)
  47   {
  48     super(datastore);
  49   }
  50
  51   public Rangetype(VamsasAppDatastore datastore, Vobject vobj, Class jvClass)
  52   {
  53     super(datastore, vobj, jvClass);
  54   }
  55
  56   public Rangetype(VamsasAppDatastore datastore, Object jvobj, Class vClass)
  57   {
  58     super(datastore, jvobj, vClass);
  59   }
  60
  61   /**
  62    * get real bounds of a RangeType's specification. start and end are an
  63    * inclusive range within which all segments and positions lie. TODO: refactor
  64    * to vamsas utils
  65    *
  66    * @param dseta
  67    * @return int[] { start, end}
  68    */
  69   protected int[] getBounds(RangeType dseta)
  70   {
  71     if (dseta != null)
  72     {
  73       int[] se = null;
  74       if (dseta.getSegCount() > 0 && dseta.getPosCount() > 0)
  75       {
  76         throw new Error(
  77                 "Invalid vamsas RangeType - cannot resolve both lists of Pos and Seg from choice!");
  78       }
  79       if (dseta.getSegCount() > 0)
  80       {
  81         se = getSegRange(dseta.getSeg(0), true);
  82         for (int s = 1, sSize = dseta.getSegCount(); s < sSize; s++)
  83         {
  84           int nse[] = getSegRange(dseta.getSeg(s), true);
  85           if (se[0] > nse[0])
  86           {
  87             se[0] = nse[0];
  88           }
  89           if (se[1] < nse[1])
  90           {
  91             se[1] = nse[1];
  92           }
  93         }
  94       }
  95       if (dseta.getPosCount() > 0)
  96       {
  97         // could do a polarity for pos range too. and pass back indication of
  98         // discontinuities.
  99         int pos = dseta.getPos(0).getI();
 100         se = new int[]
 101         { pos, pos };
 102         for (int p = 0, pSize = dseta.getPosCount(); p < pSize; p++)
 103         {
 104           pos = dseta.getPos(p).getI();
 105           if (se[0] > pos)
 106           {
 107             se[0] = pos;
 108           }
 109           if (se[1] < pos)
 110           {
 111             se[1] = pos;
 112           }
 113         }
 114       }
 115       return se;
 116     }
 117     return null;
 118   }
 119
 120   /**
 121    * map from a rangeType's internal frame to the referenced object's coordinate
 122    * frame.
 123    *
 124    * @param dseta
 125    * @return int [] { ref(pos)...} for all pos in rangeType's frame.
 126    */
 127   protected int[] getMapping(RangeType dseta)
 128   {
 129     Vector posList = new Vector();
 130     if (dseta != null)
 131     {
 132       int[] se = null;
 133       if (dseta.getSegCount() > 0 && dseta.getPosCount() > 0)
 134       {
 135         throw new Error(
 136                 "Invalid vamsas RangeType - cannot resolve both lists of Pos and Seg from choice!");
 137       }
 138       if (dseta.getSegCount() > 0)
 139       {
 140         for (int s = 0, sSize = dseta.getSegCount(); s < sSize; s++)
 141         {
 142           se = getSegRange(dseta.getSeg(s), false);
 143           int se_end = se[1 - se[2]] + (se[2] == 0 ? 1 : -1);
 144           for (int p = se[se[2]]; p != se_end; p += se[2] == 0 ? 1 : -1)
 145           {
 146             posList.add(new Integer(p));
 147           }
 148         }
 149       }
 150       else if (dseta.getPosCount() > 0)
 151       {
 152         int pos = dseta.getPos(0).getI();
 153
 154         for (int p = 0, pSize = dseta.getPosCount(); p < pSize; p++)
 155         {
 156           pos = dseta.getPos(p).getI();
 157           posList.add(new Integer(pos));
 158         }
 159       }
 160     }
 161     if (posList != null && posList.size() > 0)
 162     {
 163       int[] range = new int[posList.size()];
 164       for (int i = 0; i < range.length; i++)
 165       {
 166         range[i] = ((Integer) posList.elementAt(i)).intValue();
 167       }
 168       posList.clear();
 169       return range;
 170     }
 171     return null;
 172   }
 173
 174   protected int[] getIntervals(RangeType range)
 175   {
 176     int[] intervals = null;
 177     Vector posList = new Vector();
 178     if (range != null)
 179     {
 180       int[] se = null;
 181       if (range.getSegCount() > 0 && range.getPosCount() > 0)
 182       {
 183         throw new Error(
 184                 "Invalid vamsas RangeType - cannot resolve both lists of Pos and Seg from choice!");
 185       }
 186       if (range.getSegCount() > 0)
 187       {
 188         for (int s = 0, sSize = range.getSegCount(); s < sSize; s++)
 189         {
 190           se = getSegRange(range.getSeg(s), false);
 191           posList.addElement(new Integer(se[0]));
 192           posList.addElement(new Integer(se[1]));
 193         }
 194       }
 195       else if (range.getPosCount() > 0)
 196       {
 197         int pos = range.getPos(0).getI();
 198
 199         for (int p = 0, pSize = range.getPosCount(); p < pSize; p++)
 200         {
 201           pos = range.getPos(p).getI();
 202           posList.add(new Integer(pos));
 203           posList.add(new Integer(pos));
 204         }
 205       }
 206     }
 207     if (posList != null && posList.size() > 0)
 208     {
 209       intervals = new int[posList.size()];
 210       java.util.Enumeration e = posList.elements();
 211       int i = 0;
 212       while (e.hasMoreElements())
 213       {
 214         intervals[i++] = ((Integer) e.nextElement()).intValue();
 215       }
 216     }
 217     return intervals;
 218   }
 219
 220   /**
 221    * initialise a range type object from a set of start/end inclusive intervals
 222    *
 223    * @param mrt
 224    * @param range
 225    */
 226   protected void initRangeType(RangeType mrt, int[] range)
 227   {
 228     for (int i = 0; i < range.length; i += 2)
 229     {
 230       Seg vSeg = new Seg();
 231       vSeg.setStart(range[i]);
 232       vSeg.setEnd(range[i + 1]);
 233       vSeg.setInclusive(true);
 234       mrt.addSeg(vSeg);
 235     }
 236   }
 237
 238   /**
 239    *
 240    * @param maprange
 241    *          where the from range is the local mapped range, and the to range
 242    *          is the 'mapped' range in the MapRangeType
 243    * @param default unit for local
 244    * @param default unit for mapped
 245    * @return MapList
 246    */
 247   protected jalview.util.MapList parsemapType(MapType maprange, int localu,
 248           int mappedu)
 249   {
 250     jalview.util.MapList ml = null;
 251     int[] localRange = getIntervals(maprange.getLocal());
 252     int[] mappedRange = getIntervals(maprange.getMapped());
 253     long lu = maprange.getLocal().hasUnit() ? maprange.getLocal().getUnit()
 254             : localu;
 255     long mu = maprange.getMapped().hasUnit() ? maprange.getMapped()
 256             .getUnit() : mappedu;
 257     ml = new jalview.util.MapList(localRange, mappedRange, (int) lu,
 258             (int) mu);
 259     return ml;
 260   }
 261
 262   protected jalview.util.MapList parsemapType(MapType map)
 263   {
 264     if (!map.getLocal().hasUnit() || map.getMapped().hasUnit())
 265     {
 266       jalview.bin.Cache.log
 267               .warn("using default mapping length of 1:1 for map "
 268                       + (map.isRegistered() ? map.getVorbaId().toString()
 269                               : ("<no Id registered> " + map.toString())));
 270     }
 271     return parsemapType(map, 1, 1);
 272   }
 273
 274   /**
 275    * initialise a MapType object from a MapList object.
 276    *
 277    * @param maprange
 278    * @param ml
 279    * @param setUnits
 280    */
 281   protected void initMapType(MapType maprange, jalview.util.MapList ml,
 282           boolean setUnits)
 283   {
 284     initMapType(maprange, ml, setUnits, false);
 285   }
 286
 287   /**
 288    *
 289    * @param maprange
 290    * @param ml
 291    * @param setUnits
 292    * @param reverse
 293    *          - reverse MapList mapping for Local and Mapped ranges and units
 294    */
 295   protected void initMapType(MapType maprange, jalview.util.MapList ml,
 296           boolean setUnits, boolean reverse)
 297   {
 298     if (ml == null)
 299     {
 300       throw new Error(
 301               "Implementation error. MapList is null for initMapType.");
 302     }
 303     maprange.setLocal(new Local());
 304     maprange.setMapped(new Mapped());
 305     if (!reverse)
 306     {
 307       initRangeType(maprange.getLocal(), ml.getFromRanges());
 308       initRangeType(maprange.getMapped(), ml.getToRanges());
 309     }
 310     else
 311     {
 312       initRangeType(maprange.getLocal(), ml.getToRanges());
 313       initRangeType(maprange.getMapped(), ml.getFromRanges());
 314     }
 315     if (setUnits)
 316     {
 317       if (!reverse)
 318       {
 319         maprange.getLocal().setUnit(ml.getFromRatio());
 320         maprange.getMapped().setUnit(ml.getToRatio());
 321       }
 322       else
 323       {
 324         maprange.getLocal().setUnit(ml.getToRatio());
 325         maprange.getMapped().setUnit(ml.getFromRatio());
 326       }
 327       // TODO: and verify - raise an implementation fault notice if local/mapped
 328       // range % Local/Mapped Ratio != 0
 329       // if (uk.ac.vamsas.objects.utils.Range.getIntervals(range))
 330
 331     }
 332   }
 333
 334 }