src/jalview/io/PIRFile.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;
  20
  21 import java.io.*;
  22 import java.util.*;
  23
  24 import jalview.datamodel.*;
  25
  26 public class PIRFile extends AlignFile
  27 {
  28   public static boolean useModellerOutput = false;
  29
  30   Vector words = new Vector(); // Stores the words in a line after splitting
  31
  32   public PIRFile()
  33   {
  34   }
  35
  36   public PIRFile(String inFile, String type) throws IOException
  37   {
  38     super(inFile, type);
  39   }
  40
  41   public PIRFile(FileParse source) throws IOException
  42   {
  43     super(source);
  44   }
  45
  46   public void parse() throws IOException
  47   {
  48     StringBuffer sequence;
  49     String line = null;
  50     ModellerDescription md;
  51
  52     while ((line = nextLine()) != null)
  53     {
  54       if (line.length() == 0)
  55       {
  56         // System.out.println("blank line");
  57         continue;
  58       }
  59       if (line.indexOf("C;") == 0 || line.indexOf("#") == 0)
  60       {
  61         continue;
  62       }
  63       Sequence newSeq = parseId(line.substring(line.indexOf(";") + 1));
  64
  65       sequence = new StringBuffer();
  66
  67       newSeq.setDescription(nextLine()); // this is the title line
  68
  69       boolean starFound = false;
  70
  71       while (!starFound)
  72       {
  73         line = nextLine();
  74         sequence.append(line);
  75
  76         if (line == null)
  77         {
  78           break;
  79         }
  80
  81         if (line.indexOf("*") > -1)
  82         {
  83           starFound = true;
  84         }
  85       }
  86
  87       if (sequence.length() > 0)
  88       {
  89         sequence.setLength(sequence.length() - 1);
  90         newSeq.setSequence(sequence.toString());
  91
  92         seqs.addElement(newSeq);
  93
  94         md = new ModellerDescription(newSeq.getDescription());
  95         md.updateSequenceI(newSeq);
  96       }
  97     }
  98   }
  99
 100   public String print()
 101   {
 102     return print(getSeqsAsArray());
 103   }
 104
 105   public String print(SequenceI[] s)
 106   {
 107     boolean is_NA = jalview.util.Comparison.isNucleotide(s);
 108     int len = 72;
 109     StringBuffer out = new StringBuffer();
 110     int i = 0;
 111     ModellerDescription md;
 112
 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
 149         if (useModellerOutput)
 150         {
 151           out.append(">P1;" + s[i].getName());
 152           out.append(newline);
 153           md = new ModellerDescription(s[i]);
 154           out.append(md.getDescriptionLine());
 155           out.append(newline);
 156         }
 157         else
 158         {
 159           out.append(">P1;" + printId(s[i]));
 160           out.append(newline);
 161           if (s[i].getDescription() != null)
 162           {
 163             out.append(s[i].getDescription());
 164             out.append(newline);
 165           }
 166           else
 167           {
 168             out.append(s[i].getName() + " "
 169                     + (s[i].getEnd() - s[i].getStart() + 1) + " residues");
 170             out.append(newline);
 171           }
 172         }
 173       }
 174       int nochunks = (seq.length() / len) + 1;
 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 }