JAL-2994 put ‘\’ first in character class clause of regex - otherwise doesn’t compile...
[jalview.git] / src / jalview / io / FormatAdapter.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.api.AlignExportSettingI;
24 import jalview.api.AlignmentViewPanel;
25 import jalview.bin.Cache;
26 import jalview.datamodel.Alignment;
27 import jalview.datamodel.AlignmentAnnotation;
28 import jalview.datamodel.AlignmentI;
29 import jalview.datamodel.HiddenColumns;
30 import jalview.datamodel.Sequence;
31 import jalview.datamodel.SequenceGroup;
32 import jalview.datamodel.SequenceI;
33 import jalview.util.Comparison;
34
35 import java.io.IOException;
36
37 /**
38  * Additional formatting methods used by the application in a number of places.
39  * 
40  * @author $author$
41  * @version $Revision$
42  */
43 public class FormatAdapter extends AppletFormatAdapter
44 {
45   public FormatAdapter(AlignmentViewPanel viewpanel)
46   {
47     super(viewpanel);
48     init();
49   }
50
51   public FormatAdapter()
52   {
53     super();
54     init();
55   }
56
57   public FormatAdapter(AlignmentViewPanel alignPanel,
58           AlignExportSettingI settings)
59   {
60     super(alignPanel, settings);
61   }
62
63   private void init()
64   {
65     if (jalview.bin.Cache.getDefault("STRUCT_FROM_PDB", true))
66     {
67       annotFromStructure = jalview.bin.Cache.getDefault("ADD_TEMPFACT_ANN",
68               true);
69       localSecondaryStruct = jalview.bin.Cache.getDefault("ADD_SS_ANN",
70               true);
71       serviceSecondaryStruct = jalview.bin.Cache.getDefault("USE_RNAVIEW",
72               true);
73     }
74     else
75     {
76       // disable all PDB annotation options
77       annotFromStructure = false;
78       localSecondaryStruct = false;
79       serviceSecondaryStruct = false;
80     }
81   }
82
83   public String formatSequences(FileFormatI format, SequenceI[] seqs,
84           String[] omitHiddenColumns, int[] exportRange)
85   {
86
87     return formatSequences(format,
88             replaceStrings(seqs, omitHiddenColumns, exportRange));
89   }
90
91   /**
92    * create sequences with each sequence string replaced with the one given in
93    * omitHiddenCOlumns
94    * 
95    * @param seqs
96    * @param omitHiddenColumns
97    * @return new sequences
98    */
99   public SequenceI[] replaceStrings(SequenceI[] seqs,
100           String[] omitHiddenColumns, int[] startEnd)
101   {
102     if (omitHiddenColumns != null)
103     {
104       SequenceI[] tmp = new SequenceI[seqs.length];
105
106       int startRes;
107       int endRes;
108       int startIndex;
109       int endIndex;
110       for (int i = 0; i < seqs.length; i++)
111       {
112         startRes = seqs[i].getStart();
113         endRes = seqs[i].getEnd();
114         if (startEnd != null)
115         {
116           startIndex = startEnd[0];
117           endIndex = startEnd[1];
118           // get first non-gaped residue start position
119           while (Comparison.isGap(seqs[i].getCharAt(startIndex))
120                   && startIndex < endIndex)
121           {
122             startIndex++;
123           }
124
125           // get last non-gaped residue end position
126           while (Comparison.isGap(seqs[i].getCharAt(endIndex))
127                   && endIndex > startIndex)
128           {
129             endIndex--;
130           }
131
132           startRes = seqs[i].findPosition(startIndex);
133           endRes = seqs[i].findPosition(endIndex);
134         }
135
136         tmp[i] = new Sequence(seqs[i].getName(), omitHiddenColumns[i],
137                 startRes, endRes);
138         tmp[i].setDescription(seqs[i].getDescription());
139       }
140       seqs = tmp;
141     }
142     return seqs;
143   }
144
145   /**
146    * Format a vector of sequences as a flat alignment file. TODO: allow caller
147    * to detect errors and warnings encountered when generating output
148    * 
149    * 
150    * @param format
151    * @param seqs
152    *          vector of sequences to write
153    * 
154    * @return String containing sequences in desired format
155    */
156   public String formatSequences(FileFormatI format, SequenceI[] seqs)
157   {
158     boolean withSuffix = getCacheSuffixDefault(format);
159     return format.getWriter(null).print(seqs, withSuffix);
160   }
161
162   public boolean getCacheSuffixDefault(FileFormatI format)
163   {
164     return Cache.getDefault(format.getName().toUpperCase() + "_JVSUFFIX",
165             true);
166   }
167
168   public String formatSequences(FileFormatI format, AlignmentI alignment,
169           String[] omitHidden, int[] exportRange, HiddenColumns hidden)
170   {
171     return formatSequences(format, alignment, omitHidden, exportRange,
172             getCacheSuffixDefault(format), hidden, null);
173   }
174
175   /**
176    * hack function to replace sequences with visible sequence strings before
177    * generating a string of the alignment in the given format.
178    * 
179    * @param format
180    * @param alignment
181    * @param omitHidden
182    *          sequence strings to write out in order of sequences in alignment
183    * @param colSel
184    *          defines hidden columns that are edited out of annotation
185    * @return string representation of the alignment formatted as format
186    */
187   public String formatSequences(FileFormatI format, AlignmentI alignment,
188           String[] omitHidden, int[] exportRange, boolean suffix,
189           HiddenColumns hidden)
190   {
191     return formatSequences(format, alignment, omitHidden, exportRange,
192             suffix, hidden, null);
193   }
194
195   public String formatSequences(FileFormatI format, AlignmentI alignment,
196           String[] omitHidden, int[] exportRange, boolean suffix,
197           HiddenColumns hidden, SequenceGroup selgp)
198   {
199     if (omitHidden != null)
200     {
201       // TODO consider using AlignmentView to prune to visible region
202       // TODO prune sequence annotation and groups to visible region
203       // TODO: JAL-1486 - set start and end for output correctly. basically,
204       // AlignmentView.getVisibleContigs does this.
205       Alignment alv = new Alignment(replaceStrings(
206               alignment.getSequencesArray(), omitHidden, exportRange));
207       AlignmentAnnotation[] ala = alignment.getAlignmentAnnotation();
208       if (ala != null)
209       {
210         for (int i = 0; i < ala.length; i++)
211         {
212           AlignmentAnnotation na = new AlignmentAnnotation(ala[i]);
213           if (selgp != null)
214           {
215             na.makeVisibleAnnotation(selgp.getStartRes(), selgp.getEndRes(),
216                     hidden);
217           }
218           else
219           {
220             na.makeVisibleAnnotation(hidden);
221           }
222           alv.addAnnotation(na);
223         }
224       }
225       return this.formatSequences(format, alv, suffix);
226     }
227     return this.formatSequences(format, alignment, suffix);
228   }
229
230   @Override
231   public AlignmentI readFile(String file, DataSourceType sourceType,
232           FileFormatI fileFormat) throws IOException
233   {
234     AlignmentI al = super.readFile(file, sourceType, fileFormat);
235     return al;
236   }
237
238   @Override
239   public AlignmentI readFromFile(FileParse source, FileFormatI format)
240           throws IOException
241   {
242     AlignmentI al = super.readFromFile(source, format);
243     return al;
244   }
245
246   /**
247    * Create a flat file representation of a given view or selected region of a
248    * view
249    * 
250    * @param format
251    * @param ap
252    *          alignment panel originating the view
253    * @return String containing flat file
254    */
255   public String formatSequences(FileFormatI format, AlignmentViewPanel ap,
256           boolean selectedOnly)
257   {
258     return formatSequences(format, getCacheSuffixDefault(format), ap,
259             selectedOnly);
260   }
261
262   public AlignmentI readFromFile(AlignmentFileReaderI source,
263           FileFormatI format) throws IOException
264   {
265     FileParse fp = new FileParse(source.getInFile(),
266             source.getDataSourceType());
267     return readFromFile(fp, format);
268   }
269
270 }