org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/events/TmfEventsView.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2010 Ericsson
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Francois Chouinard - Initial API and implementation
  11  *   Patrick Tasse - Factored out events table
  12  *******************************************************************************/
  13
  14 package org.eclipse.linuxtools.tmf.ui.views.events;
  15
  16 import java.lang.reflect.Constructor;
  17 import java.lang.reflect.InvocationTargetException;
  18
  19 import org.eclipse.core.resources.IMarker;
  20 import org.eclipse.core.resources.IMarkerDelta;
  21 import org.eclipse.core.resources.IResource;
  22 import org.eclipse.core.resources.IResourceChangeEvent;
  23 import org.eclipse.core.resources.IResourceChangeListener;
  24 import org.eclipse.core.resources.IResourceDelta;
  25 import org.eclipse.core.resources.ResourcesPlugin;
  26 import org.eclipse.core.runtime.CoreException;
  27 import org.eclipse.core.runtime.IConfigurationElement;
  28 import org.eclipse.core.runtime.InvalidRegistryObjectException;
  29 import org.eclipse.core.runtime.Platform;
  30 import org.eclipse.linuxtools.internal.tmf.ui.Activator;
  31 import org.eclipse.linuxtools.internal.tmf.ui.parsers.custom.CustomEventsTable;
  32 import org.eclipse.linuxtools.internal.tmf.ui.parsers.custom.CustomTxtTrace;
  33 import org.eclipse.linuxtools.internal.tmf.ui.parsers.custom.CustomXmlTrace;
  34 import org.eclipse.linuxtools.tmf.core.TmfCommonConstants;
  35 import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentDisposedSignal;
  36 import org.eclipse.linuxtools.tmf.core.signal.TmfExperimentSelectedSignal;
  37 import org.eclipse.linuxtools.tmf.core.signal.TmfSignalHandler;
  38 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
  39 import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;
  40 import org.eclipse.linuxtools.tmf.ui.project.model.TmfTraceType;
  41 import org.eclipse.linuxtools.tmf.ui.viewers.events.TmfEventsTable;
  42 import org.eclipse.linuxtools.tmf.ui.views.TmfView;
  43 import org.eclipse.swt.widgets.Composite;
  44 import org.eclipse.swt.widgets.Display;
  45 import org.eclipse.ui.ide.IGotoMarker;
  46 import org.osgi.framework.Bundle;
  47
  48 /**
  49  * The generic TMF Events View.
  50  * <p>
  51  * Support for:
  52  * <ul>
  53  * <li>Traces larger than available memory
  54  * <li>Searching and Filtering
  55  * <li>Customized table viewers (per trace type)
  56  * </ul>
  57  *
  58  * TODO: Handle column selection, sort, ... generically (nothing less...)
  59  * TODO: Implement hide/display columns
  60  *
  61  * @version 1.0
  62  * @author Francois Chouinard
  63  * @author Patrick Tasse
  64  */
  65 public class TmfEventsView extends TmfView implements IResourceChangeListener {
  66
  67     /** Event View's ID */
  68     public static final String ID = "org.eclipse.linuxtools.tmf.ui.views.events"; //$NON-NLS-1$
  69
  70     private TmfExperiment fExperiment;
  71     private TmfEventsTable fEventsTable;
  72     private static final int DEFAULT_CACHE_SIZE = 100;
  73     private String fTitlePrefix;
  74     private Composite fParent;
  75
  76         // ------------------------------------------------------------------------
  77     // Constructor
  78         // ------------------------------------------------------------------------
  79
  80     /**
  81      * Create an events view with a cache size
  82      * @param cacheSize not used
  83      */
  84     public TmfEventsView(int cacheSize) {
  85         super("TmfEventsView"); //$NON-NLS-1$
  86     }
  87
  88     /**
  89      * Default constructor, with a default cache size
  90      */
  91     public TmfEventsView() {
  92         this(DEFAULT_CACHE_SIZE);
  93     }
  94
  95         // ------------------------------------------------------------------------
  96     // ViewPart
  97         // ------------------------------------------------------------------------
  98
  99         @Override
 100         public void createPartControl(Composite parent) {
 101         fParent = parent;
 102
 103         fTitlePrefix = getTitle();
 104
 105         // If an experiment is already selected, update the table
 106         TmfExperiment experiment = TmfExperiment.getCurrentExperiment();
 107         if (experiment != null) {
 108             experimentSelected(new TmfExperimentSelectedSignal(this, experiment));
 109         } else {
 110             fEventsTable = createEventsTable(parent);
 111         }
 112     }
 113
 114     @Override
 115     public void dispose() {
 116         if (fEventsTable != null) {
 117             fEventsTable.dispose();
 118         }
 119         super.dispose();
 120     }
 121
 122     /**
 123      * Get the events table for an experiment.
 124      * If all traces in the experiment are of the same type,
 125      * use the extension point specified event table
 126      * @param parent the parent Composite
 127      * @return an events table of the appropriate type
 128      */
 129     protected TmfEventsTable createEventsTable(Composite parent) {
 130         if (fExperiment == null) {
 131             return new TmfEventsTable(parent, DEFAULT_CACHE_SIZE);
 132         }
 133         int cacheSize = fExperiment.getCacheSize();
 134         String commonTraceType = null;
 135         try {
 136             for (ITmfTrace trace : fExperiment.getTraces()) {
 137                 IResource resource = trace.getResource();
 138                 if (resource == null) {
 139                     return new TmfEventsTable(parent, cacheSize);
 140                 }
 141                 String traceType = resource.getPersistentProperty(TmfCommonConstants.TRACETYPE);
 142                 if ((commonTraceType != null) && !commonTraceType.equals(traceType)) {
 143                     return new TmfEventsTable(parent, cacheSize);
 144                 }
 145                 commonTraceType = traceType;
 146             }
 147             if (commonTraceType == null) {
 148                 return new TmfEventsTable(parent, cacheSize);
 149             }
 150             if (commonTraceType.startsWith(CustomTxtTrace.class.getCanonicalName())) {
 151                 return new CustomEventsTable(((CustomTxtTrace) fExperiment.getTraces()[0]).getDefinition(), parent, cacheSize);
 152             }
 153             if (commonTraceType.startsWith(CustomXmlTrace.class.getCanonicalName())) {
 154                 return new CustomEventsTable(((CustomXmlTrace) fExperiment.getTraces()[0]).getDefinition(), parent, cacheSize);
 155             }
 156             for (IConfigurationElement ce : TmfTraceType.getTypeElements()) {
 157                 if (ce.getAttribute(TmfTraceType.ID_ATTR).equals(commonTraceType)) {
 158                     IConfigurationElement[] eventsTableTypeCE = ce.getChildren(TmfTraceType.EVENTS_TABLE_TYPE_ELEM);
 159                     if (eventsTableTypeCE.length != 1) {
 160                         break;
 161                     }
 162                     String eventsTableType = eventsTableTypeCE[0].getAttribute(TmfTraceType.CLASS_ATTR);
 163                     if ((eventsTableType == null) || (eventsTableType.length() == 0)) {
 164                         break;
 165                     }
 166                     Bundle bundle = Platform.getBundle(ce.getContributor().getName());
 167                     Class<?> c = bundle.loadClass(eventsTableType);
 168                     Class<?>[] constructorArgs = new Class[] { Composite.class, int.class };
 169                     Constructor<?> constructor = c.getConstructor(constructorArgs);
 170                     Object[] args = new Object[] { parent, cacheSize };
 171                     return (TmfEventsTable) constructor.newInstance(args);
 172                 }
 173             }
 174         } catch (CoreException e) {
 175             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 176         } catch (InvalidRegistryObjectException e) {
 177             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 178         } catch (SecurityException e) {
 179             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 180         } catch (IllegalArgumentException e) {
 181             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 182         } catch (ClassNotFoundException e) {
 183             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 184         } catch (NoSuchMethodException e) {
 185             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 186         } catch (InstantiationException e) {
 187             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 188         } catch (IllegalAccessException e) {
 189             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 190         } catch (InvocationTargetException e) {
 191             Activator.getDefault().logError("Error creating events table", e); //$NON-NLS-1$
 192         }
 193         return new TmfEventsTable(parent, cacheSize);
 194     }
 195
 196     /* (non-Javadoc)
 197      * @see org.eclipse.ui.part.WorkbenchPart#setFocus()
 198      */
 199     @Override
 200         public void setFocus() {
 201         fEventsTable.setFocus();
 202     }
 203
 204     /* (non-Javadoc)
 205      * @see org.eclipse.ui.part.WorkbenchPart#getAdapter(java.lang.Class)
 206      */
 207     @Override
 208     public Object getAdapter(Class adapter) {
 209         if (IGotoMarker.class.equals(adapter)) {
 210             return fEventsTable;
 211         }
 212         return super.getAdapter(adapter);
 213     }
 214
 215     /* (non-Javadoc)
 216      * @see java.lang.Object#toString()
 217      */
 218     @Override
 219         @SuppressWarnings("nls")
 220         public String toString() {
 221         return "[TmfEventsView]";
 222     }
 223
 224     // ------------------------------------------------------------------------
 225     // Signal handlers
 226         // ------------------------------------------------------------------------
 227
 228     /**
 229      * Handler for the experiment selected signal.
 230      *
 231      * @param signal
 232      *            The incoming signal
 233      */
 234     @TmfSignalHandler
 235     public void experimentSelected(TmfExperimentSelectedSignal signal) {
 236         // Update the trace reference
 237         TmfExperiment exp = signal.getExperiment();
 238         if (!exp.equals(fExperiment)) {
 239             fExperiment = exp;
 240             setPartName(fTitlePrefix + " - " + fExperiment.getName()); //$NON-NLS-1$
 241             if (fEventsTable != null) {
 242                 fEventsTable.dispose();
 243             }
 244             fEventsTable = createEventsTable(fParent);
 245             fEventsTable.setTrace(fExperiment, false);
 246             fEventsTable.refreshBookmarks(fExperiment.getBookmarksFile());
 247             if (fExperiment.getBookmarksFile() != null) {
 248                 ResourcesPlugin.getWorkspace().addResourceChangeListener(this, IResourceChangeEvent.POST_CHANGE);
 249             }
 250             fParent.layout();
 251         }
 252     }
 253
 254     /**
 255      * Handler for the experiment disposed signal.
 256      *
 257      * @param signal
 258      *            The incoming signal
 259      */
 260     @TmfSignalHandler
 261     public void experimentDisposed(TmfExperimentDisposedSignal signal) {
 262         // Clear the trace reference
 263         TmfExperiment experiment = signal.getExperiment();
 264         if (experiment.equals(fExperiment)) {
 265             fEventsTable.setTrace(null, false);
 266
 267             Activator.getDefault().getWorkbench().getWorkbenchWindows()[0].getShell().getDisplay().syncExec(new Runnable() {
 268                 @Override
 269                 public void run() {
 270                     setPartName(fTitlePrefix);
 271                 }
 272             });
 273
 274             if ((fExperiment != null) && (fExperiment.getBookmarksFile() != null)) {
 275                 ResourcesPlugin.getWorkspace().removeResourceChangeListener(this);
 276             }
 277             fExperiment = null;
 278         }
 279     }
 280
 281     @Override
 282     public void resourceChanged(final IResourceChangeEvent event) {
 283             if ((fExperiment == null) || (fExperiment.getBookmarksFile() == null)) {
 284                 return;
 285             }
 286
 287         for (final IMarkerDelta delta : event.findMarkerDeltas(IMarker.BOOKMARK, false)) {
 288             if (delta.getResource().equals(fExperiment.getBookmarksFile())) {
 289                 if (delta.getKind() == IResourceDelta.REMOVED) {
 290                     final IMarker bookmark = delta.getMarker();
 291                     Display.getDefault().asyncExec(new Runnable() {
 292                         @Override
 293                         public void run() {
 294                             fEventsTable.removeBookmark(bookmark);
 295                         }
 296                     });
 297                 } else if (delta.getKind() == IResourceDelta.CHANGED) {
 298                     Display.getDefault().asyncExec(new Runnable() {
 299                         @Override
 300                         public void run() {
 301                             fEventsTable.getTable().refresh();
 302                         }
 303                     });
 304                 }
 305             }
 306         }
 307     }
 308 }