1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*******************************************************************************
* Copyright (c) 2010, 2013 Ericsson
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Francois Chouinard - Initial API and implementation
*******************************************************************************/
package org.eclipse.linuxtools.tmf.ui.project.model;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.linuxtools.tmf.core.TmfCommonConstants;
import org.eclipse.linuxtools.tmf.core.trace.TmfExperiment;
import org.eclipse.ui.views.properties.IPropertyDescriptor;
import org.eclipse.ui.views.properties.IPropertySource2;
import org.eclipse.ui.views.properties.TextPropertyDescriptor;
/**
* Implementation of TMF Experiment Model Element.
* <p>
* @version 1.0
* @author Francois Chouinard
*
*/
public class TmfExperimentElement extends TmfWithFolderElement implements IPropertySource2 {
// ------------------------------------------------------------------------
// Constants
// ------------------------------------------------------------------------
// Property View stuff
private static final String sfInfoCategory = "Info"; //$NON-NLS-1$
private static final String sfName = "name"; //$NON-NLS-1$
private static final String sfPath = "path"; //$NON-NLS-1$
private static final String sfLocation = "location"; //$NON-NLS-1$
private static final String sfFolderSuffix = "_exp"; //$NON-NLS-1$
private static final TextPropertyDescriptor sfNameDescriptor = new TextPropertyDescriptor(sfName, sfName);
private static final TextPropertyDescriptor sfPathDescriptor = new TextPropertyDescriptor(sfPath, sfPath);
private static final TextPropertyDescriptor sfLocationDescriptor = new TextPropertyDescriptor(sfLocation,
sfLocation);
private static final IPropertyDescriptor[] sfDescriptors = { sfNameDescriptor, sfPathDescriptor,
sfLocationDescriptor };
static {
sfNameDescriptor.setCategory(sfInfoCategory);
sfPathDescriptor.setCategory(sfInfoCategory);
sfLocationDescriptor.setCategory(sfInfoCategory);
}
private static final String BOOKMARKS_HIDDEN_FILE = ".bookmarks"; //$NON-NLS-1$
// ------------------------------------------------------------------------
// Constructors
// ------------------------------------------------------------------------
/**
* Constructor
* @param name The name of the experiment
* @param folder The folder reference
* @param parent The experiment folder reference.
*/
public TmfExperimentElement(String name, IFolder folder, TmfExperimentFolder parent) {
super(name, folder, parent);
parent.addChild(this);
}
// ------------------------------------------------------------------------
// TmfProjectModelElement
// ------------------------------------------------------------------------
/*
* (non-Javadoc)
* @see org.eclipse.linuxtools.tmf.ui.project.model.TmfProjectModelElement#getResource()
*/
@Override
public IFolder getResource() {
return (IFolder) fResource;
}
/*
* (non-Javadoc)
* @see org.eclipse.linuxtools.tmf.ui.project.model.ITmfProjectModelElement#getProject()
*/
@Override
public TmfProjectElement getProject() {
return (TmfProjectElement) getParent().getParent();
}
// ------------------------------------------------------------------------
// Operations
// ------------------------------------------------------------------------
/**
* Returns a list of TmfTraceElements contained in this experiment.
* @return a list of TmfTraceElements
*/
public List<TmfTraceElement> getTraces() {
List<ITmfProjectModelElement> children = getChildren();
List<TmfTraceElement> traces = new ArrayList<TmfTraceElement>();
for (ITmfProjectModelElement child : children) {
if (child instanceof TmfTraceElement) {
traces.add((TmfTraceElement) child);
}
}
return traces;
}
/**
* Returns the file resource used to store bookmarks after creating it if necessary.
* The file will be created if it does not exist.
* @return the bookmarks file
* @throws CoreException if the bookmarks file cannot be created
* @since 2.0
*/
public IFile createBookmarksFile() throws CoreException {
IFile file = getBookmarksFile();
if (!file.exists()) {
final IFile bookmarksFile = getProject().getExperimentsFolder().getResource().getFile(BOOKMARKS_HIDDEN_FILE);
if (!bookmarksFile.exists()) {
final InputStream source = new ByteArrayInputStream(new byte[0]);
bookmarksFile.create(source, true, null);
}
bookmarksFile.setHidden(true);
file.createLink(bookmarksFile.getLocation(), IResource.REPLACE, null);
file.setHidden(true);
file.setPersistentProperty(TmfCommonConstants.TRACETYPE, TmfExperiment.class.getCanonicalName());
}
return file;
}
/**
* Returns the file resource used to store bookmarks.
* The file may not exist.
* @return the bookmarks file
* @since 2.0
*/
public IFile getBookmarksFile() {
final IFolder folder = (IFolder) fResource;
IFile file = folder.getFile(getName() + '_');
return file;
}
// ------------------------------------------------------------------------
// IPropertySource2
// ------------------------------------------------------------------------
/*
* (non-Javadoc)
* @see org.eclipse.ui.views.properties.IPropertySource#getEditableValue()
*/
@Override
public Object getEditableValue() {
return null;
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.views.properties.IPropertySource#getPropertyDescriptors()
*/
@Override
public IPropertyDescriptor[] getPropertyDescriptors() {
return Arrays.copyOf(sfDescriptors, sfDescriptors.length);
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.views.properties.IPropertySource#getPropertyValue(java.lang.Object)
*/
@Override
public Object getPropertyValue(Object id) {
if (sfName.equals(id)) {
return getName();
}
if (sfPath.equals(id)) {
return getPath().toString();
}
if (sfLocation.equals(id)) {
return getLocation().toString();
}
return null;
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.views.properties.IPropertySource#resetPropertyValue(java.lang.Object)
*/
@Override
public void resetPropertyValue(Object id) {
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.views.properties.IPropertySource#setPropertyValue(java.lang.Object, java.lang.Object)
*/
@Override
public void setPropertyValue(Object id, Object value) {
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.views.properties.IPropertySource2#isPropertyResettable(java.lang.Object)
*/
@Override
public boolean isPropertyResettable(Object id) {
return false;
}
/*
* (non-Javadoc)
* @see org.eclipse.ui.views.properties.IPropertySource2#isPropertySet(java.lang.Object)
*/
@Override
public boolean isPropertySet(Object id) {
return false;
}
/**
* Return the suffix for resource names
* @return The folder suffix
*/
@Override
public String getSuffix() {
return sfFolderSuffix;
}
}
|
