JAL-3393 Don't need PDF file using Illustrator. Replaced with SVG using Inkscape
[jalview.git] / src / jalview / ws / rest / params / SeqGroupIndexVector.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.ws.rest.params;
22
23 import jalview.datamodel.AlignmentI;
24 import jalview.datamodel.SequenceGroup;
25 import jalview.datamodel.SequenceI;
26 import jalview.util.MessageManager;
27 import jalview.ws.params.OptionI;
28 import jalview.ws.params.simple.IntegerParameter;
29 import jalview.ws.params.simple.Option;
30 import jalview.ws.rest.AlignmentProcessor;
31 import jalview.ws.rest.InputType;
32 import jalview.ws.rest.NoValidInputDataException;
33 import jalview.ws.rest.RestJob;
34
35 import java.io.UnsupportedEncodingException;
36 import java.util.ArrayList;
37 import java.util.Arrays;
38 import java.util.List;
39
40 import org.apache.http.entity.mime.content.ContentBody;
41 import org.apache.http.entity.mime.content.StringBody;
42
43 /**
44  * Represents the partitions defined on the alignment as indices e.g. for a
45  * partition (A,B,C),(D,E),(F) The indices would be 3,2,1. Note, the alignment
46  * must be ordered so groups are contiguous before this input type can be used.
47  * 
48  * @author JimP
49  * 
50  */
51 public class SeqGroupIndexVector extends InputType
52         implements AlignmentProcessor
53 {
54   public SeqGroupIndexVector()
55   {
56     super(new Class[] { AlignmentI.class });
57   }
58
59   /**
60    * separator for list of sequence Indices - default is ','
61    */
62   public String sep = ",";
63
64   /**
65    * min size of each partition
66    */
67   public int minsize = 1;
68
69   molType type;
70
71   /**
72    * prepare the context alignment for this input
73    * 
74    * @param al
75    *          - alignment to be processed
76    * @return al or a new alignment with appropriate attributes/order for input
77    */
78   @Override
79   public AlignmentI prepareAlignment(AlignmentI al)
80   {
81     jalview.analysis.AlignmentSorter.sortByGroup(al);
82     return al;
83   }
84
85   @Override
86   public ContentBody formatForInput(RestJob rj)
87           throws UnsupportedEncodingException, NoValidInputDataException
88   {
89     StringBuffer idvector = new StringBuffer();
90     boolean list = false;
91     AlignmentI al = rj.getAlignmentForInput(token, type);
92     // assume that alignment is properly ordered so groups form consecutive
93     // blocks
94     ArrayList<int[]> gl = new ArrayList<>();
95     int p = 0, lowest = al.getHeight(), highest = 0;
96     List<SequenceGroup> sgs = al.getGroups();
97     synchronized (sgs)
98     {
99       for (SequenceGroup sg : sgs)
100       {
101         if (sg.getSize() < minsize)
102         {
103           throw new NoValidInputDataException(MessageManager.formatMessage(
104                   "exception.notvaliddata_group_contains_less_than_min_seqs",
105                   new String[]
106                   { Integer.valueOf(minsize).toString() }));
107         }
108         // TODO: refactor to sequenceGroup for efficiency -
109         // getAlignmentRowInterval(AlignmentI al)
110         int[] se = null;
111         for (SequenceI sq : sg.getSequencesInOrder(al))
112         {
113           p = al.findIndex(sq);
114           if (lowest > p)
115           {
116             lowest = p;
117           }
118           if (highest < p)
119           {
120             highest = p;
121           }
122           if (se == null)
123           {
124             se = new int[] { p, p };
125           }
126           else
127           {
128             if (p < se[0])
129             {
130               se[0] = p;
131             }
132             if (p > se[1])
133             {
134               se[1] = p;
135             }
136           }
137         }
138         if (se != null)
139         {
140           gl.add(se);
141         }
142       }
143     }
144     // are there any more sequences ungrouped that should be added as a single
145     // remaining group ? - these might be at the start or the end
146     if (gl.size() > 0)
147     {
148       if (lowest - 1 > minsize)
149       {
150         gl.add(0, new int[] { 0, lowest - 2 });
151       }
152       if ((al.getHeight() - 1 - highest) > minsize)
153       {
154         gl.add(new int[] { highest + 1, al.getHeight() - 1 });
155       }
156     }
157     else
158     {
159       gl.add(new int[] { 0, al.getHeight() - 1 });
160     }
161     if (min >= 0 && gl.size() < min)
162     {
163       throw new NoValidInputDataException(
164               "Not enough sequence groups for input. Need at least " + min
165                       + " groups (including ungrouped regions).");
166     }
167     if (max > 0 && gl.size() > max)
168     {
169       throw new NoValidInputDataException(
170               "Too many sequence groups for input. Need at most " + max
171                       + " groups (including ungrouped regions).");
172     }
173     int[][] vals = gl.toArray(new int[gl.size()][]);
174     int[] srt = new int[gl.size()];
175     for (int i = 0; i < vals.length; i++)
176     {
177       srt[i] = vals[i][0];
178     }
179     jalview.util.QuickSort.sort(srt, vals);
180     list = false;
181     int last = vals[0][0] - 1;
182     for (int[] range : vals)
183     {
184       if (range[1] > last)
185       {
186         if (list)
187         {
188           idvector.append(sep);
189         }
190         idvector.append(range[1] - last);
191         last = range[1];
192         list = true;
193       }
194     }
195     return new StringBody(idvector.toString());
196   }
197
198   /**
199    * set minimum number of sequences allowed in a partition. Default is 1
200    * sequence.
201    * 
202    * @param i
203    *          (number greater than 1)
204    */
205   public void setMinsize(int i)
206   {
207     if (minsize >= 1)
208     {
209       minsize = i;
210     }
211     else
212     {
213       minsize = 1;
214     }
215   }
216
217   @Override
218   public List<String> getURLEncodedParameter()
219   {
220     ArrayList<String> prms = new ArrayList<>();
221     super.addBaseParams(prms);
222     prms.add("minsize='" + minsize + "'");
223     prms.add("sep='" + sep + "'");
224     if (type != null)
225     {
226       prms.add("type='" + type + "'");
227     }
228     return prms;
229   }
230
231   @Override
232   public String getURLtokenPrefix()
233   {
234     return "PARTITION";
235   }
236
237   @Override
238   public boolean configureProperty(String tok, String val,
239           StringBuffer warnings)
240   {
241
242     if (tok.startsWith("sep"))
243     {
244       sep = val;
245       return true;
246     }
247     if (tok.startsWith("minsize"))
248     {
249       try
250       {
251         minsize = Integer.valueOf(val);
252         if (minsize >= 0)
253         {
254           return true;
255         }
256       } catch (Exception x)
257       {
258
259       }
260       warnings.append("Invalid minsize value '" + val
261               + "'. Must be a positive integer.\n");
262     }
263     if (tok.startsWith("type"))
264     {
265       try
266       {
267         type = molType.valueOf(val);
268         return true;
269       } catch (Exception x)
270       {
271         warnings.append(
272                 "Invalid molecule type '" + val + "'. Must be one of (");
273         for (molType v : molType.values())
274         {
275           warnings.append(" " + v);
276         }
277         warnings.append(")\n");
278       }
279     }
280     return false;
281   }
282
283   @Override
284   public List<OptionI> getOptions()
285   {
286     List<OptionI> lst = getBaseOptions();
287     lst.add(new Option("sep",
288             "Separator character between elements of vector", true, ",",
289             sep, Arrays.asList(new String[]
290             { " ", ",", ";", "\t", "|" }), null));
291     lst.add(new IntegerParameter("minsize",
292             "Minimum size of partition allowed by service", true, 1,
293             minsize, 1, 0));
294     lst.add(createMolTypeOption("type", "Sequence type", false, type,
295             molType.MIX));
296     return lst;
297   }
298
299 }