1 /*******************************************************************************
2 * Copyright (c) 2012 Ericsson
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
10 * Francois Chouinard - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.core
.event
;
16 * <b><u>ITmfEventType</u></b>
18 * The TMF event event type. It contains a reference to the full field structure
19 * for that event type.
21 * Types are unique within their context space.
23 public interface ITmfEventType
extends Cloneable
{
25 // ------------------------------------------------------------------------
27 // ------------------------------------------------------------------------
30 * The default event type content
32 public static final String DEFAULT_CONTEXT_ID
= "TmfContext"; //$NON-NLS-1$
35 * The default event type name
37 public static final String DEFAULT_TYPE_ID
= "TmfType"; //$NON-NLS-1$
39 // ------------------------------------------------------------------------
41 // ------------------------------------------------------------------------
44 * @return the event type context
46 public String
getContext();
49 * @return the event type ID
51 public String
getName();
54 * @return the event type root field
56 public ITmfEventField
getRootField();
59 * @return the event field names (labels)
61 public String
[] getFieldNames();
64 * @param index the event field index
65 * @return the corresponding event field label
67 public String
getFieldName(int index
);
69 // ------------------------------------------------------------------------
71 // ------------------------------------------------------------------------
74 * @return a clone of the event content
76 public ITmfEventType
clone();