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  * @since 1.0
  22  * @version 1.0
  23  * @author Francois Chouinard
  24  *
  25  * @see ITmfEvent
  26  * @see ITmfEventField
  27  */
  28 public interface ITmfEventType extends Cloneable {
  29
  30     // ------------------------------------------------------------------------
  31     // Constants
  32     // ------------------------------------------------------------------------
  33
  34     /**
  35      * The default event type content
  36      */
  37     public static final String DEFAULT_CONTEXT_ID = "TmfContext"; //$NON-NLS-1$
  38
  39     /**
  40      * The default event type name
  41      */
  42     public static final String DEFAULT_TYPE_ID = "TmfType"; //$NON-NLS-1$
  43
  44     // ------------------------------------------------------------------------
  45     // Getters
  46     // ------------------------------------------------------------------------
  47
  48     /**
  49      * @return the event type context
  50      */
  51     public String getContext();
  52
  53     /**
  54      * @return the event type ID
  55      */
  56     public String getName();
  57
  58     /**
  59      * @return the event type root field
  60      */
  61     public ITmfEventField getRootField();
  62
  63     /**
  64      * @return the event field names (labels)
  65      */
  66     public String[] getFieldNames();
  67
  68     /**
  69      * @param index the event field index
  70      * @return the corresponding event field label
  71      */
  72     public String getFieldName(int index);
  73
  74     // ------------------------------------------------------------------------
  75     // Cloneable
  76     // ------------------------------------------------------------------------
  77
  78     /**
  79      * @return a clone of the event type
  80      */
  81     public ITmfEventType clone();
  82
  83 }