eclipse/plugins/org.argeo.slc.client.ui.dist/src/main/java/org/argeo/slc/client/ui/dist/utils/ArtifactsTableConfigurer.java

   1 package org.argeo.slc.client.ui.dist.utils;
   2
   3 import java.text.DateFormat;
   4 import java.text.SimpleDateFormat;
   5 import java.util.HashMap;
   6 import java.util.Map;
   7
   8 import javax.jcr.PropertyType;
   9 import javax.jcr.RepositoryException;
  10 import javax.jcr.Value;
  11 import javax.jcr.query.Row;
  12
  13 import org.apache.commons.logging.Log;
  14 import org.apache.commons.logging.LogFactory;
  15 import org.argeo.ArgeoException;
  16 import org.argeo.eclipse.ui.GenericTableComparator;
  17 import org.argeo.slc.client.ui.dist.DistConstants;
  18 import org.argeo.slc.jcr.SlcNames;
  19 import org.argeo.slc.jcr.SlcTypes;
  20 import org.eclipse.jface.viewers.ColumnLabelProvider;
  21 import org.eclipse.jface.viewers.TableViewer;
  22 import org.eclipse.jface.viewers.TableViewerColumn;
  23 import org.eclipse.jface.viewers.Viewer;
  24 import org.eclipse.swt.SWT;
  25 import org.eclipse.swt.events.SelectionAdapter;
  26 import org.eclipse.swt.events.SelectionEvent;
  27 import org.eclipse.swt.graphics.Image;
  28 import org.eclipse.swt.widgets.TableColumn;
  29
  30 /**
  31  * Centralizes and factorizes useful methods to create and manage tables that
  32  * display artifacts for both editors and views.
  33  */
  34 public class ArtifactsTableConfigurer implements SlcNames, SlcTypes,
  35                 DistConstants {
  36         private final static Log log = LogFactory
  37                         .getLog(ArtifactsTableConfigurer.class);
  38         // Used in the comparator to be able to retrieve the value from a row
  39         // knowing the corresponding column index.
  40         private Map<Integer, String> indexToName = new HashMap<Integer, String>();
  41
  42         private CurrentTableComparator comparator;
  43         private TableViewer viewer;
  44
  45         protected DateFormat timeFormatter = new SimpleDateFormat(DATE_TIME_FORMAT);
  46
  47         /**
  48          * Create and initialize the table configurer.
  49          */
  50         public ArtifactsTableConfigurer(TableViewer viewer,
  51                         int defaultSortColumnIndex, int direction) {
  52                 this.viewer = viewer;
  53                 comparator = new CurrentTableComparator(defaultSortColumnIndex,
  54                                 direction);
  55         }
  56
  57         public GenericTableComparator getComparator() {
  58                 return comparator;
  59         }
  60
  61         /**
  62          * Configure column width and header label depending on the value that will
  63          * be displayed in the current column.
  64          *
  65          * @param jcrColumnName
  66          * @param column
  67          * @param columnIndex
  68          */
  69         public void configureColumn(String jcrColumnName, TableViewerColumn column,
  70                         int columnIndex) {
  71
  72                 if (columnIndex != -1
  73                                 && getSelectionAdapter(column.getColumn(), columnIndex) != null) {
  74                         column.getColumn().addSelectionListener(
  75                                         getSelectionAdapter(column.getColumn(), columnIndex));
  76                         indexToName.put(new Integer(columnIndex), jcrColumnName);
  77                 }
  78                 Object[] objs = DistUiHelpers
  79                                 .getLabelAndDefaultValueWidth(jcrColumnName);
  80                 column.getColumn().setWidth((Integer) objs[1]);
  81                 column.getColumn().setText((String) objs[0]);
  82         }
  83
  84         /**
  85          * Might be used by client classes to sort the table with based on selected
  86          * columns.
  87          *
  88          * @param column
  89          * @param index
  90          * @return
  91          */
  92         public SelectionAdapter getSelectionAdapter(final TableColumn column,
  93                         final int index) {
  94
  95                 // A comparator must be define
  96                 if (comparator == null)
  97                         return null;
  98
  99                 SelectionAdapter selectionAdapter = new SelectionAdapter() {
 100                         @Override
 101                         public void widgetSelected(SelectionEvent e) {
 102
 103                                 try {
 104
 105                                         comparator.setColumn(index);
 106                                         int dir = viewer.getTable().getSortDirection();
 107                                         if (viewer.getTable().getSortColumn() == column) {
 108                                                 dir = dir == SWT.UP ? SWT.DOWN : SWT.UP;
 109                                         } else {
 110
 111                                                 dir = SWT.DOWN;
 112                                         }
 113                                         viewer.getTable().setSortDirection(dir);
 114                                         viewer.getTable().setSortColumn(column);
 115                                         viewer.refresh();
 116                                 } catch (Exception exc) {
 117                                         exc.printStackTrace();
 118                                 }
 119                         }
 120                 };
 121                 return selectionAdapter;
 122         }
 123
 124         /**
 125          * provides a label provider that returns the content of a specific cell.
 126          * Specific treatment is done for some columns when the query returns a code
 127          * that must be translated to the corresponding value at display time.
 128          */
 129         public ColumnLabelProvider getLabelProvider(final String columnName) {
 130                 boolean test = false;
 131
 132                 if (test) {
 133                         return new ColumnLabelProvider() {
 134                                 public String getText(Object element) {
 135                                         return null;
 136                                 }
 137
 138                                 public Image getImage(Object element) {
 139                                         return null;
 140                                 }
 141                         };
 142                 } else
 143                         return new ColumnLabelProvider() {
 144                                 public String getText(Object element) {
 145                                         Row row = (Row) element;
 146                                         try {
 147                                                 return row.getValue(columnName).getString();
 148                                         } catch (RepositoryException e) {
 149                                                 throw new ArgeoException("Cannot display row " + row, e);
 150                                         }
 151                                 }
 152
 153                                 public Image getImage(Object element) {
 154                                         return null;
 155                                 }
 156                         };
 157         }
 158
 159         /** Implements comparator for various types of Artifact Table row */
 160         private class CurrentTableComparator extends GenericTableComparator {
 161
 162                 public CurrentTableComparator(int colIndex, int direction) {
 163                         super(colIndex, direction);
 164                 }
 165
 166                 @Override
 167                 public int compare(Viewer viewer, Object e1, Object e2) {
 168                         int rc = 0;
 169
 170                         if (e1 instanceof Row) {
 171                                 try {
 172
 173                                         Value v1 = ((Row) e1).getValue(indexToName
 174                                                         .get(propertyIndex));
 175                                         Value v2 = ((Row) e2).getValue(indexToName
 176                                                         .get(propertyIndex));
 177
 178                                         if (v1.getType() == PropertyType.STRING)
 179                                                 rc = v1.getString().compareTo(v2.getString());
 180                                         else if (v1.getType() == PropertyType.DATE)
 181                                                 rc = v1.getDate().compareTo(v2.getDate());
 182                                         else
 183                                                 throw new ArgeoException("comparator for object type "
 184                                                                 + v1.getType() + " is not yet implemented");
 185                                 } catch (Exception e) {
 186                                         throw new ArgeoException("rows cannot be compared ", e);
 187                                 }
 188                         } else
 189                                 throw new ArgeoException("Unsupported row type");
 190                         // If descending order, flip the direction
 191                         if (direction == DESCENDING) {
 192                                 rc = -rc;
 193                         }
 194                         return rc;
 195                 }
 196         }
 197 }