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      * The default event type content
  27      */
  28     public static final String DEFAULT_CONTEXT_ID = "TmfContext"; //$NON-NLS-1$
  29
  30     /**
  31      * The default event type name
  32      */
  33     public static final String DEFAULT_TYPE_ID = "TmfType"; //$NON-NLS-1$
  34
  35     /**
  36      * @return the event type context
  37      */
  38     public String getContext();
  39
  40     /**
  41      * @return the event type ID
  42      */
  43     public String getName();
  44
  45     /**
  46      * @return the event type root field
  47      */
  48     public ITmfEventField getRootField();
  49
  50     /**
  51      * @return the event field names (labels)
  52      */
  53     public String[] getFieldNames();
  54
  55     /**
  56      * @param index the event field index
  57      * @return the corresponding event field label
  58      */
  59     public String getFieldName(int index);
  60
  61     /**
  62      * @return a clone of the event content
  63      */
  64     public ITmfEventType clone();
  65
  66 }