tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/event/ITmfEventType.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012, 2014 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.tracecompass.tmf.core.event;
  14
  15 import java.util.Collection;
  16
  17 import org.eclipse.jdt.annotation.NonNull;
  18
  19 /**
  20  * The generic event type in TMF. It contains a reference to the full field structure
  21  * for that event type.
  22  * <p>
  23  * Types are unique within their context space.
  24  *
  25  * @version 1.0
  26  * @author Francois Chouinard
  27  *
  28  * @see ITmfEvent
  29  * @see ITmfEventField
  30  */
  31 public interface ITmfEventType {
  32
  33     // ------------------------------------------------------------------------
  34     // Constants
  35     // ------------------------------------------------------------------------
  36
  37     /**
  38      * The default event type name
  39      */
  40     @NonNull String DEFAULT_TYPE_ID = "TmfType"; //$NON-NLS-1$
  41
  42     // ------------------------------------------------------------------------
  43     // Getters
  44     // ------------------------------------------------------------------------
  45
  46     /**
  47      * @return the event type ID
  48      */
  49     @NonNull String getName();
  50
  51     /**
  52      * @return the event type root field
  53      */
  54     ITmfEventField getRootField();
  55
  56     /**
  57      * @return the event field names (labels)
  58      */
  59     Collection<String> getFieldNames();
  60 }