| 1 | /******************************************************************************* |
| 2 | * Copyright (c) 2010, 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 | * Bernd Hufmann - Added supplementary files/folder handling |
| 12 | * Patrick Tasse - Refactor resource change listener |
| 13 | *******************************************************************************/ |
| 14 | |
| 15 | package org.eclipse.tracecompass.tmf.ui.project.model; |
| 16 | |
| 17 | import java.io.File; |
| 18 | import java.net.URI; |
| 19 | import java.util.List; |
| 20 | import java.util.concurrent.CopyOnWriteArrayList; |
| 21 | |
| 22 | import org.eclipse.core.resources.IFolder; |
| 23 | import org.eclipse.core.resources.IProject; |
| 24 | import org.eclipse.core.resources.IResource; |
| 25 | import org.eclipse.core.runtime.CoreException; |
| 26 | import org.eclipse.core.runtime.IPath; |
| 27 | import org.eclipse.core.runtime.NullProgressMonitor; |
| 28 | import org.eclipse.swt.widgets.Display; |
| 29 | import org.eclipse.tracecompass.internal.tmf.ui.Activator; |
| 30 | import org.eclipse.tracecompass.tmf.core.TmfCommonConstants; |
| 31 | import org.eclipse.ui.IViewPart; |
| 32 | import org.eclipse.ui.IViewReference; |
| 33 | import org.eclipse.ui.IWorkbench; |
| 34 | import org.eclipse.ui.IWorkbenchPage; |
| 35 | import org.eclipse.ui.IWorkbenchWindow; |
| 36 | import org.eclipse.ui.PlatformUI; |
| 37 | import org.eclipse.ui.navigator.CommonNavigator; |
| 38 | import org.eclipse.ui.navigator.CommonViewer; |
| 39 | |
| 40 | /** |
| 41 | * The implementation of the base TMF project model element. It provides default implementation |
| 42 | * of the <code>ITmfProjectModelElement</code> interface. |
| 43 | * <p> |
| 44 | * @version 1.0 |
| 45 | * @author Francois Chouinard |
| 46 | */ |
| 47 | public abstract class TmfProjectModelElement implements ITmfProjectModelElement { |
| 48 | |
| 49 | // ------------------------------------------------------------------------ |
| 50 | // Attributes |
| 51 | // ------------------------------------------------------------------------ |
| 52 | |
| 53 | private final String fName; |
| 54 | /** |
| 55 | * The project model element resource. |
| 56 | */ |
| 57 | protected final IResource fResource; |
| 58 | /** |
| 59 | * The project model resource location (URI) |
| 60 | */ |
| 61 | protected final URI fLocation; |
| 62 | /** |
| 63 | * The project model path of a resource. |
| 64 | */ |
| 65 | protected final IPath fPath; |
| 66 | private final ITmfProjectModelElement fParent; |
| 67 | /** |
| 68 | * The list of children elements. |
| 69 | */ |
| 70 | protected final List<ITmfProjectModelElement> fChildren; |
| 71 | |
| 72 | // ------------------------------------------------------------------------ |
| 73 | // Constructor |
| 74 | // ------------------------------------------------------------------------ |
| 75 | /** |
| 76 | * Constructor. |
| 77 | * |
| 78 | * Creates a base project model element. |
| 79 | * @param name The name of the element. |
| 80 | * @param resource The element resource. |
| 81 | * @param parent The parent model element. |
| 82 | */ |
| 83 | protected TmfProjectModelElement(String name, IResource resource, ITmfProjectModelElement parent) { |
| 84 | fName = name; |
| 85 | fResource = resource; |
| 86 | fPath = resource.getFullPath(); |
| 87 | fLocation = new File(resource.getLocationURI()).toURI(); |
| 88 | fParent = parent; |
| 89 | fChildren = new CopyOnWriteArrayList<>(); |
| 90 | } |
| 91 | |
| 92 | // ------------------------------------------------------------------------ |
| 93 | // ITmfProjectModelElement |
| 94 | // ------------------------------------------------------------------------ |
| 95 | |
| 96 | @Override |
| 97 | public String getName() { |
| 98 | return fName; |
| 99 | } |
| 100 | |
| 101 | @Override |
| 102 | public IResource getResource() { |
| 103 | return fResource; |
| 104 | } |
| 105 | |
| 106 | @Override |
| 107 | public IPath getPath() { |
| 108 | return fPath; |
| 109 | } |
| 110 | |
| 111 | @Override |
| 112 | public URI getLocation() { |
| 113 | return fLocation; |
| 114 | } |
| 115 | |
| 116 | @Override |
| 117 | public TmfProjectElement getProject() { |
| 118 | return fParent.getProject(); |
| 119 | } |
| 120 | |
| 121 | @Override |
| 122 | public ITmfProjectModelElement getParent() { |
| 123 | return fParent; |
| 124 | } |
| 125 | |
| 126 | @Override |
| 127 | public boolean hasChildren() { |
| 128 | return fChildren.size() > 0; |
| 129 | } |
| 130 | |
| 131 | @Override |
| 132 | public List<ITmfProjectModelElement> getChildren() { |
| 133 | return fChildren; |
| 134 | } |
| 135 | |
| 136 | @Override |
| 137 | public void addChild(ITmfProjectModelElement child) { |
| 138 | fChildren.add(child); |
| 139 | } |
| 140 | |
| 141 | @Override |
| 142 | public void removeChild(ITmfProjectModelElement child) { |
| 143 | fChildren.remove(child); |
| 144 | } |
| 145 | |
| 146 | @Override |
| 147 | public void refresh() { |
| 148 | // make sure the model is updated in the current thread |
| 149 | refreshChildren(); |
| 150 | |
| 151 | Display.getDefault().asyncExec(new Runnable(){ |
| 152 | @Override |
| 153 | public void run() { |
| 154 | IWorkbench wb = PlatformUI.getWorkbench(); |
| 155 | IWorkbenchWindow wbWindow = wb.getActiveWorkbenchWindow(); |
| 156 | if (wbWindow == null) { |
| 157 | return; |
| 158 | } |
| 159 | IWorkbenchPage activePage = wbWindow.getActivePage(); |
| 160 | if (activePage == null) { |
| 161 | return; |
| 162 | } |
| 163 | |
| 164 | for (IViewReference viewReference : activePage.getViewReferences()) { |
| 165 | IViewPart viewPart = viewReference.getView(false); |
| 166 | if (viewPart instanceof CommonNavigator) { |
| 167 | CommonViewer commonViewer = ((CommonNavigator) viewPart).getCommonViewer(); |
| 168 | Object element = TmfProjectModelElement.this; |
| 169 | if (element instanceof TmfProjectElement) { |
| 170 | // for the project element the viewer uses the IProject resource |
| 171 | element = getResource(); |
| 172 | } |
| 173 | commonViewer.refresh(element); |
| 174 | } |
| 175 | } |
| 176 | }}); |
| 177 | } |
| 178 | |
| 179 | // ------------------------------------------------------------------------ |
| 180 | // Object |
| 181 | // ------------------------------------------------------------------------ |
| 182 | |
| 183 | @Override |
| 184 | public int hashCode() { |
| 185 | final int prime = 31; |
| 186 | int result = 1; |
| 187 | result = prime * result + ((fPath == null) ? 0 : fPath.hashCode()); |
| 188 | return result; |
| 189 | } |
| 190 | |
| 191 | @Override |
| 192 | public boolean equals(Object other) { |
| 193 | if (this == other) { |
| 194 | return true; |
| 195 | } |
| 196 | if (other == null) { |
| 197 | return false; |
| 198 | } |
| 199 | if (!(other instanceof TmfProjectModelElement)) { |
| 200 | return false; |
| 201 | } |
| 202 | TmfProjectModelElement element = (TmfProjectModelElement) other; |
| 203 | return element.fPath.equals(fPath); |
| 204 | } |
| 205 | |
| 206 | // ------------------------------------------------------------------------ |
| 207 | // Operations |
| 208 | // ------------------------------------------------------------------------ |
| 209 | |
| 210 | /** |
| 211 | * Refresh the children of this model element, adding new children and |
| 212 | * removing dangling children as necessary. The remaining children should |
| 213 | * also refresh their own children sub-tree. |
| 214 | */ |
| 215 | void refreshChildren() { |
| 216 | // Sub-classes may override this method as needed |
| 217 | } |
| 218 | |
| 219 | /** |
| 220 | * Returns the trace specific supplementary folder under the project's |
| 221 | * supplementary folder. The returned folder and its parent folders may not |
| 222 | * exist. |
| 223 | * |
| 224 | * @param supplFolderPath |
| 225 | * folder path relative to the project's supplementary folder |
| 226 | * @return the trace specific supplementary folder |
| 227 | */ |
| 228 | public IFolder getTraceSupplementaryFolder(String supplFolderPath) { |
| 229 | TmfProjectElement project = getProject(); |
| 230 | IProject projectResource = project.getResource(); |
| 231 | IFolder supplFolderParent = projectResource.getFolder(TmfCommonConstants.TRACE_SUPPLEMENTARY_FOLDER_NAME); |
| 232 | IFolder folder = supplFolderParent.getFolder(supplFolderPath); |
| 233 | return folder; |
| 234 | } |
| 235 | |
| 236 | /** |
| 237 | * Returns the trace specific supplementary folder under the project's |
| 238 | * supplementary folder. Its parent folders will be created if they don't |
| 239 | * exist. If createFolder is true, the returned folder will be created, |
| 240 | * otherwise it may not exist. |
| 241 | * |
| 242 | * @param supplFolderPath |
| 243 | * folder path relative to the project's supplementary folder |
| 244 | * @param createFolder |
| 245 | * if true, the returned folder will be created |
| 246 | * @return the trace specific supplementary folder |
| 247 | */ |
| 248 | public IFolder prepareTraceSupplementaryFolder(String supplFolderPath, boolean createFolder) { |
| 249 | IFolder folder = getTraceSupplementaryFolder(supplFolderPath); |
| 250 | try { |
| 251 | if (createFolder) { |
| 252 | TraceUtils.createFolder(folder, new NullProgressMonitor()); |
| 253 | } else { |
| 254 | TraceUtils.createFolder((IFolder) folder.getParent(), new NullProgressMonitor()); |
| 255 | } |
| 256 | } catch (CoreException e) { |
| 257 | Activator.getDefault().logError("Error creating supplementary folder " + folder.getFullPath(), e); //$NON-NLS-1$ |
| 258 | } |
| 259 | return folder; |
| 260 | } |
| 261 | |
| 262 | @Override |
| 263 | public String toString() { |
| 264 | return getClass().getSimpleName() + '(' + getPath() + ')'; |
| 265 | } |
| 266 | |
| 267 | } |