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