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.fts.core;
23 import jalview.fts.api.FTSDataColumnI;
24 import jalview.fts.api.FTSDataColumnI.FTSDataColumnGroupI;
25 import jalview.fts.api.FTSRestClientI;
26 import jalview.fts.api.StructureFTSRestClientI;
27 import jalview.fts.service.pdb.PDBFTSRestClient;
29 import java.util.ArrayList;
30 import java.util.Collection;
31 import java.util.Comparator;
32 import java.util.HashMap;
33 import java.util.LinkedHashSet;
34 import java.util.List;
36 import javax.swing.JScrollPane;
37 import javax.swing.JTable;
38 import javax.swing.RowSorter;
39 import javax.swing.SortOrder;
40 import javax.swing.table.AbstractTableModel;
41 import javax.swing.table.TableModel;
42 import javax.swing.table.TableRowSorter;
44 * Helps render GUI allowing control of which columns to show for entries returned from an FTS query.
45 * TODO: push down FTSClient specific code
50 @SuppressWarnings("serial")
51 public class FTSDataColumnPreferences extends JScrollPane
53 protected JTable tbl_FTSDataColumnPrefs = new JTable();
55 protected JScrollPane scrl_pdbDocFieldConfig = new JScrollPane(
56 tbl_FTSDataColumnPrefs);
58 private HashMap<String, FTSDataColumnI> map = new HashMap<String, FTSDataColumnI>();
60 private Collection<FTSDataColumnI> structSummaryColumns = new LinkedHashSet<FTSDataColumnI>();
62 private Collection<FTSDataColumnI> allFTSDataColumns = new LinkedHashSet<FTSDataColumnI>();
64 public enum PreferenceSource
66 SEARCH_SUMMARY, STRUCTURE_CHOOSER, PREFERENCES;
69 private PreferenceSource currentSource;
71 private FTSRestClientI ftsRestClient;
73 public FTSDataColumnPreferences(PreferenceSource source,
74 FTSRestClientI ftsRestClient)
76 this.ftsRestClient = ftsRestClient;
77 if (source.equals(PreferenceSource.STRUCTURE_CHOOSER)
78 || source.equals(PreferenceSource.PREFERENCES))
80 structSummaryColumns = ((StructureFTSRestClientI) ftsRestClient)
81 .getAllDefaultDisplayedStructureDataColumns();
83 allFTSDataColumns.addAll(ftsRestClient.getAllFTSDataColumns());
85 tbl_FTSDataColumnPrefs.setAutoCreateRowSorter(true);
86 this.getViewport().add(tbl_FTSDataColumnPrefs);
87 this.currentSource = source;
89 String[] columnNames = ftsRestClient.getPreferencesColumnsFor(source);
91 Object[][] data = new Object[allFTSDataColumns.size()][3];
94 for (FTSDataColumnI field : allFTSDataColumns)
96 //System.out.println("allFTSDataColumns==" + allFTSDataColumns);
97 if (field.getName().equalsIgnoreCase("all"))
105 data[x++] = new Object[] { ftsRestClient
106 .getAllDefaultDisplayedFTSDataColumns().contains(field),
107 field.getName(), field.getGroup() };
108 //System.out.println(" PUIS " + field.getName() + " ET AUSSI " + field.getGroup() + "X = " + x);
110 case STRUCTURE_CHOOSER:
111 data[x++] = new Object[] { structSummaryColumns.contains(field),
112 field.getName(), field.getGroup() };
115 data[x++] = new Object[] {
116 field.getName(), ftsRestClient
117 .getAllDefaultDisplayedFTSDataColumns().contains(field),
118 structSummaryColumns.contains(field) };
123 map.put(field.getName(), field);
126 FTSDataColumnPrefsTableModel model = new FTSDataColumnPrefsTableModel(
128 tbl_FTSDataColumnPrefs.setModel(model);
133 case STRUCTURE_CHOOSER:
134 tbl_FTSDataColumnPrefs.getColumnModel().getColumn(0)
135 .setPreferredWidth(30);
136 tbl_FTSDataColumnPrefs.getColumnModel().getColumn(0).setMinWidth(20);
137 tbl_FTSDataColumnPrefs.getColumnModel().getColumn(0).setMaxWidth(40);
138 tbl_FTSDataColumnPrefs.getColumnModel().getColumn(1)
139 .setPreferredWidth(150);
140 tbl_FTSDataColumnPrefs.getColumnModel().getColumn(1).setMinWidth(150);
141 tbl_FTSDataColumnPrefs.getColumnModel().getColumn(2)
142 .setPreferredWidth(150);
143 tbl_FTSDataColumnPrefs.getColumnModel().getColumn(2).setMinWidth(150);
145 TableRowSorter<TableModel> sorter = new TableRowSorter<>(
146 tbl_FTSDataColumnPrefs.getModel());
147 tbl_FTSDataColumnPrefs.setRowSorter(sorter);
148 List<RowSorter.SortKey> sortKeys = new ArrayList<>();
149 int columnIndexToSort = 2;
150 sortKeys.add(new RowSorter.SortKey(columnIndexToSort,
151 SortOrder.ASCENDING));
152 sorter.setComparator(columnIndexToSort,
153 new Comparator<FTSDataColumnGroupI>()
156 public int compare(FTSDataColumnGroupI o1,
157 FTSDataColumnGroupI o2)
159 return o1.getSortOrder() - o2.getSortOrder();
162 sorter.setSortKeys(sortKeys);
163 // BH 2018 setSortKeys does a sort sorter.sort();
165 tbl_FTSDataColumnPrefs
166 .setAutoResizeMode(JTable.AUTO_RESIZE_NEXT_COLUMN);
175 public Collection<FTSDataColumnI> getStructureSummaryFields()
177 return structSummaryColumns;
180 class FTSDataColumnPrefsTableModel extends AbstractTableModel
183 public FTSDataColumnPrefsTableModel(String[] columnNames,
187 this.columnNames = columnNames;
190 private Object[][] data;
192 private String[] columnNames;
195 public int getColumnCount()
197 return columnNames.length;
201 public int getRowCount()
207 public String getColumnName(int col)
209 return columnNames[col];
213 public Object getValueAt(int row, int col)
215 return data[row][col];
219 * JTable uses this method to determine the default renderer/ editor for
220 * each cell. If we didn't implement this method, then the last column would
221 * contain text ("true"/"false"), rather than a check box.
224 public Class getColumnClass(int c)
226 return getValueAt(0, c).getClass();
230 * Don't need to implement this method unless your table's editable.
233 public boolean isCellEditable(int row, int col)
235 // Note that the data/cell address is constant,
236 // no matter where the cell appears onscreen.
237 // !isPDBID(row, col) ensures the PDB_Id cell is never editable as it
238 // serves as a unique id for each row.
239 // return (col == 1 || col == 2) && !isPDBID(row, col);
240 switch (currentSource)
243 case STRUCTURE_CHOOSER:
244 return (col == 0) && !isPrimaryKeyCell(row, 1);
246 return (col == 1 || col == 2) && !isPrimaryKeyCell(row, 0);
254 * Determines whether the data in a given cell is a PDB ID.
261 public boolean isPrimaryKeyCell(int row, int col)
263 String name = getValueAt(row, col).toString();
264 FTSDataColumnI pdbField = map.get(name);
265 return pdbField.isPrimaryKeyColumn();
269 * Don't need to implement this method unless your table's data can change.
272 public void setValueAt(Object value, int row, int col)
274 data[row][col] = value;
275 fireTableCellUpdated(row, col);
278 switch (currentSource)
281 case STRUCTURE_CHOOSER:
282 name = getValueAt(row, 1).toString();
285 name = getValueAt(row, 0).toString();
290 boolean selected = ((Boolean) value).booleanValue();
292 FTSDataColumnI ftsDataColumn = map.get(name);
294 if (currentSource == PreferenceSource.SEARCH_SUMMARY)
296 updatePrefs(ftsRestClient.getAllDefaultDisplayedFTSDataColumns(),
297 ftsDataColumn, selected);
299 else if (currentSource == PreferenceSource.STRUCTURE_CHOOSER)
301 updatePrefs(structSummaryColumns, ftsDataColumn, selected);
303 else if (currentSource == PreferenceSource.PREFERENCES)
307 updatePrefs(ftsRestClient.getAllDefaultDisplayedFTSDataColumns(),
308 ftsDataColumn, selected);
312 updatePrefs(structSummaryColumns, ftsDataColumn, selected);
317 private void updatePrefs(Collection<FTSDataColumnI> prefConfig,
318 FTSDataColumnI dataColumn, boolean selected)
320 if (prefConfig.contains(dataColumn) && !selected)
322 prefConfig.remove(dataColumn);
325 if (!prefConfig.contains(dataColumn) && selected)
327 prefConfig.add(dataColumn);