/*******************************************************************************
- * Copyright (c) 2010, 2011 Ericsson
+ * Copyright (c) 2010, 2013 Ericsson, École Polytechnique de Montréal
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
*
* Contributors:
* Francois Chouinard - Initial API and implementation
+ * Bernd Hufmann - Added supplementary files handling
+ * Geneviève Bastien - Moved supplementary files handling to parent class, added
+ * code to copy trace
*******************************************************************************/
package org.eclipse.linuxtools.tmf.ui.project.model;
+import java.io.ByteArrayInputStream;
+import java.io.InputStream;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
+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.core.runtime.IConfigurationElement;
-import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Platform;
import org.eclipse.linuxtools.internal.tmf.ui.Activator;
import org.eclipse.linuxtools.internal.tmf.ui.parsers.custom.CustomTxtEvent;
import org.eclipse.linuxtools.tmf.core.TmfCommonConstants;
import org.eclipse.linuxtools.tmf.core.event.ITmfEvent;
import org.eclipse.linuxtools.tmf.core.trace.ITmfTrace;
+import org.eclipse.linuxtools.tmf.core.trace.TmfTrace;
+import org.eclipse.linuxtools.tmf.core.util.ReadOnlyTextPropertyDescriptor;
import org.eclipse.linuxtools.tmf.ui.editors.TmfEventsEditor;
import org.eclipse.ui.IActionFilter;
import org.eclipse.ui.views.properties.IPropertyDescriptor;
import org.eclipse.ui.views.properties.IPropertySource2;
-import org.eclipse.ui.views.properties.TextPropertyDescriptor;
/**
- * <b><u>TmfTraceElement</u></b>
- * <p>
+ * Implementation of trace model element representing a trace. It provides methods to instantiate
+ * <code>ITmfTrace</code> and <code>ITmfEvent</code> as well as editor ID from the trace type
+ * extension definition.
+ *
+ * @version 1.0
+ * @author Francois Chouinard
*/
-public class TmfTraceElement extends TmfProjectModelElement implements IActionFilter, IPropertySource2 {
+public class TmfTraceElement extends TmfWithFolderElement implements IActionFilter, IPropertySource2 {
// ------------------------------------------------------------------------
// Constants
// ------------------------------------------------------------------------
// Other attributes
+ /**
+ * Bundle attribute name
+ */
public static final String BUNDLE = "bundle"; //$NON-NLS-1$
+ /**
+ * IsLinked attribute name.
+ */
public static final String IS_LINKED = "isLinked"; //$NON-NLS-1$
// Property View stuff
private static final String sfEventType = "type"; //$NON-NLS-1$
private static final String sfIsLinked = "linked"; //$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 TextPropertyDescriptor sfTypeDescriptor = new TextPropertyDescriptor(sfEventType, sfEventType);
- private static final TextPropertyDescriptor sfIsLinkedDescriptor = new TextPropertyDescriptor(sfIsLinked, sfIsLinked);
+ private static final ReadOnlyTextPropertyDescriptor sfNameDescriptor = new ReadOnlyTextPropertyDescriptor(sfName, sfName);
+ private static final ReadOnlyTextPropertyDescriptor sfPathDescriptor = new ReadOnlyTextPropertyDescriptor(sfPath, sfPath);
+ private static final ReadOnlyTextPropertyDescriptor sfLocationDescriptor = new ReadOnlyTextPropertyDescriptor(sfLocation, sfLocation);
+ private static final ReadOnlyTextPropertyDescriptor sfTypeDescriptor = new ReadOnlyTextPropertyDescriptor(sfEventType, sfEventType);
+ private static final ReadOnlyTextPropertyDescriptor sfIsLinkedDescriptor = new ReadOnlyTextPropertyDescriptor(sfIsLinked, sfIsLinked);
private static final IPropertyDescriptor[] sfDescriptors = { sfNameDescriptor, sfPathDescriptor, sfLocationDescriptor,
sfTypeDescriptor, sfIsLinkedDescriptor };
sfTypeDescriptor.setCategory(sfInfoCategory);
sfIsLinkedDescriptor.setCategory(sfInfoCategory);
}
-
+
+ private static final String BOOKMARKS_HIDDEN_FILE = ".bookmarks"; //$NON-NLS-1$
+
// ------------------------------------------------------------------------
// Attributes
// ------------------------------------------------------------------------
private static final Map<String, IConfigurationElement> sfTraceTypeAttributes = new HashMap<String, IConfigurationElement>();
private static final Map<String, IConfigurationElement> sfTraceCategories = new HashMap<String, IConfigurationElement>();
- // Initialize statically at startup
+ /**
+ * Initialize statically at startup by getting extensions from the platform extension registry.
+ */
public static void init() {
IConfigurationElement[] config = Platform.getExtensionRegistry().getConfigurationElementsFor(TmfTraceType.TMF_TRACE_TYPE_ID);
for (IConfigurationElement ce : config) {
// ------------------------------------------------------------------------
// Constructors
// ------------------------------------------------------------------------
-
+ /**
+ * Constructor.
+ * Creates trace model element under the trace folder.
+ * @param name The name of trace
+ * @param trace The trace resource.
+ * @param parent The parent element (trace folder)
+ */
public TmfTraceElement(String name, IResource trace, TmfTraceFolder parent) {
this(name, trace, (TmfProjectModelElement) parent);
}
-
+ /**
+ * Constructor.
+ * Creates trace model element under the experiment folder.
+ * @param name The name of trace
+ * @param trace The trace resource.
+ * @param parent The parent element (experiment folder)
+ */
public TmfTraceElement(String name, IResource trace, TmfExperimentElement parent) {
this(name, trace, (TmfProjectModelElement) parent);
}
// ------------------------------------------------------------------------
// Operations
// ------------------------------------------------------------------------
-
+ /**
+ * Returns the trace type ID.
+ * @return trace type ID.
+ */
public String getTraceType() {
return fTraceTypeId;
}
+ /**
+ * Refreshes the trace type filed by reading the trace type persistent property of the resource
+ * referenece.
+ */
public void refreshTraceType() {
try {
fTraceTypeId = getResource().getPersistentProperty(TmfCommonConstants.TRACETYPE);
}
}
- public ITmfTrace<?> instantiateTrace() {
+ /**
+ * Instantiate a <code>ITmfTrace</code> object based on the trace type and the corresponding extension.
+ *
+ * @return the <code>ITmfTrace</code> or <code>null</code> for an error
+ */
+ public ITmfTrace instantiateTrace() {
try {
// make sure that supplementary folder exists
}
}
IConfigurationElement ce = sfTraceTypeAttributes.get(fTraceTypeId);
- ITmfTrace<?> trace = (ITmfTrace<?>) ce.createExecutableExtension(TmfTraceType.TRACE_TYPE_ATTR);
+ ITmfTrace trace = (ITmfTrace) ce.createExecutableExtension(TmfTraceType.TRACE_TYPE_ATTR);
return trace;
}
} catch (CoreException e) {
return null;
}
+ /**
+ * Instantiate a <code>ITmfEvent</code> object based on the trace type and the corresponding extension.
+ *
+ * @return the <code>ITmfEvent</code> or <code>null</code> for an error
+ */
public ITmfEvent instantiateEvent() {
try {
if (fTraceTypeId != null) {
return null;
}
+ /**
+ * Returns the optional editor ID from the trace type extension.
+ * @return the editor ID or <code>null</code> if not defined.
+ */
public String getEditorId() {
if (fTraceTypeId != null) {
if (fTraceTypeId.startsWith(CustomTxtTrace.class.getCanonicalName())) {
}
/**
- * Returns the <code>TmfTraceElement</code> located under the <code>TmfTracesFolder</code>.
- *
- * @return <code>this</code> if this element is under the <code>TmfTracesFolder</code>
- * else the corresponding <code>TmfTraceElement</code> if this element is under
- * <code>TmfExperimentElement</code>.
+ * Returns the file resource used to store bookmarks after creating it if necessary.
+ * If the trace resource is a file, it is returned directly.
+ * If the trace resource is a folder, a linked file is returned.
+ * 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 TmfTraceElement getElementUnderTraceFolder() {
-
- // If trace is under an experiment, return original trace from the traces folder
- if (getParent() instanceof TmfExperimentElement) {
- for (TmfTraceElement aTrace : getProject().getTracesFolder().getTraces()) {
- if (aTrace.getName().equals(getName())) {
- return aTrace;
+ public IFile createBookmarksFile() throws CoreException {
+ IFile file = getBookmarksFile();
+ if (fResource instanceof IFolder) {
+ if (!file.exists()) {
+ final IFile bookmarksFile = getProject().getTracesFolder().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, TmfTrace.class.getCanonicalName());
}
}
- return this;
- }
-
- /**
- * Deletes the trace specific supplementary folder.
- */
- public void deleteSupplementaryFolder() {
- IFolder supplFolder = getTraceSupplementaryFolder(fResource.getName());
- if (supplFolder.exists()) {
- try {
- supplFolder.delete(true, new NullProgressMonitor());
- } catch (CoreException e) {
- Activator.getDefault().logError("Error deleting supplementary folder " + supplFolder, e); //$NON-NLS-1$
- }
- }
- }
-
- /**
- * Renames the trace specific supplementary folder according to the new trace name.
- *
- * @param newTraceName The new trace name
- */
- public void renameSupplementaryFolder(String newTraceName) {
- IFolder oldSupplFolder = getTraceSupplementaryFolder(fResource.getName());
- IFolder newSupplFolder = getTraceSupplementaryFolder(newTraceName);
-
- // Rename supplementary folder
- if (oldSupplFolder.exists()) {
- try {
- oldSupplFolder.move(newSupplFolder.getFullPath(), true, new NullProgressMonitor());
- } catch (CoreException e) {
- Activator.getDefault().logError("Error renaming supplementary folder " + oldSupplFolder, e); //$NON-NLS-1$
- }
- }
- }
-
- /**
- * Copies the trace specific supplementary folder to the new trace name.
- *
- * @param newTraceName The new trace name
- */
- public void copySupplementaryFolder(String newTraceName) {
- IFolder oldSupplFolder = getTraceSupplementaryFolder(fResource.getName());
- IFolder newSupplFolder = getTraceSupplementaryFolder(newTraceName);
-
- // copy supplementary folder
- if (oldSupplFolder.exists()) {
- try {
- oldSupplFolder.copy(newSupplFolder.getFullPath(), true, new NullProgressMonitor());
- } catch (CoreException e) {
- Activator.getDefault().logError("Error renaming supplementary folder " + oldSupplFolder, e); //$NON-NLS-1$
- }
- }
- }
-
- /**
- * Copies the trace specific supplementary folder a new folder.
- *
- * @param destination The destination folder to copy to.
- */
- public void copySupplementaryFolder(IFolder destination) {
- IFolder oldSupplFolder = getTraceSupplementaryFolder(fResource.getName());
-
- // copy supplementary folder
- if (oldSupplFolder.exists()) {
- try {
- oldSupplFolder.copy(destination.getFullPath(), true, new NullProgressMonitor());
- } catch (CoreException e) {
- Activator.getDefault().logError("Error copying supplementary folder " + oldSupplFolder, e); //$NON-NLS-1$
- }
- }
+ return file;
}
-
- /**
- * Refreshes the trace specific supplementary folder information. It creates the folder if not exists.
- * It sets the persistence property of the trace resource
- */
- public void refreshSupplementaryFolder() {
- createSupplementaryDirectory();
- }
-
- /**
- * Checks if supplementary resource exist or not.
- *
- * @return <code>true</code> if one or more files are under the trace supplementary folder
- */
- public boolean hasSupplementaryResources() {
- IResource[] resources = getSupplementaryResources();
- return (resources.length > 0);
- }
-
/**
- * Returns the supplementary resources under the trace supplementary folder.
- *
- * @return array of resources under the trace supplementary folder.
+ * Returns the file resource used to store bookmarks.
+ * The file may not exist.
+ * @return the bookmarks file
+ * @since 2.0
*/
- public IResource[] getSupplementaryResources() {
- IFolder supplFolder = getTraceSupplementaryFolder(fResource.getName());
- if (supplFolder.exists()) {
- try {
- return supplFolder.members();
- } catch (CoreException e) {
- Activator.getDefault().logError("Error deleting supplementary folder " + supplFolder, e); //$NON-NLS-1$
- }
+ public IFile getBookmarksFile() {
+ IFile file = null;
+ if (fResource instanceof IFile) {
+ file = (IFile) fResource;
+ } else if (fResource instanceof IFolder) {
+ final IFolder folder = (IFolder) fResource;
+ file = folder.getFile(getName() + '_');
}
- return new IResource[0];
+ return file;
}
/**
- * Deletes the given resources.
- *
- * @param resources array of resources to delete.
+ * Returns the <code>TmfTraceElement</code> located under the <code>TmfTracesFolder</code>.
+ *
+ * @return <code>this</code> if this element is under the <code>TmfTracesFolder</code>
+ * else the corresponding <code>TmfTraceElement</code> if this element is under
+ * <code>TmfExperimentElement</code>.
*/
- public void deleteSupplementaryResources(IResource[] resources) {
-
- for (int i = 0; i < resources.length; i++) {
- try {
- resources[i].delete(true, new NullProgressMonitor());
- } catch (CoreException e) {
- Activator.getDefault().logError("Error deleting supplementary resource " + resources[i], e); //$NON-NLS-1$
- }
- }
- }
+ public TmfTraceElement getElementUnderTraceFolder() {
- private void createSupplementaryDirectory() {
- IFolder supplFolder = getTraceSupplementaryFolder(fResource.getName());
- if (!supplFolder.exists()) {
- try {
- supplFolder.create(true, true, new NullProgressMonitor());
- } catch (CoreException e) {
- Activator.getDefault().logError("Error creating resource supplementary file " + supplFolder, e); //$NON-NLS-1$
+ // If trace is under an experiment, return original trace from the traces folder
+ if (getParent() instanceof TmfExperimentElement) {
+ for (TmfTraceElement aTrace : getProject().getTracesFolder().getTraces()) {
+ if (aTrace.getName().equals(getName())) {
+ return aTrace;
+ }
}
}
-
- try {
- fResource.setPersistentProperty(TmfCommonConstants.TRACE_SUPPLEMENTARY_FOLDER, supplFolder.getLocationURI().getPath());
- } catch (CoreException e) {
- Activator.getDefault().logError("Error setting persistant property " + TmfCommonConstants.TRACE_SUPPLEMENTARY_FOLDER, e); //$NON-NLS-1$
- }
-
+ return this;
}
// ------------------------------------------------------------------------
@Override
public IPropertyDescriptor[] getPropertyDescriptors() {
- return (sfDescriptors != null) ? Arrays.copyOf(sfDescriptors, sfDescriptors.length) : null;
+ return Arrays.copyOf(sfDescriptors, sfDescriptors.length);
}
@Override
return null;
}
- private String getCategory(IConfigurationElement ce) {
+ private static String getCategory(IConfigurationElement ce) {
String categoryId = ce.getAttribute(TmfTraceType.CATEGORY_ATTR);
if (categoryId != null) {
IConfigurationElement category = sfTraceCategories.get(categoryId);
return false;
}
+ /**
+ * Copy this trace in the trace folder. No other parameters are mentioned so
+ * the trace is copied in this element's project trace folder
+ *
+ * @param string
+ * The new trace name
+ * @return the new Resource object
+ * @since 2.0
+ */
+ public TmfTraceElement copy(String string) {
+ TmfTraceFolder folder = this.getProject().getTracesFolder();
+ IResource res = super.copy(string, false);
+ return new TmfTraceElement(string, res, folder);
+ }
+
}