tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/project/model/TmfTraceFolder.java

   1 /*******************************************************************************
   2  * Copyright (c) 2011, 2014 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  *   Patrick Tasse - Add support for folder elements
  12  *******************************************************************************/
  13
  14 package org.eclipse.tracecompass.tmf.ui.project.model;
  15
  16 import java.util.ArrayList;
  17 import java.util.Arrays;
  18 import java.util.HashMap;
  19 import java.util.List;
  20 import java.util.Map;
  21
  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.jdt.annotation.NonNull;
  26 import org.eclipse.swt.graphics.Image;
  27 import org.eclipse.tracecompass.tmf.core.project.model.TmfTraceType;
  28 import org.eclipse.tracecompass.tmf.ui.properties.ReadOnlyTextPropertyDescriptor;
  29 import org.eclipse.ui.views.properties.IPropertyDescriptor;
  30 import org.eclipse.ui.views.properties.IPropertySource2;
  31
  32 /**
  33  * Implementation of trace folder model element representing a trace folder in
  34  * the project.
  35  * <p>
  36  * @version 1.0
  37  * @author Francois Chouinard
  38  */
  39 public class TmfTraceFolder extends TmfProjectModelElement implements IPropertySource2 {
  40
  41     // ------------------------------------------------------------------------
  42     // Constants
  43     // ------------------------------------------------------------------------
  44
  45     private static final String INFO_CATEGORY = "Info"; //$NON-NLS-1$
  46     private static final String NAME = "name"; //$NON-NLS-1$
  47     private static final String PATH = "path"; //$NON-NLS-1$
  48     private static final String LOCATION = "location"; //$NON-NLS-1$
  49
  50     private static final ReadOnlyTextPropertyDescriptor NAME_DESCRIPTOR = new ReadOnlyTextPropertyDescriptor(NAME, NAME);
  51     private static final ReadOnlyTextPropertyDescriptor PATH_DESCRIPTOR = new ReadOnlyTextPropertyDescriptor(PATH, PATH);
  52     private static final ReadOnlyTextPropertyDescriptor LOCATION_DESCRIPTOR = new ReadOnlyTextPropertyDescriptor(LOCATION, LOCATION);
  53
  54     private static final IPropertyDescriptor[] DESCRIPTORS = { NAME_DESCRIPTOR, PATH_DESCRIPTOR, LOCATION_DESCRIPTOR };
  55
  56     static {
  57         NAME_DESCRIPTOR.setCategory(INFO_CATEGORY);
  58         PATH_DESCRIPTOR.setCategory(INFO_CATEGORY);
  59         LOCATION_DESCRIPTOR.setCategory(INFO_CATEGORY);
  60     }
  61
  62     // ------------------------------------------------------------------------
  63     // Constructor
  64     // ------------------------------------------------------------------------
  65
  66     /**
  67      * Constructor. Creates folder model element under the project.
  68      *
  69      * @param name
  70      *            The name of trace folder.
  71      * @param resource
  72      *            The folder resource.
  73      * @param parent
  74      *            The parent element (project).
  75      */
  76     public TmfTraceFolder(String name, IFolder resource, TmfProjectElement parent) {
  77         super(name, resource, parent);
  78     }
  79
  80     /**
  81      * Constructor. Creates folder model element under another folder.
  82      *
  83      * @param name
  84      *            The name of trace folder.
  85      * @param resource
  86      *            The folder resource.
  87      * @param parent
  88      *            The parent element (folder).
  89      */
  90     public TmfTraceFolder(String name, IFolder resource, TmfTraceFolder parent) {
  91         super(name, resource, parent);
  92     }
  93
  94     // ------------------------------------------------------------------------
  95     // TmfProjectModelElement
  96     // ------------------------------------------------------------------------
  97
  98     @Override
  99     public IFolder getResource() {
 100         return (IFolder) super.getResource();
 101     }
 102
 103     /**
 104      * @since 2.0
 105      */
 106     @Override
 107     protected void refreshChildren() {
 108         IFolder folder = getResource();
 109
 110         // Get the children from the model
 111         Map<String, ITmfProjectModelElement> childrenMap = new HashMap<>();
 112         for (ITmfProjectModelElement element : getChildren()) {
 113             childrenMap.put(element.getResource().getName(), element);
 114         }
 115
 116         try {
 117             IResource[] members = folder.members();
 118             for (IResource resource : members) {
 119                 String name = resource.getName();
 120                 boolean isFolder = resource instanceof IFolder &&
 121                         (TmfTraceType.getTraceTypeId(resource) == null);
 122                 ITmfProjectModelElement element = childrenMap.get(name);
 123                 if (isFolder && !(element instanceof TmfTraceFolder) && !(element instanceof TmfTraceElement)) {
 124                     if (TmfTraceType.isDirectoryTrace(resource.getLocationURI().getPath())) {
 125                         element = new TmfTraceElement(name, resource, this);
 126                     } else {
 127                         element = new TmfTraceFolder(name, (IFolder) resource, this);
 128                     }
 129                     addChild(element);
 130                 } else if (!isFolder && !(element instanceof TmfTraceElement)) {
 131                     element = new TmfTraceElement(name, resource, this);
 132                     addChild(element);
 133                 } else {
 134                     childrenMap.remove(name);
 135                 }
 136                 if (element != null) {
 137                     ((TmfProjectModelElement) element).refreshChildren();
 138                 }
 139             }
 140         } catch (CoreException e) {
 141         }
 142
 143         // Cleanup dangling children from the model
 144         for (ITmfProjectModelElement danglingChild : childrenMap.values()) {
 145             removeChild(danglingChild);
 146         }
 147     }
 148
 149     /**
 150      * @since 2.0
 151      */
 152     @Override
 153     public Image getIcon() {
 154         return TmfProjectModelIcons.FOLDER_ICON;
 155     }
 156
 157     /**
 158      * @since 2.0
 159      */
 160     @Override
 161     public String getLabelText() {
 162         int nbTraces = getTraces().size();
 163         if (nbTraces > 0) {
 164             return (getName() + " [" + nbTraces + ']'); //$NON-NLS-1$
 165         }
 166         return getName();
 167     }
 168
 169     // ------------------------------------------------------------------------
 170     // Operations
 171     // ------------------------------------------------------------------------
 172
 173     /**
 174      * Returns a list of trace elements under the folder element, recursively.
 175      * @return list of trace model elements
 176      */
 177     public List<TmfTraceElement> getTraces() {
 178         List<ITmfProjectModelElement> children = getChildren();
 179         List<TmfTraceElement> traces = new ArrayList<>();
 180         for (ITmfProjectModelElement child : children) {
 181             if (child instanceof TmfTraceElement) {
 182                 traces.add((TmfTraceElement) child);
 183             } else if (child instanceof TmfTraceFolder) {
 184                 traces.addAll(((TmfTraceFolder) child).getTraces());
 185             }
 186         }
 187         return traces;
 188     }
 189
 190     /**
 191      * Gets the traces elements under this folder containing the given resources
 192      *
 193      * @param resources
 194      *            resources to search for
 195      * @return list of trace elements
 196      * @since 2.0
 197      */
 198     public @NonNull List<TmfTraceElement> getTraceElements(@NonNull List<IResource> resources) {
 199         List<TmfTraceElement> traceElements = new ArrayList<>();
 200         List<TmfTraceElement> children = getTraces();
 201         for (IResource resource : resources) {
 202             TmfTraceElement el = children.stream()
 203                     .filter(traceElement ->
 204                     ((traceElement != null) &&
 205                     traceElement.getResource().equals(resource)))
 206                 .findFirst()
 207                 .orElse(null);
 208
 209             if (el != null) {
 210                 traceElements.add(el);
 211             }
 212         }
 213         return traceElements;
 214     }
 215
 216     // ------------------------------------------------------------------------
 217     // IPropertySource2
 218     // ------------------------------------------------------------------------
 219
 220     @Override
 221     public Object getEditableValue() {
 222         return null;
 223     }
 224
 225     @Override
 226     public IPropertyDescriptor[] getPropertyDescriptors() {
 227         return Arrays.copyOf(DESCRIPTORS, DESCRIPTORS.length);
 228     }
 229
 230     @Override
 231     public Object getPropertyValue(Object id) {
 232
 233         if (NAME.equals(id)) {
 234             return getName();
 235         }
 236
 237         if (PATH.equals(id)) {
 238             return getPath().toString();
 239         }
 240
 241         if (LOCATION.equals(id)) {
 242             return getLocation().toString();
 243         }
 244
 245         return null;
 246     }
 247
 248     @Override
 249     public void resetPropertyValue(Object id) {
 250     }
 251
 252     @Override
 253     public void setPropertyValue(Object id, Object value) {
 254     }
 255
 256     @Override
 257     public boolean isPropertyResettable(Object id) {
 258         return false;
 259     }
 260
 261     @Override
 262     public boolean isPropertySet(Object id) {
 263         return false;
 264     }
 265
 266 }