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
;
17 * The TMF event event type. It contains a reference to the full field structure
18 * for that event type.
20 * Types are unique within their context space.
24 * @author Francois Chouinard
28 public interface ITmfEventType
extends Cloneable
{
30 // ------------------------------------------------------------------------
32 // ------------------------------------------------------------------------
35 * The default event type content
37 public static final String DEFAULT_CONTEXT_ID
= "TmfContext"; //$NON-NLS-1$
40 * The default event type name
42 public static final String DEFAULT_TYPE_ID
= "TmfType"; //$NON-NLS-1$
44 // ------------------------------------------------------------------------
46 // ------------------------------------------------------------------------
49 * @return the event type context
51 public String
getContext();
54 * @return the event type ID
56 public String
getName();
59 * @return the event type root field
61 public ITmfEventField
getRootField();
64 * @return the event field names (labels)
66 public String
[] getFieldNames();
69 * @param index the event field index
70 * @return the corresponding event field label
72 public String
getFieldName(int index
);
74 // ------------------------------------------------------------------------
76 // ------------------------------------------------------------------------
79 * @return a clone of the event content
81 public ITmfEventType
clone();