src/jalview/io/PileUpfile.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
   3  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   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  */
  18 package jalview.io;
  19
  20 /**
  21  * <p>
  22  * Title:
  23  * </p>
  24  * PileUpfile
  25  * <p>
  26  * Description:
  27  * </p>
  28  *
  29  * Read and write PileUp style MSF Files. This used to be the MSFFile class, and
  30  * was written according to the EBI's idea of a subset of the MSF alignment
  31  * format. But, that was updated to reflect current GCG style IO fashion, as
  32  * found in Emboss (thanks David Martin!)
  33  *
  34  */
  35 import java.io.*;
  36
  37 import jalview.datamodel.*;
  38 import jalview.util.*;
  39
  40 public class PileUpfile extends MSFfile
  41 {
  42
  43   /**
  44    * Creates a new MSFfile object.
  45    */
  46   public PileUpfile()
  47   {
  48   }
  49
  50   /**
  51    * Creates a new MSFfile object.
  52    *
  53    * @param inFile
  54    *          DOCUMENT ME!
  55    * @param type
  56    *          DOCUMENT ME!
  57    *
  58    * @throws IOException
  59    *           DOCUMENT ME!
  60    */
  61   public PileUpfile(String inFile, String type) throws IOException
  62   {
  63     super(inFile, type);
  64   }
  65
  66   public PileUpfile(FileParse source) throws IOException
  67   {
  68     super(source);
  69   }
  70
  71   /**
  72    * DOCUMENT ME!
  73    *
  74    * @return DOCUMENT ME!
  75    */
  76   public String print()
  77   {
  78     return print(getSeqsAsArray());
  79   }
  80
  81   public String print(SequenceI[] s)
  82   {
  83     StringBuffer out = new StringBuffer("PileUp");
  84     out.append(newline);
  85     out.append(newline);
  86
  87     int max = 0;
  88     int maxid = 0;
  89
  90     int i = 0;
  91     int bigChecksum = 0;
  92     int[] checksums = new int[s.length];
  93     while (i < s.length)
  94     {
  95       checksums[i] = checkSum(s[i].getSequenceAsString());
  96       bigChecksum += checksums[i];
  97       i++;
  98     }
  99
 100     out.append("   MSF: " + s[0].getSequence().length
 101             + "   Type: P    Check:  " + bigChecksum % 10000
 102             + "   ..");
 103     out.append(newline);
 104     out.append(newline);
 105     out.append(newline);
 106
 107     i = 0;
 108     while ((i < s.length) && (s[i] != null))
 109     {
 110       String seq = s[i].getSequenceAsString();
 111       out.append(" Name: " + printId(s[i]) + " oo  Len:  " + seq.length()
 112               + "  Check:  " + checksums[i] + "  Weight:  1.00");
 113       out.append(newline);
 114
 115       if (seq.length() > max)
 116       {
 117         max = seq.length();
 118       }
 119
 120       if (s[i].getName().length() > maxid)
 121       {
 122         maxid = s[i].getName().length();
 123       }
 124
 125       i++;
 126     }
 127
 128     if (maxid < 10)
 129     {
 130       maxid = 10;
 131     }
 132
 133     maxid++;
 134     out.append(newline);out.append(newline);out.append("//");
 135     out.append(newline);out.append(newline);
 136
 137     int len = 50;
 138
 139     int nochunks = (max / len) + 1;
 140
 141     if ((max % len) == 0)
 142     {
 143       nochunks--;
 144     }
 145
 146     for (i = 0; i < nochunks; i++)
 147     {
 148       int j = 0;
 149
 150       while ((j < s.length) && (s[j] != null))
 151       {
 152         String name = printId(s[j]);
 153
 154         out.append(new Format("%-" + maxid + "s").form(name + " "));
 155
 156         for (int k = 0; k < 5; k++)
 157         {
 158           int start = (i * 50) + (k * 10);
 159           int end = start + 10;
 160
 161           if ((end < s[j].getSequence().length)
 162                   && (start < s[j].getSequence().length))
 163           {
 164             out.append(s[j].getSequence(start, end));
 165
 166             if (k < 4)
 167             {
 168               out.append(" ");
 169             }
 170             else
 171             {
 172               out.append(newline);
 173             }
 174           }
 175           else
 176           {
 177             if (start < s[j].getSequence().length)
 178             {
 179               out.append(s[j].getSequenceAsString().substring(start));
 180               out.append(newline);
 181             }
 182             else
 183             {
 184               if (k == 0)
 185               {
 186                 out.append(newline);
 187               }
 188             }
 189           }
 190         }
 191
 192         j++;
 193       }
 194
 195       out.append(newline);
 196     }
 197
 198     return out.toString();
 199   }
 200 }