1 /*******************************************************************************
2 * Copyright (c) 2012, 2014 Ericsson
4 * All rights reserved. This program and the accompanying materials are made
5 * 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 * Patrick Tasse - Initial API and implementation
11 * Bernd Hufmann - Added call site and model URI properties
12 *******************************************************************************/
14 package org
.eclipse
.tracecompass
.tmf
.ui
.viewers
.events
;
16 import java
.util
.ArrayList
;
17 import java
.util
.List
;
19 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfCustomAttributes
;
20 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
21 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEventField
;
22 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.ITmfModelLookup
;
23 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.ITmfSourceLookup
;
24 import org
.eclipse
.tracecompass
.tmf
.core
.timestamp
.ITmfTimestamp
;
25 import org
.eclipse
.tracecompass
.tmf
.ui
.properties
.ReadOnlyTextPropertyDescriptor
;
26 import org
.eclipse
.ui
.views
.properties
.IPropertyDescriptor
;
27 import org
.eclipse
.ui
.views
.properties
.IPropertySource
;
30 * Property source for events
32 public class TmfEventPropertySource
implements IPropertySource
{
34 private static final String ID_TIMESTAMP
= "event_timestamp"; //$NON-NLS-1$
35 private static final String ID_TYPE
= "event_type"; //$NON-NLS-1$
36 private static final String ID_TRACE
= "trace_attribute"; //$NON-NLS-1$
37 private static final String ID_CONTENT
= "event_content"; //$NON-NLS-1$
38 private static final String ID_SOURCE_LOOKUP
= "event_lookup"; //$NON-NLS-1$
39 private static final String ID_MODEL_URI
= "model_uri"; //$NON-NLS-1$
40 private static final String ID_CUSTOM_ATTRIBUTE
= "custom_attribute"; //$NON-NLS-1$
42 private static final String NAME_TIMESTAMP
= "Timestamp"; //$NON-NLS-1$
43 private static final String NAME_TYPE
= "Type"; //$NON-NLS-1$
44 private static final String NAME_TRACE
= "Trace"; //$NON-NLS-1$
45 private static final String NAME_CONTENT
= "Content"; //$NON-NLS-1$
46 private static final String NAME_SOURCE_LOOKUP
= "Source Lookup"; //$NON-NLS-1$
47 private static final String NAME_MODEL_URI
= "Model URI"; //$NON-NLS-1$
48 private static final String NAME_CUSTOM_ATTRIBUTES
= "Custom Attributes"; //$NON-NLS-1$
50 private static final String EMPTY_STRING
= ""; //$NON-NLS-1$
52 private ITmfEvent fEvent
;
54 private class TimestampPropertySource
implements IPropertySource
{
55 private static final String ID_TIMESTAMP_VALUE
= "timestamp_value"; //$NON-NLS-1$
56 private static final String ID_TIMESTAMP_SCALE
= "timestamp_scale"; //$NON-NLS-1$
57 private static final String NAME_TIMESTAMP_VALUE
= "value"; //$NON-NLS-1$
58 private static final String NAME_TIMESTAMP_SCALE
= "scale"; //$NON-NLS-1$
60 private ITmfTimestamp fTimestamp
;
62 public TimestampPropertySource(ITmfTimestamp timestamp
) {
63 fTimestamp
= timestamp
;
67 public Object
getEditableValue() {
68 return fTimestamp
.toString();
72 public IPropertyDescriptor
[] getPropertyDescriptors() {
73 IPropertyDescriptor
[] descriptors
= new IPropertyDescriptor
[2];
74 descriptors
[0] = new ReadOnlyTextPropertyDescriptor(ID_TIMESTAMP_VALUE
, NAME_TIMESTAMP_VALUE
);
75 descriptors
[1] = new ReadOnlyTextPropertyDescriptor(ID_TIMESTAMP_SCALE
, NAME_TIMESTAMP_SCALE
);
80 public Object
getPropertyValue(Object id
) {
81 if (id
.equals(ID_TIMESTAMP_VALUE
)) {
82 return Long
.toString(fTimestamp
.getValue());
83 } else if (id
.equals(ID_TIMESTAMP_SCALE
)) {
84 return Integer
.toString(fTimestamp
.getScale());
90 public boolean isPropertySet(Object id
) {
95 public void resetPropertyValue(Object id
) {
99 public void setPropertyValue(Object id
, Object value
) {
103 private class ContentPropertySource
implements IPropertySource
{
104 private ITmfEventField fContent
;
106 public ContentPropertySource(ITmfEventField content
) {
111 public Object
getEditableValue() {
112 return fContent
.toString();
116 public IPropertyDescriptor
[] getPropertyDescriptors() {
117 List
<IPropertyDescriptor
> descriptors
= new ArrayList
<>(fContent
.getFields().size());
118 for (ITmfEventField field
: fContent
.getFields()) {
120 descriptors
.add(new ReadOnlyTextPropertyDescriptor(field
, field
.getName()));
123 return descriptors
.toArray(new IPropertyDescriptor
[0]);
127 public Object
getPropertyValue(Object id
) {
128 ITmfEventField field
= (ITmfEventField
) id
;
129 if (field
.getFields() != null && field
.getFields().size() > 0) {
130 return new ContentPropertySource(field
);
132 return field
.getFormattedValue();
136 public boolean isPropertySet(Object id
) {
141 public void resetPropertyValue(Object id
) {
145 public void setPropertyValue(Object id
, Object value
) {
149 private class SourceLookupPropertySource
implements IPropertySource
{
151 private static final String ID_FILE_NAME
= "callsite_file"; //$NON-NLS-1$
152 private static final String ID_FUNCTION_NAME
= "callsite_function"; //$NON-NLS-1$
153 private static final String ID_LINE_NUMBER
= "callsite_line"; //$NON-NLS-1$
155 private static final String NAME_FILE_NAME
= "File"; //$NON-NLS-1$
156 private static final String NAME_FUNCTION_NAME
= "Function"; //$NON-NLS-1$
157 private static final String NAME_LINE_NUMBER
= "Line"; //$NON-NLS-1$
159 private final ITmfSourceLookup fSourceLookup
;
161 public SourceLookupPropertySource(ITmfSourceLookup lookup
) {
162 fSourceLookup
= lookup
;
166 public Object
getEditableValue() {
167 if (fSourceLookup
.getCallsite() != null) {
168 return fSourceLookup
.getCallsite().toString();
174 public IPropertyDescriptor
[] getPropertyDescriptors() {
175 List
<IPropertyDescriptor
> descriptors
= new ArrayList
<>();
176 if (fSourceLookup
.getCallsite() != null) {
177 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_FILE_NAME
, NAME_FILE_NAME
));
178 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_LINE_NUMBER
, NAME_LINE_NUMBER
));
179 // only display function if available
180 if (fSourceLookup
.getCallsite().getFunctionName() != null) {
181 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_FUNCTION_NAME
, NAME_FUNCTION_NAME
));
184 return descriptors
.toArray(new IPropertyDescriptor
[0]);
188 public Object
getPropertyValue(Object id
) {
189 if (id
.equals(ID_FILE_NAME
)) {
190 return fSourceLookup
.getCallsite().getFileName();
191 } else if (id
.equals(ID_FUNCTION_NAME
)) {
192 return fSourceLookup
.getCallsite().getFunctionName();
193 } else if (id
.equals(ID_LINE_NUMBER
)) {
194 return Long
.valueOf(fSourceLookup
.getCallsite().getLineNumber());
200 public boolean isPropertySet(Object id
) {
205 public void resetPropertyValue(Object id
) {
210 public void setPropertyValue(Object id
, Object value
) {
214 private class CustomAttributePropertySource
implements IPropertySource
{
216 private final ITmfCustomAttributes event
;
218 public CustomAttributePropertySource(ITmfCustomAttributes event
) {
223 public Object
getEditableValue() {
228 public IPropertyDescriptor
[] getPropertyDescriptors() {
229 List
<IPropertyDescriptor
> descriptors
= new ArrayList
<>();
231 for (String customAttribute
: event
.listCustomAttributes()) {
232 descriptors
.add(new ReadOnlyTextPropertyDescriptor(customAttribute
, customAttribute
));
235 return descriptors
.toArray(new IPropertyDescriptor
[0]);
239 public Object
getPropertyValue(Object id
) {
240 return event
.getCustomAttribute((String
) id
);
244 public boolean isPropertySet(Object id
) {
249 public void resetPropertyValue(Object id
) {
253 public void setPropertyValue(Object id
, Object value
) {
258 * Default constructor
260 * @param event the event
262 public TmfEventPropertySource(ITmfEvent event
) {
268 public Object
getEditableValue() {
273 public IPropertyDescriptor
[] getPropertyDescriptors() {
274 List
<IPropertyDescriptor
> descriptors
= new ArrayList
<>();
276 /* Display basic event information */
277 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_TIMESTAMP
, NAME_TIMESTAMP
));
278 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_TYPE
, NAME_TYPE
));
279 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_TRACE
, NAME_TRACE
));
281 /* Display event fields */
282 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_CONTENT
, NAME_CONTENT
));
284 /* Display source lookup information, if the event supplies it */
285 if ((fEvent
instanceof ITmfSourceLookup
) && (((ITmfSourceLookup
)fEvent
).getCallsite() != null)) {
286 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_SOURCE_LOOKUP
, NAME_SOURCE_LOOKUP
));
289 /* Display Model URI information, if the event supplies it */
290 if ((fEvent
instanceof ITmfModelLookup
) && (((ITmfModelLookup
) fEvent
).getModelUri() != null)) {
291 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_MODEL_URI
, NAME_MODEL_URI
));
294 /* Display custom attributes, if available */
295 if (fEvent
instanceof ITmfCustomAttributes
) {
296 ITmfCustomAttributes event
= (ITmfCustomAttributes
) fEvent
;
297 if (event
.listCustomAttributes() != null && !event
.listCustomAttributes().isEmpty()) {
298 descriptors
.add(new ReadOnlyTextPropertyDescriptor(ID_CUSTOM_ATTRIBUTE
, NAME_CUSTOM_ATTRIBUTES
));
302 return descriptors
.toArray(new IPropertyDescriptor
[0]);
306 public Object
getPropertyValue(Object id
) {
307 if (id
.equals(ID_TIMESTAMP
)) {
308 return new TimestampPropertySource(fEvent
.getTimestamp());
309 } else if (id
.equals(ID_TYPE
) && fEvent
.getType() != null) {
310 return fEvent
.getType().toString();
311 } else if (id
.equals(ID_TRACE
)) {
312 return fEvent
.getTrace().getName();
313 } else if (id
.equals(ID_MODEL_URI
)) {
314 return ((ITmfModelLookup
)fEvent
).getModelUri();
315 } else if (id
.equals(ID_SOURCE_LOOKUP
)) {
316 return new SourceLookupPropertySource(((ITmfSourceLookup
)fEvent
));
317 } else if (id
.equals(ID_CONTENT
) && fEvent
.getContent() != null) {
318 return new ContentPropertySource(fEvent
.getContent());
319 } else if (id
.equals(ID_CUSTOM_ATTRIBUTE
)) {
320 return new CustomAttributePropertySource((ITmfCustomAttributes
) fEvent
);
326 public boolean isPropertySet(Object id
) {
331 public void resetPropertyValue(Object id
) {
335 public void setPropertyValue(Object id
, Object value
) {