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

   1 /*******************************************************************************
   2  * Copyright (c) 2012, 2013 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 import java.util.Collection;
  16
  17 /**
  18  * The generic event type in TMF. 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  * @version 1.0
  24  * @author Francois Chouinard
  25  *
  26  * @see ITmfEvent
  27  * @see ITmfEventField
  28  */
  29 public interface ITmfEventType {
  30
  31     // ------------------------------------------------------------------------
  32     // Constants
  33     // ------------------------------------------------------------------------
  34
  35     /**
  36      * The default event type content
  37      */
  38     public static final String DEFAULT_CONTEXT_ID = "TmfContext"; //$NON-NLS-1$
  39
  40     /**
  41      * The default event type name
  42      */
  43     public static final String DEFAULT_TYPE_ID = "TmfType"; //$NON-NLS-1$
  44
  45     // ------------------------------------------------------------------------
  46     // Getters
  47     // ------------------------------------------------------------------------
  48
  49     /**
  50      * @return the event type context
  51      */
  52     String getContext();
  53
  54     /**
  55      * @return the event type ID
  56      */
  57     String getName();
  58
  59     /**
  60      * @return the event type root field
  61      */
  62     ITmfEventField getRootField();
  63
  64     /**
  65      * @return the event field names (labels)
  66      * @since 3.0
  67      */
  68     Collection<String> getFieldNames();
  69 }