Commit | Line | Data |
---|---|---|
5179fc01 | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2012, 2014 Ericsson |
568007fa | 3 | * |
5179fc01 FC |
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 | |
568007fa | 8 | * |
5179fc01 FC |
9 | * Contributors: |
10 | * Francois Chouinard - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.tmf.core.event; |
5179fc01 | 14 | |
b742c196 AM |
15 | import java.util.Collection; |
16 | ||
df2597e0 AM |
17 | import org.eclipse.jdt.annotation.NonNull; |
18 | ||
5179fc01 | 19 | /** |
f7703ed6 | 20 | * The generic event type in TMF. It contains a reference to the full field structure |
4c564a2d FC |
21 | * for that event type. |
22 | * <p> | |
23 | * Types are unique within their context space. | |
568007fa | 24 | * |
b9e37ffd FC |
25 | * @version 1.0 |
26 | * @author Francois Chouinard | |
568007fa | 27 | * |
b9e37ffd | 28 | * @see ITmfEvent |
f7703ed6 | 29 | * @see ITmfEventField |
5179fc01 | 30 | */ |
0316808c | 31 | public interface ITmfEventType { |
5179fc01 | 32 | |
a4115405 FC |
33 | // ------------------------------------------------------------------------ |
34 | // Constants | |
35 | // ------------------------------------------------------------------------ | |
36 | ||
4c564a2d | 37 | /** |
085d898f | 38 | * The default event type name |
4c564a2d | 39 | */ |
df2597e0 | 40 | @NonNull String DEFAULT_TYPE_ID = "TmfType"; //$NON-NLS-1$ |
085d898f | 41 | |
a4115405 FC |
42 | // ------------------------------------------------------------------------ |
43 | // Getters | |
44 | // ------------------------------------------------------------------------ | |
45 | ||
5179fc01 | 46 | /** |
cbbcc354 | 47 | * @return the event type ID |
5179fc01 | 48 | */ |
df2597e0 | 49 | @NonNull String getName(); |
5179fc01 | 50 | |
5d3e8747 | 51 | /** |
4c564a2d | 52 | * @return the event type root field |
5d3e8747 | 53 | */ |
57a2a5ca | 54 | ITmfEventField getRootField(); |
5d3e8747 | 55 | |
5179fc01 | 56 | /** |
4c564a2d | 57 | * @return the event field names (labels) |
5179fc01 | 58 | */ |
b742c196 | 59 | Collection<String> getFieldNames(); |
5179fc01 | 60 | } |