Commit | Line | Data |
---|---|---|
5179fc01 | 1 | /******************************************************************************* |
11252342 | 2 | * Copyright (c) 2012, 2013 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 | ||
13 | package org.eclipse.linuxtools.tmf.core.event; | |
14 | ||
b742c196 AM |
15 | import java.util.Collection; |
16 | ||
5179fc01 | 17 | /** |
f7703ed6 | 18 | * The generic event type in TMF. It contains a reference to the full field structure |
4c564a2d FC |
19 | * for that event type. |
20 | * <p> | |
21 | * Types are unique within their context space. | |
568007fa | 22 | * |
b9e37ffd FC |
23 | * @version 1.0 |
24 | * @author Francois Chouinard | |
568007fa | 25 | * |
b9e37ffd | 26 | * @see ITmfEvent |
f7703ed6 | 27 | * @see ITmfEventField |
5179fc01 | 28 | */ |
0316808c | 29 | public interface ITmfEventType { |
5179fc01 | 30 | |
a4115405 FC |
31 | // ------------------------------------------------------------------------ |
32 | // Constants | |
33 | // ------------------------------------------------------------------------ | |
34 | ||
4c564a2d | 35 | /** |
085d898f | 36 | * The default event type content |
4c564a2d FC |
37 | */ |
38 | public static final String DEFAULT_CONTEXT_ID = "TmfContext"; //$NON-NLS-1$ | |
39 | ||
40 | /** | |
085d898f | 41 | * The default event type name |
4c564a2d FC |
42 | */ |
43 | public static final String DEFAULT_TYPE_ID = "TmfType"; //$NON-NLS-1$ | |
085d898f | 44 | |
a4115405 FC |
45 | // ------------------------------------------------------------------------ |
46 | // Getters | |
47 | // ------------------------------------------------------------------------ | |
48 | ||
5179fc01 FC |
49 | /** |
50 | * @return the event type context | |
51 | */ | |
57a2a5ca | 52 | String getContext(); |
5179fc01 FC |
53 | |
54 | /** | |
cbbcc354 | 55 | * @return the event type ID |
5179fc01 | 56 | */ |
57a2a5ca | 57 | String getName(); |
5179fc01 | 58 | |
5d3e8747 | 59 | /** |
4c564a2d | 60 | * @return the event type root field |
5d3e8747 | 61 | */ |
57a2a5ca | 62 | ITmfEventField getRootField(); |
5d3e8747 | 63 | |
5179fc01 | 64 | /** |
4c564a2d | 65 | * @return the event field names (labels) |
b742c196 | 66 | * @since 3.0 |
5179fc01 | 67 | */ |
b742c196 | 68 | Collection<String> getFieldNames(); |
5179fc01 | 69 | } |