src/jalview/fts/core/FTSDataColumnPreferences.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.fts.core;
  22
  23 import jalview.fts.api.FTSDataColumnI;
  24 import jalview.fts.api.FTSDataColumnI.FTSDataColumnGroupI;
  25 import jalview.fts.api.FTSRestClientI;
  26 import jalview.fts.service.pdb.PDBFTSRestClient;
  27
  28 import java.util.ArrayList;
  29 import java.util.Collection;
  30 import java.util.Comparator;
  31 import java.util.HashMap;
  32 import java.util.LinkedHashSet;
  33 import java.util.List;
  34
  35 import javax.swing.JScrollPane;
  36 import javax.swing.JTable;
  37 import javax.swing.RowSorter;
  38 import javax.swing.SortOrder;
  39 import javax.swing.table.AbstractTableModel;
  40 import javax.swing.table.TableModel;
  41 import javax.swing.table.TableRowSorter;
  42
  43
  44 @SuppressWarnings("serial")
  45 public class FTSDataColumnPreferences extends JScrollPane
  46 {
  47   protected JTable tbl_FTSDataColumnPrefs = new JTable();
  48
  49   protected JScrollPane scrl_pdbDocFieldConfig = new JScrollPane(
  50           tbl_FTSDataColumnPrefs);
  51
  52   private HashMap<String, FTSDataColumnI> map = new HashMap<String, FTSDataColumnI>();
  53
  54   private Collection<FTSDataColumnI> structSummaryColumns = new LinkedHashSet<FTSDataColumnI>();
  55
  56   private Collection<FTSDataColumnI> allFTSDataColumns = new LinkedHashSet<FTSDataColumnI>();
  57
  58   public enum PreferenceSource
  59   {
  60     SEARCH_SUMMARY, STRUCTURE_CHOOSER, PREFERENCES;
  61   }
  62
  63   private PreferenceSource currentSource;
  64
  65   private FTSRestClientI ftsRestClient;
  66
  67   public FTSDataColumnPreferences(PreferenceSource source,
  68           FTSRestClientI ftsRestClient)
  69   {
  70     this.ftsRestClient = ftsRestClient;
  71     if (source.equals(PreferenceSource.STRUCTURE_CHOOSER)
  72             || source.equals(PreferenceSource.PREFERENCES))
  73     {
  74     structSummaryColumns = ((PDBFTSRestClient) ftsRestClient)
  75               .getAllDefaultDisplayedStructureDataColumns();
  76     }
  77     allFTSDataColumns.addAll(ftsRestClient.getAllFTSDataColumns());
  78
  79     tbl_FTSDataColumnPrefs.setAutoCreateRowSorter(true);
  80     this.getViewport().add(tbl_FTSDataColumnPrefs);
  81     this.currentSource = source;
  82
  83     String[] columnNames = null;
  84     switch (source)
  85     {
  86     case SEARCH_SUMMARY:
  87       columnNames = new String[] { "", "Display", "Group" };
  88       break;
  89     case STRUCTURE_CHOOSER:
  90       columnNames = new String[] { "", "Display", "Group" };
  91       break;
  92     case PREFERENCES:
  93       columnNames = new String[] { "PDB Field", "Show in search summary",
  94           "Show in structure summary" };
  95       break;
  96     default:
  97       break;
  98     }
  99
 100     Object[][] data = new Object[allFTSDataColumns.size() - 1][3];
 101
 102     int x = 0;
 103     for (FTSDataColumnI field : allFTSDataColumns)
 104     {
 105       if (field.getName().equalsIgnoreCase("all"))
 106       {
 107         continue;
 108       }
 109
 110       switch (source)
 111       {
 112       case SEARCH_SUMMARY:
 113         data[x++] = new Object[] {
 114             ftsRestClient.getAllDefaultDisplayedFTSDataColumns()
 115                     .contains(field),
 116             field.getName(), field.getGroup() };
 117         break;
 118       case STRUCTURE_CHOOSER:
 119         data[x++] = new Object[] { structSummaryColumns.contains(field),
 120             field.getName(), field.getGroup() };
 121         break;
 122       case PREFERENCES:
 123         data[x++] = new Object[] { field.getName(),
 124             ftsRestClient.getAllDefaultDisplayedFTSDataColumns()
 125                     .contains(field),
 126             structSummaryColumns.contains(field) };
 127         break;
 128       default:
 129         break;
 130       }
 131       map.put(field.getName(), field);
 132     }
 133
 134     FTSDataColumnPrefsTableModel model = new FTSDataColumnPrefsTableModel(columnNames, data);
 135     tbl_FTSDataColumnPrefs.setModel(model);
 136
 137     switch (source)
 138     {
 139     case SEARCH_SUMMARY:
 140     case STRUCTURE_CHOOSER:
 141       tbl_FTSDataColumnPrefs.getColumnModel().getColumn(0)
 142               .setPreferredWidth(30);
 143       tbl_FTSDataColumnPrefs.getColumnModel().getColumn(0).setMinWidth(20);
 144       tbl_FTSDataColumnPrefs.getColumnModel().getColumn(0).setMaxWidth(40);
 145       tbl_FTSDataColumnPrefs.getColumnModel().getColumn(1)
 146               .setPreferredWidth(150);
 147       tbl_FTSDataColumnPrefs.getColumnModel().getColumn(1).setMinWidth(150);
 148       tbl_FTSDataColumnPrefs.getColumnModel().getColumn(2)
 149               .setPreferredWidth(150);
 150       tbl_FTSDataColumnPrefs.getColumnModel().getColumn(2)
 151 .setMinWidth(150);
 152
 153       TableRowSorter<TableModel> sorter = new TableRowSorter<>(
 154               tbl_FTSDataColumnPrefs.getModel());
 155       tbl_FTSDataColumnPrefs.setRowSorter(sorter);
 156       List<RowSorter.SortKey> sortKeys = new ArrayList<>();
 157       int columnIndexToSort = 2;
 158       sortKeys.add(new RowSorter.SortKey(columnIndexToSort,
 159               SortOrder.ASCENDING));
 160       sorter.setSortKeys(sortKeys);
 161       sorter.setComparator(
 162               columnIndexToSort,
 163               new Comparator<FTSDataColumnGroupI>()
 164               {
 165                 @Override
 166                 public int compare(FTSDataColumnGroupI o1,
 167                         FTSDataColumnGroupI o2)
 168                 {
 169                   return o1.getSortOrder() - o2.getSortOrder();
 170                 }
 171               });
 172       sorter.sort();
 173
 174       tbl_FTSDataColumnPrefs
 175               .setAutoResizeMode(JTable.AUTO_RESIZE_NEXT_COLUMN);
 176       break;
 177     case PREFERENCES:
 178     default:
 179       break;
 180     }
 181
 182   }
 183
 184   public Collection<FTSDataColumnI> getStructureSummaryFields()
 185   {
 186     return structSummaryColumns;
 187   }
 188
 189   class FTSDataColumnPrefsTableModel extends AbstractTableModel
 190   {
 191
 192     public FTSDataColumnPrefsTableModel(String[] columnNames, Object[][] data)
 193     {
 194       this.data = data;
 195       this.columnNames = columnNames;
 196     }
 197
 198     private Object[][] data;
 199
 200     private String[] columnNames;
 201
 202     @Override
 203     public int getColumnCount()
 204     {
 205       return columnNames.length;
 206     }
 207
 208     @Override
 209     public int getRowCount()
 210     {
 211       return data.length;
 212     }
 213
 214     @Override
 215     public String getColumnName(int col)
 216     {
 217       return columnNames[col];
 218     }
 219
 220     @Override
 221     public Object getValueAt(int row, int col)
 222     {
 223       return data[row][col];
 224     }
 225
 226     /*
 227      * JTable uses this method to determine the default renderer/ editor for
 228      * each cell. If we didn't implement this method, then the last column would
 229      * contain text ("true"/"false"), rather than a check box.
 230      */
 231     @Override
 232     public Class getColumnClass(int c)
 233     {
 234       return getValueAt(0, c).getClass();
 235     }
 236
 237     /*
 238      * Don't need to implement this method unless your table's editable.
 239      */
 240     @Override
 241     public boolean isCellEditable(int row, int col)
 242     {
 243       // Note that the data/cell address is constant,
 244       // no matter where the cell appears onscreen.
 245       // !isPDBID(row, col) ensures the PDB_Id cell is never editable as it
 246       // serves as a unique id for each row.
 247       // return (col == 1 || col == 2) && !isPDBID(row, col);
 248       switch (currentSource)
 249       {
 250       case SEARCH_SUMMARY:
 251       case STRUCTURE_CHOOSER:
 252         return (col == 0) && !isPrimaryKeyCell(row, 1);
 253       case PREFERENCES:
 254         return (col == 1 || col == 2) && !isPrimaryKeyCell(row, 0);
 255       default:
 256         return false;
 257       }
 258
 259     }
 260
 261     /**
 262      * Determines whether the data in a given cell is a PDB ID.
 263      *
 264      * @param row
 265      * @param col
 266      * @return
 267      */
 268
 269     public boolean isPrimaryKeyCell(int row, int col)
 270     {
 271       String name = getValueAt(row, col).toString();
 272       FTSDataColumnI pdbField = map.get(name);
 273       return pdbField.isPrimaryKeyColumn();
 274     }
 275
 276     /*
 277      * Don't need to implement this method unless your table's data can change.
 278      */
 279     @Override
 280     public void setValueAt(Object value, int row, int col)
 281     {
 282       data[row][col] = value;
 283       fireTableCellUpdated(row, col);
 284
 285       String name = null;
 286       switch (currentSource)
 287       {
 288       case SEARCH_SUMMARY:
 289       case STRUCTURE_CHOOSER:
 290         name = getValueAt(row, 1).toString();
 291         break;
 292       case PREFERENCES:
 293         name = getValueAt(row, 0).toString();
 294         break;
 295       default:
 296         break;
 297       }
 298       boolean selected = ((Boolean) value).booleanValue();
 299
 300       FTSDataColumnI ftsDataColumn = map.get(name);
 301
 302       if (currentSource == PreferenceSource.SEARCH_SUMMARY)
 303       {
 304         updatePrefs(ftsRestClient
 305                 .getAllDefaultDisplayedFTSDataColumns(), ftsDataColumn,
 306                 selected);
 307       }
 308       else if (currentSource == PreferenceSource.STRUCTURE_CHOOSER)
 309       {
 310         updatePrefs(structSummaryColumns, ftsDataColumn, selected);
 311       }
 312       else if (currentSource == PreferenceSource.PREFERENCES)
 313       {
 314         if (col == 1)
 315         {
 316           updatePrefs(ftsRestClient
 317                   .getAllDefaultDisplayedFTSDataColumns(), ftsDataColumn,
 318                   selected);
 319         }
 320         else if (col == 2)
 321         {
 322           updatePrefs(structSummaryColumns, ftsDataColumn, selected);
 323         }
 324       }
 325     }
 326
 327     private void updatePrefs(
 328             Collection<FTSDataColumnI> prefConfig,
 329             FTSDataColumnI dataColumn, boolean selected)
 330     {
 331       if (prefConfig.contains(dataColumn) && !selected)
 332       {
 333         prefConfig.remove(dataColumn);
 334       }
 335
 336       if (!prefConfig.contains(dataColumn) && selected)
 337       {
 338         prefConfig.add(dataColumn);
 339       }
 340     }
 341
 342   }
 343 }