org.eclipse.egit.ui/src/org/eclipse/egit/ui/internal/clone/ProjectRecord.java

   1 package org.eclipse.egit.ui.internal.clone;
   2
   3 /*******************************************************************************
   4  * Copyright (c) 2004, 2008 IBM Corporation and others.
   5  * Copyright (C) 2007, Martin Oberhuber (martin.oberhuber@windriver.com)
   6  * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
   7  * Copyright (C) 2009, Mykola Nikishov <mn@mn.com.ua>
   8  * Copyright (C) 2010, Wim Jongman <wim.jongman@remainsoftware.com>
   9  *
  10  * All rights reserved. This program and the accompanying materials
  11  * are made available under the terms of the Eclipse Public License v1.0
  12  * which accompanies this distribution, and is available at
  13  * http://www.eclipse.org/legal/epl-v10.html
  14  *******************************************************************************/
  15
  16 import java.io.File;
  17
  18 import org.eclipse.core.resources.IProjectDescription;
  19 import org.eclipse.core.resources.ResourcesPlugin;
  20 import org.eclipse.core.runtime.CoreException;
  21 import org.eclipse.core.runtime.IPath;
  22 import org.eclipse.core.runtime.Path;
  23 import org.eclipse.core.runtime.Platform;
  24 import org.eclipse.egit.ui.UIText;
  25 import org.eclipse.osgi.util.NLS;
  26 import org.eclipse.ui.wizards.datatransfer.IImportStructureProvider;
  27
  28 class ProjectRecord {
  29         File projectSystemFile;
  30
  31         String projectName;
  32
  33         Object parent;
  34
  35         int level;
  36
  37         IProjectDescription description;
  38
  39         /**
  40          * Create a record for a project based on the info in the file.
  41          *
  42          * @param file
  43          */
  44         ProjectRecord(File file) {
  45                 projectSystemFile = file;
  46                 setProjectName();
  47         }
  48
  49         /**
  50          * @param parent
  51          *            The parent folder of the .project file
  52          * @param level
  53          *            The number of levels deep in the provider the file is
  54          */
  55         ProjectRecord(Object parent, int level) {
  56                 this.parent = parent;
  57                 this.level = level;
  58                 setProjectName();
  59         }
  60
  61         /**
  62          * Set the name of the project based on the projectFile.
  63          */
  64         private void setProjectName() {
  65                 try {
  66                         // If we don't have the project name try again
  67                         if (projectName == null) {
  68                                 IPath path = new Path(projectSystemFile.getPath());
  69                                 // if the file is in the default location, use the directory
  70                                 // name as the project name
  71                                 if (isDefaultLocation(path)) {
  72                                         projectName = path.segment(path.segmentCount() - 2);
  73                                         description = ResourcesPlugin.getWorkspace()
  74                                                         .newProjectDescription(projectName);
  75                                 } else {
  76                                         description = ResourcesPlugin.getWorkspace()
  77                                                         .loadProjectDescription(path);
  78                                         projectName = description.getName();
  79                                 }
  80
  81                         }
  82                 } catch (CoreException e) {
  83                         // no good couldn't get the name
  84                 }
  85         }
  86
  87         /**
  88          * Returns whether the given project description file path is in the
  89          * default location for a project
  90          *
  91          * @param path
  92          *            The path to examine
  93          * @return Whether the given path is the default location for a project
  94          */
  95         private boolean isDefaultLocation(IPath path) {
  96                 // The project description file must at least be within the project,
  97                 // which is within the workspace location
  98                 if (path.segmentCount() < 2)
  99                         return false;
 100                 return path.removeLastSegments(2).toFile().equals(
 101                                 Platform.getLocation().toFile());
 102         }
 103
 104         /**
 105          * Get the name of the project
 106          *
 107          * @return String
 108          */
 109         public String getProjectName() {
 110                 return projectName;
 111         }
 112
 113         /**
 114          * Gets the label to be used when rendering this project record in the
 115          * UI.
 116          * @param structureProvider
 117          *
 118          * @return String the label
 119          * @since 3.4
 120          */
 121         public String getProjectLabel(IImportStructureProvider structureProvider) {
 122                 if (description == null)
 123                         return projectName;
 124
 125                 String path = projectSystemFile == null ? structureProvider
 126                                 .getLabel(parent) : projectSystemFile.getParent();
 127
 128                 return NLS.bind(UIText.WizardProjectsImportPage_projectLabel,
 129                                 projectName, path);
 130         }
 131
 132         @Override
 133         public String toString() {
 134                 return projectName;
 135         }
 136 }