org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/event/ITmfEventType.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 /**
  16  * The generic event type in TMF. It contains a reference to the full field structure
  17  * for that event type.
  18  * <p>
  19  * Types are unique within their context space.
  20  *
  21  * @version 1.0
  22  * @author Francois Chouinard
  23  *
  24  * @see ITmfEvent
  25  * @see ITmfEventField
  26  */
  27 public interface ITmfEventType {
  28
  29     // ------------------------------------------------------------------------
  30     // Constants
  31     // ------------------------------------------------------------------------
  32
  33     /**
  34      * The default event type content
  35      */
  36     public static final String DEFAULT_CONTEXT_ID = "TmfContext"; //$NON-NLS-1$
  37
  38     /**
  39      * The default event type name
  40      */
  41     public static final String DEFAULT_TYPE_ID = "TmfType"; //$NON-NLS-1$
  42
  43     // ------------------------------------------------------------------------
  44     // Getters
  45     // ------------------------------------------------------------------------
  46
  47     /**
  48      * @return the event type context
  49      */
  50     public String getContext();
  51
  52     /**
  53      * @return the event type ID
  54      */
  55     public String getName();
  56
  57     /**
  58      * @return the event type root field
  59      */
  60     public ITmfEventField getRootField();
  61
  62     /**
  63      * @return the event field names (labels)
  64      */
  65     public String[] getFieldNames();
  66
  67     /**
  68      * @param index the event field index
  69      * @return the corresponding event field label
  70      */
  71     public String getFieldName(int index);
  72
  73     /**
  74      * @return a clone of the event type
  75      */
  76     public ITmfEventType clone();
  77
  78 }