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