lttng/org.eclipse.tracecompass.lttng2.control.ui/src/org/eclipse/tracecompass/internal/lttng2/control/ui/views/model/impl/TraceEventComponent.java

   1 /**********************************************************************
   2  * Copyright (c) 2012, 2014 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  *   Bernd Hufmann - Initial API and implementation
  11  *   Bernd Hufmann - Updated for support of LTTng Tools 2.1
  12  **********************************************************************/
  13 package org.eclipse.tracecompass.internal.lttng2.control.ui.views.model.impl;
  14
  15 import java.util.List;
  16
  17 import org.eclipse.core.commands.ExecutionException;
  18 import org.eclipse.core.runtime.IProgressMonitor;
  19 import org.eclipse.swt.graphics.Image;
  20 import org.eclipse.tracecompass.internal.lttng2.control.core.model.IEventInfo;
  21 import org.eclipse.tracecompass.internal.lttng2.control.core.model.LogLevelType;
  22 import org.eclipse.tracecompass.internal.lttng2.control.core.model.TraceEnablement;
  23 import org.eclipse.tracecompass.internal.lttng2.control.core.model.TraceEventType;
  24 import org.eclipse.tracecompass.internal.lttng2.control.core.model.TraceLogLevel;
  25 import org.eclipse.tracecompass.internal.lttng2.control.core.model.impl.EventInfo;
  26 import org.eclipse.tracecompass.internal.lttng2.control.ui.Activator;
  27 import org.eclipse.tracecompass.internal.lttng2.control.ui.views.messages.Messages;
  28 import org.eclipse.tracecompass.internal.lttng2.control.ui.views.model.ITraceControlComponent;
  29 import org.eclipse.tracecompass.internal.lttng2.control.ui.views.property.TraceEventPropertySource;
  30 import org.eclipse.ui.views.properties.IPropertySource;
  31
  32
  33 /**
  34  * <p>
  35  * Implementation of the trace channel component.
  36  * </p>
  37  *
  38  * @author Bernd Hufmann
  39  */
  40 public class TraceEventComponent extends TraceControlComponent {
  41     // ------------------------------------------------------------------------
  42     // Constants
  43     // ------------------------------------------------------------------------
  44     /**
  45      * Path to icon file for this component (enabled state).
  46      */
  47     public static final String TRACE_EVENT_ICON_FILE_ENABLED = "icons/obj16/event_enabled.gif"; //$NON-NLS-1$
  48     /**
  49      * Path to icon file for this component (disabled state).
  50      */
  51     public static final String TRACE_EVENT_ICON_FILE_DISABLED = "icons/obj16/event_disabled.gif"; //$NON-NLS-1$
  52
  53     // ------------------------------------------------------------------------
  54     // Attributes
  55     // ------------------------------------------------------------------------
  56     /**
  57      * The event information.
  58      */
  59     protected IEventInfo fEventInfo = null;
  60     /**
  61      * The image to be displayed when in disabled state.
  62      */
  63     private Image fDisabledImage = null;
  64
  65     // ------------------------------------------------------------------------
  66     // Constructors
  67     // ------------------------------------------------------------------------
  68     /**
  69      * Constructor
  70      * @param name - the name of the component.
  71      * @param parent - the parent of this component.
  72      */
  73     public TraceEventComponent(String name, ITraceControlComponent parent) {
  74         super(name, parent);
  75         setImage(TRACE_EVENT_ICON_FILE_ENABLED);
  76         setToolTip(Messages.TraceControl_EventDisplayName);
  77         fEventInfo = new EventInfo(name);
  78         fDisabledImage = Activator.getDefault().loadIcon(TRACE_EVENT_ICON_FILE_DISABLED);
  79     }
  80
  81     // ------------------------------------------------------------------------
  82     // Accessors
  83     // ------------------------------------------------------------------------
  84
  85     @Override
  86     public Image getImage() {
  87         if (fEventInfo.getState() == TraceEnablement.DISABLED) {
  88             return fDisabledImage;
  89         }
  90         return super.getImage();
  91     }
  92
  93     /**
  94      * Sets the event information.
  95      * @param eventInfo - the event information to set.
  96      */
  97     public void setEventInfo(IEventInfo eventInfo) {
  98         fEventInfo = eventInfo;
  99     }
 100
 101     /**
 102      * @return the trace event type
 103      */
 104     public TraceEventType getEventType() {
 105         return fEventInfo.getEventType();
 106     }
 107
 108     /**
 109      * Sets the trace event type to the given type
 110      * @param type - type to set
 111      */
 112     public void setEventType(TraceEventType type) {
 113         fEventInfo.setEventType(type);
 114     }
 115
 116     /**
 117      * Sets the trace event type to the type specified by the given name.
 118      * @param typeName - event type name
 119      */
 120     public void setEventType(String typeName) {
 121         fEventInfo.setEventType(typeName);
 122     }
 123
 124     /**
 125      * @return the event state (enabled or disabled).
 126      */
 127     public TraceEnablement getState() {
 128         return fEventInfo.getState();
 129     }
 130
 131     /**
 132      * Sets the event state (enablement) to the given value.
 133      * @param state - state to set.
 134      */
 135     public void setState(TraceEnablement state) {
 136         fEventInfo.setState(state);
 137     }
 138
 139     /**
 140      * Sets the event state (enablement) to the value specified by the given name.
 141      * @param stateName - state to set.
 142      */
 143     public void setState(String stateName) {
 144         fEventInfo.setState(stateName);
 145     }
 146
 147     /**
 148      * @return the trace event log level
 149      */
 150     public TraceLogLevel getLogLevel() {
 151         return fEventInfo.getLogLevel();
 152     }
 153
 154     /**
 155      * Sets the trace event log level to the given level
 156      * @param level - event log level to set
 157      */
 158     public void setLogLevel(TraceLogLevel level) {
 159         fEventInfo.setLogLevel(level);
 160     }
 161
 162     /**
 163      * Sets the trace event log level to the level specified by the given name.
 164      * @param levelName - event log level name
 165      */
 166     public void setLogLevel(String levelName) {
 167         fEventInfo.setLogLevel(levelName);
 168     }
 169
 170     /**
 171      * Returns filter expression.
 172      * @return filter expression
 173      */
 174     public String getFilterExpression() {
 175         return fEventInfo.getFilterExpression();
 176     }
 177
 178     /**
 179      * Sets the filter expression.
 180      * @param filter The filter expression to set
 181      */
 182     public void setFilterExpression(String filter) {
 183         fEventInfo.setFilterExpression(filter);
 184     }
 185
 186     /**
 187      * Returns excluded events.
 188      * @return excluded events
 189      */
 190     public String getExcludedEvents() {
 191         return fEventInfo.getExcludedEvents();
 192     }
 193
 194     /**
 195      * Sets the excluded events.
 196      * @param events The excluded events to set
 197      */
 198     public void setExcludedEvents(String events) {
 199         fEventInfo.setExcludedEvents(events);
 200     }
 201
 202     /**
 203      * Returns the log level type
 204      * @return event log level type
 205      */
 206     public LogLevelType getLogLevelType() {
 207         return fEventInfo.getLogLevelType();
 208     }
 209
 210     /**
 211      * Sets the trace event log level type to the given level type
 212      * @param levelType - event log level type to set
 213      */
 214     public void setLogLevelType(LogLevelType levelType) {
 215         fEventInfo.setLogLevelType(levelType);
 216     }
 217
 218     @Override
 219     public <T> T getAdapter(Class<T> adapter) {
 220         if (adapter == IPropertySource.class) {
 221             return adapter.cast(new TraceEventPropertySource(this));
 222         }
 223         return null;
 224     }
 225
 226     /**
 227      * @return target node component.
 228      */
 229     public TargetNodeComponent getTargetNode() {
 230         return ((TraceChannelComponent)getParent()).getTargetNode();
 231     }
 232
 233     /**
 234      * @return session name from parent
 235      */
 236     public String getSessionName() {
 237        return ((TraceChannelComponent)getParent()).getSessionName();
 238     }
 239
 240     /**
 241      * @return session from parent
 242      */
 243     public TraceSessionComponent getSession() {
 244        return ((TraceChannelComponent)getParent()).getSession();
 245     }
 246
 247     /**
 248      * @return channel name from parent
 249      */
 250     public String getChannelName() {
 251         return getParent().getName();
 252     }
 253
 254     /**
 255      * @return if domain is kernel or UST
 256      */
 257     public boolean isKernel() {
 258         return ((TraceChannelComponent)getParent()).isKernel();
 259     }
 260
 261     // ------------------------------------------------------------------------
 262     // Operations
 263     // ------------------------------------------------------------------------
 264
 265     /**
 266      * Add contexts to given channels and or events
 267      *
 268      * @param contexts
 269      *            - a list of contexts to add
 270      * @param monitor
 271      *            - a progress monitor
 272      * @throws ExecutionException
 273      *             If the command fails
 274      */
 275     public void addContexts(List<String> contexts, IProgressMonitor monitor)
 276             throws ExecutionException {
 277         getControlService().addContexts(getSessionName(), getChannelName(),
 278                 getName(), isKernel(), contexts, monitor);
 279     }
 280 }