org.eclipse.linuxtools.lttng.core/src/org/eclipse/linuxtools/internal/lttng/core/request/ILttngSyntEventRequest.java

   1 /*******************************************************************************
   2  * Copyright (c) 20010 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  *   Alvaro Sanchez-Leon (alvsan09@gmail.com) - Initial API and implementation
  11  *******************************************************************************/
  12 package org.eclipse.linuxtools.internal.lttng.core.request;
  13
  14 import org.eclipse.linuxtools.tmf.core.component.TmfEventProvider;
  15 import org.eclipse.linuxtools.tmf.core.event.TmfTimeRange;
  16 import org.eclipse.linuxtools.tmf.core.request.ITmfDataRequest;
  17
  18 public interface ILttngSyntEventRequest extends ITmfDataRequest {
  19
  20         /**
  21          * Trigger the start to process this request right after the notification to
  22          * the interested listeners
  23          *
  24          * @param provider
  25          * @param broadcast
  26          *            true: All views, false: only to registered listeners
  27          */
  28         public abstract void startRequestInd(
  29                         TmfEventProvider provider);
  30
  31         /**
  32          * to be called by the handleCompletion in superclass method, notifies the
  33          * interested listeners. i.e. if the request start indicated broadcast, the
  34          * completion will also be broadcasted otherwise only registered listeners
  35          * will be notified.
  36          */
  37         public abstract void notifyCompletion();
  38
  39         public abstract void notifyStarting();
  40
  41         public abstract TmfTimeRange getExperimentTimeRange();
  42
  43         /**
  44          * @param numOfEvents
  45          *            the numOfEvents to set
  46          */
  47         public abstract void setSynEventCount(Long numOfEvents);
  48
  49         /**
  50          * @return the numOfEvents
  51          */
  52         public abstract Long getSynEventCount();
  53
  54         /**
  55          * @param clearAllData
  56          *            indicates the need to clear all previous data e.g. a new
  57          *            experiment selection
  58          */
  59         public abstract void setclearDataInd(boolean clearAllData);
  60
  61         /**
  62          * Returns indication - clearing of all existing data model is required e.g
  63          * from the selection of a new experiment
  64          *
  65          * @return
  66          */
  67         public abstract boolean isclearDataInd();
  68
  69         /**
  70          * @return <p>
  71          *         The associated source of the request
  72          *         </p>
  73          *         <p>
  74          *         Returns null if no source object has been previously set
  75          *         </p>
  76          *
  77          */
  78         public abstract Object getSource();
  79
  80         /**
  81          * Sets a reference to the source of this request
  82          *
  83          * @param source
  84          */
  85         public abstract void setSource(Object source);
  86
  87
  88         /**
  89          * Return the time range associated to this request
  90          *
  91          * @return
  92          */
  93         public abstract TmfTimeRange getRange();
  94
  95         public abstract String getExperimentName();
  96
  97 }