org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/model/TmfExperimentElement.java

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