src/jalview/io/PIRFile.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;
  22
  23 import jalview.bin.Cache;
  24 import jalview.datamodel.Sequence;
  25 import jalview.datamodel.SequenceI;
  26 import jalview.util.Comparison;
  27
  28 import java.io.IOException;
  29
  30 public class PIRFile extends AlignFile
  31 {
  32   // Vector words = new Vector(); // Stores the words in a line after splitting
  33
  34   public PIRFile()
  35   {
  36   }
  37
  38   public PIRFile(String inFile, DataSourceType sourceType)
  39           throws IOException
  40   {
  41     super(inFile, sourceType);
  42   }
  43
  44   public PIRFile(FileParse source) throws IOException
  45   {
  46     super(source);
  47   }
  48
  49   @Override
  50   public void parse() throws IOException
  51   {
  52     StringBuffer sequence;
  53     String line = null;
  54     ModellerDescription md;
  55
  56     while ((line = nextLine()) != null)
  57     {
  58       if (line.length() == 0)
  59       {
  60         // System.out.println("blank line");
  61         continue;
  62       }
  63       if (line.indexOf("C;") == 0 || line.indexOf("#") == 0)
  64       {
  65         continue;
  66       }
  67       Sequence newSeq = parseId(line.substring(line.indexOf(";") + 1));
  68
  69       sequence = new StringBuffer();
  70
  71       newSeq.setDescription(nextLine()); // this is the title line
  72
  73       boolean starFound = false;
  74
  75       while (!starFound)
  76       {
  77         line = nextLine();
  78         sequence.append(line);
  79
  80         if (line == null)
  81         {
  82           break;
  83         }
  84
  85         if (line.indexOf("*") > -1)
  86         {
  87           starFound = true;
  88         }
  89       }
  90
  91       if (sequence.length() > 0)
  92       {
  93         sequence.setLength(sequence.length() - 1);
  94         newSeq.setSequence(sequence.toString());
  95
  96         seqs.addElement(newSeq);
  97
  98         md = new ModellerDescription(newSeq.getDescription());
  99         md.updateSequenceI(newSeq);
 100       }
 101     }
 102   }
 103
 104   @Override
 105   public String print(SequenceI[] s, boolean jvsuffix)
 106   {
 107     boolean is_NA = Comparison.isNucleotide(s);
 108     int len = 72;
 109     StringBuffer out = new StringBuffer();
 110     int i = 0;
 111     ModellerDescription md;
 112     boolean useModellerOutput = Cache.getDefault("PIR_MODELLER", false);
 113     while ((i < s.length) && (s[i] != null))
 114     {
 115       String seq = s[i].getSequenceAsString();
 116       seq = seq + "*";
 117
 118       if (is_NA)
 119       {
 120         // modeller doesn't really do nucleotides, so we don't do anything fancy
 121         // Official tags area as follows, for now we'll use P1 and DL
 122         // Protein (complete) P1
 123         // Protein (fragment) F1
 124         // DNA (linear) Dl
 125         // DNA (circular) DC
 126         // RNA (linear) RL
 127         // RNA (circular) RC
 128         // tRNA N3
 129         // other functional RNA N1
 130
 131         out.append(">N1;" + s[i].getName());
 132         out.append(newline);
 133         if (s[i].getDescription() == null)
 134         {
 135           out.append(s[i].getName() + " "
 136                   + (s[i].getEnd() - s[i].getStart() + 1));
 137           out.append(is_NA ? " bases" : " residues");
 138           out.append(newline);
 139         }
 140         else
 141         {
 142           out.append(s[i].getDescription());
 143           out.append(newline);
 144         }
 145       }
 146       else
 147       {
 148         if (useModellerOutput)
 149         {
 150           out.append(">P1;" + s[i].getName());
 151           out.append(newline);
 152           md = new ModellerDescription(s[i]);
 153           out.append(md.getDescriptionLine());
 154           out.append(newline);
 155         }
 156         else
 157         {
 158           out.append(">P1;" + printId(s[i], jvsuffix));
 159           out.append(newline);
 160           if (s[i].getDescription() != null)
 161           {
 162             out.append(s[i].getDescription());
 163             out.append(newline);
 164           }
 165           else
 166           {
 167             out.append(s[i].getName() + " "
 168                     + (s[i].getEnd() - s[i].getStart() + 1) + " residues");
 169             out.append(newline);
 170           }
 171         }
 172       }
 173       int nochunks = (seq.length() / len)
 174               + (seq.length() % len > 0 ? 1 : 0);
 175
 176       for (int j = 0; j < nochunks; j++)
 177       {
 178         int start = j * len;
 179         int end = start + len;
 180
 181         if (end < seq.length())
 182         {
 183           out.append(seq.substring(start, end));
 184           out.append(newline);
 185         }
 186         else if (start < seq.length())
 187         {
 188           out.append(seq.substring(start));
 189           out.append(newline);
 190         }
 191       }
 192
 193       i++;
 194     }
 195
 196     return out.toString();
 197   }
 198
 199 }