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