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