2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
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.
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.
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.
21 package jalview.controller;
23 import jalview.analysis.AlignmentSorter;
24 import jalview.api.AlignViewControllerGuiI;
25 import jalview.api.AlignViewControllerI;
26 import jalview.api.AlignViewportI;
27 import jalview.api.AlignmentViewPanel;
28 import jalview.api.FeatureRenderer;
29 import jalview.commands.OrderCommand;
30 import jalview.datamodel.AlignmentI;
31 import jalview.datamodel.ColumnSelection;
32 import jalview.datamodel.SequenceCollectionI;
33 import jalview.datamodel.SequenceFeature;
34 import jalview.datamodel.SequenceGroup;
35 import jalview.datamodel.SequenceI;
36 import jalview.io.DataSourceType;
37 import jalview.io.FeaturesFile;
38 import jalview.util.MessageManager;
40 import java.awt.Color;
41 import java.util.BitSet;
42 import java.util.List;
44 public class AlignViewController implements AlignViewControllerI
46 AlignViewportI viewport = null;
48 AlignmentViewPanel alignPanel = null;
51 * the GUI container that is handling interactions with the user
53 private AlignViewControllerGuiI avcg;
55 public AlignViewController(AlignViewControllerGuiI alignFrame,
56 AlignViewportI vp, AlignmentViewPanel ap)
58 this.avcg = alignFrame;
64 public void setViewportAndAlignmentPanel(AlignViewportI vp,
65 AlignmentViewPanel ap)
72 public boolean makeGroupsFromSelection()
74 SequenceGroup sg = viewport.getSelectionGroup();
75 ColumnSelection cs = viewport.getColumnSelection();
76 SequenceGroup[] gps = null;
77 if (sg != null && (cs == null || cs.isEmpty()))
79 gps = jalview.analysis.Grouping.makeGroupsFrom(
80 viewport.getSequenceSelection(),
81 viewport.getAlignmentView(true)
82 .getSequenceStrings(viewport.getGapCharacter()),
83 viewport.getAlignment().getGroups());
89 gps = jalview.analysis.Grouping.makeGroupsFromCols(
90 (sg == null) ? viewport.getAlignment().getSequencesArray()
91 : sg.getSequences().toArray(new SequenceI[0]),
92 cs, viewport.getAlignment().getGroups());
97 viewport.getAlignment().deleteAllGroups();
98 viewport.clearSequenceColours();
99 viewport.setSelectionGroup(null);
100 // set view properties for each group
101 for (int g = 0; g < gps.length; g++)
103 // gps[g].setShowunconserved(viewport.getShowUnconserved());
104 gps[g].setshowSequenceLogo(viewport.isShowSequenceLogo());
105 viewport.getAlignment().addGroup(gps[g]);
106 Color col = new Color((int) (Math.random() * 255),
107 (int) (Math.random() * 255), (int) (Math.random() * 255));
108 col = col.brighter();
109 for (SequenceI sq : gps[g].getSequences(null))
111 viewport.setSequenceColour(sq, col);
120 public boolean createGroup()
123 SequenceGroup sg = viewport.getSelectionGroup();
126 viewport.getAlignment().addGroup(sg);
133 public boolean unGroup()
135 SequenceGroup sg = viewport.getSelectionGroup();
138 viewport.getAlignment().deleteGroup(sg);
145 public boolean deleteGroups()
147 if (viewport.getAlignment().getGroups() != null
148 && viewport.getAlignment().getGroups().size() > 0)
150 viewport.getAlignment().deleteAllGroups();
151 viewport.clearSequenceColours();
152 viewport.setSelectionGroup(null);
159 public boolean markColumnsContainingFeatures(boolean invert,
160 boolean extendCurrent, boolean toggle, String... featureType)
162 // JBPNote this routine could also mark rows, not just columns.
163 // need a decent query structure to allow all types of feature searches
164 BitSet bs = new BitSet();
165 SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null
166 || extendCurrent) ? viewport.getAlignment()
167 : viewport.getSelectionGroup();
169 int nseq = findColumnsWithFeature(sqcol, bs, featureType);
171 ColumnSelection cs = viewport.getColumnSelection();
174 cs = new ColumnSelection();
177 String featureTypeString = featureType.length == 1 ? featureType[0]
178 : featureType.toString();
180 if (bs.cardinality() > 0 || invert)
182 boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
183 sqcol.getEndRes(), invert, extendCurrent, toggle);
186 viewport.setColumnSelection(cs);
187 alignPanel.paintAlignment(false, false);
188 int columnCount = invert
189 ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
192 avcg.setStatus(MessageManager.formatMessage(
193 "label.view_controller_toggled_marked", new String[]
194 { toggle ? MessageManager.getString("label.toggled")
195 : MessageManager.getString("label.marked"),
196 String.valueOf(columnCount),
197 invert ? MessageManager
198 .getString("label.not_containing")
199 : MessageManager.getString("label.containing"),
200 featureTypeString, Integer.valueOf(nseq).toString() }));
206 avcg.setStatus(MessageManager
207 .formatMessage("label.no_feature_of_type_found", new String[]
208 { featureTypeString }));
212 alignPanel.paintAlignment(false, false);
219 * Sets a bit in the BitSet for each column (base 0) in the sequence
220 * collection which includes a visible feature of the specified feature
221 * type(s). Returns the number of sequences which have the feature(s) visible
222 * in the selected range.
230 int findColumnsWithFeature(SequenceCollectionI sqcol,
231 BitSet bs, String... featureType)
233 FeatureRenderer fr = alignPanel == null ? null : alignPanel
234 .getFeatureRenderer();
236 final int startColumn = sqcol.getStartRes() + 1; // converted to base 1
237 final int endColumn = sqcol.getEndRes() + 1;
238 List<SequenceI> seqs = sqcol.getSequences();
240 for (SequenceI sq : seqs)
244 // int ist = sq.findPosition(sqcol.getStartRes());
245 List<SequenceFeature> sfs = sq.findFeatures(startColumn,
246 endColumn, featureType);
248 boolean found = false;
249 for (SequenceFeature sf : sfs)
251 if (fr.getColour(sf) == null)
261 int sfStartCol = sq.findIndex(sf.getBegin());
262 int sfEndCol = sq.findIndex(sf.getEnd());
264 if (sf.isContactFeature())
267 * 'contact' feature - check for 'start' or 'end'
268 * position within the selected region
270 if (sfStartCol >= startColumn && sfStartCol <= endColumn)
272 bs.set(sfStartCol - 1);
274 if (sfEndCol >= startColumn && sfEndCol <= endColumn)
276 bs.set(sfEndCol - 1);
282 * contiguous feature - select feature positions (if any)
283 * within the selected region
285 if (sfStartCol < startColumn)
287 sfStartCol = startColumn;
289 // not sure what the point of this is
290 // if (sfStartCol < ist)
294 if (sfEndCol > endColumn)
296 sfEndCol = endColumn;
298 for (; sfStartCol <= sfEndCol; sfStartCol++)
300 bs.set(sfStartCol - 1); // convert to base 0
309 public void sortAlignmentByFeatureDensity(List<String> typ)
311 sortBy(typ, "Sort by Density", AlignmentSorter.FEATURE_DENSITY);
314 protected void sortBy(List<String> typ, String methodText,
317 FeatureRenderer fr = alignPanel.getFeatureRenderer();
318 if (typ == null && fr != null)
320 typ = fr.getDisplayedFeatureTypes();
322 List<String> gps = null;
325 gps = fr.getDisplayedFeatureGroups();
327 AlignmentI al = viewport.getAlignment();
330 SequenceGroup sg = viewport.getSelectionGroup();
333 start = sg.getStartRes();
334 stop = sg.getEndRes();
339 stop = al.getWidth();
341 SequenceI[] oldOrder = al.getSequencesArray();
342 AlignmentSorter.sortByFeature(typ, gps, start, stop, al, method);
343 avcg.addHistoryItem(new OrderCommand(methodText, oldOrder,
344 viewport.getAlignment()));
345 alignPanel.paintAlignment(true, false);
350 public void sortAlignmentByFeatureScore(List<String> typ)
352 sortBy(typ, "Sort by Feature Score", AlignmentSorter.FEATURE_SCORE);
356 public boolean parseFeaturesFile(String file, DataSourceType protocol,
357 boolean relaxedIdMatching)
359 boolean featuresAdded = false;
360 FeatureRenderer fr = alignPanel.getFeatureRenderer();
363 featuresAdded = new FeaturesFile(false, file, protocol).parse(
364 viewport.getAlignment().getDataset(), fr.getFeatureColours(),
365 fr.getFeatureFilters(), false, relaxedIdMatching);
366 } catch (Exception ex)
368 ex.printStackTrace();
373 avcg.refreshFeatureUI(true);
376 // update the min/max ranges where necessary
377 fr.findAllFeatures(true);
379 if (avcg.getFeatureSettingsUI() != null)
381 avcg.getFeatureSettingsUI().discoverAllFeatureData();
383 alignPanel.paintAlignment(true, true);
386 return featuresAdded;
391 public boolean markHighlightedColumns(boolean invert,
392 boolean extendCurrent, boolean toggle)
394 if (!viewport.hasSearchResults())
396 // do nothing if no selection exists
399 // JBPNote this routine could also mark rows, not just columns.
400 BitSet bs = new BitSet();
401 SequenceCollectionI sqcol = (viewport.getSelectionGroup() == null
402 || extendCurrent) ? viewport.getAlignment()
403 : viewport.getSelectionGroup();
405 // this could be a lambda... - the remains of the method is boilerplate,
406 // except for the different messages for reporting selection.
407 int nseq = viewport.getSearchResults().markColumns(sqcol, bs);
409 ColumnSelection cs = viewport.getColumnSelection();
412 cs = new ColumnSelection();
415 if (bs.cardinality() > 0 || invert)
417 boolean changed = cs.markColumns(bs, sqcol.getStartRes(),
418 sqcol.getEndRes(), invert, extendCurrent, toggle);
421 viewport.setColumnSelection(cs);
422 alignPanel.paintAlignment(false, false);
423 int columnCount = invert
424 ? (sqcol.getEndRes() - sqcol.getStartRes() + 1)
427 avcg.setStatus(MessageManager.formatMessage(
428 "label.view_controller_toggled_marked", new String[]
429 { toggle ? MessageManager.getString("label.toggled")
430 : MessageManager.getString("label.marked"),
431 String.valueOf(columnCount),
432 invert ? MessageManager
433 .getString("label.not_containing")
434 : MessageManager.getString("label.containing"),
435 "Highlight", Integer.valueOf(nseq).toString() }));
441 avcg.setStatus(MessageManager
442 .formatMessage("No highlighted regions marked"));
446 alignPanel.paintAlignment(false, false);