org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEvent.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012 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  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.core.event;
  14
  15 import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
  16
  17 /**
  18  * The basic event structure in TMF. In its canonical form, a data item has:
  19  * <ul>
  20  * <li> a parent trace
  21  * <li> a rank (order within the trace)
  22  * <li> a timestamp
  23  * <li> a source (reporting component)
  24  * <li> a type
  25  * <li> a content (payload)
  26  * </ul>
  27  * For convenience, a free-form reference field is also provided. It could be
  28  * used as e.g. a location marker (filename:lineno) to indicate where the event
  29  * was generated.
  30  *
  31  * @since 1.0
  32  * @version 1.0
  33  * @author Francois Chouinard
  34  *
  35  * @see ITmfTimestamp
  36  * @see ITmfEventType
  37  * @see ITmfEvetnField
  38  * @see TmfEvent
  39  */
  40 public interface ITmfEvent extends Cloneable {
  41
  42     // ------------------------------------------------------------------------
  43     // Constants
  44     // ------------------------------------------------------------------------
  45
  46     /**
  47      * Pre-defined event attributes
  48      */
  49     public static final String EVENT_FIELD_TIMESTAMP = ":timestamp:"; //$NON-NLS-1$
  50     public static final String EVENT_FIELD_SOURCE    = ":source:";    //$NON-NLS-1$
  51     public static final String EVENT_FIELD_TYPE      = ":type:";      //$NON-NLS-1$
  52     public static final String EVENT_FIELD_CONTENT   = ":content:";   //$NON-NLS-1$
  53     public static final String EVENT_FIELD_REFERENCE = ":reference:"; //$NON-NLS-1$
  54
  55     // ------------------------------------------------------------------------
  56     // Getters
  57     // ------------------------------------------------------------------------
  58
  59     /**
  60      * @return the trace that 'owns' the event
  61      */
  62     public ITmfTrace<?> getTrace();
  63
  64     /**
  65      * @return the event rank within the parent trace
  66      */
  67     public long getRank();
  68
  69     /**
  70      * @return the event timestamp
  71      */
  72     public ITmfTimestamp getTimestamp();
  73
  74     /**
  75      * @return the event source
  76      */
  77     public String getSource();
  78
  79     /**
  80      * @return the event type
  81      */
  82     public ITmfEventType getType();
  83
  84     /**
  85      * @return the event content
  86      */
  87     public ITmfEventField getContent();
  88
  89     /**
  90      * @return the event reference
  91      */
  92     public String getReference();
  93
  94     // ------------------------------------------------------------------------
  95     // Cloneable
  96     // ------------------------------------------------------------------------
  97
  98     /**
  99      * @return a clone of the event
 100      */
 101     public ITmfEvent clone();
 102
 103 }