src/net/pterodactylus/jsite/project/Project.java

   1 /*
   2  * jSite2 - Project.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.jsite.project;
  21
  22 import java.beans.PropertyChangeListener;
  23 import java.io.File;
  24 import java.util.ArrayList;
  25 import java.util.List;
  26
  27 import net.pterodactylus.util.beans.AbstractBean;
  28
  29 /**
  30  * Container for project information. A Project is capable of notifying
  31  * {@link PropertyChangeListener}s if any of the contained properties change.
  32  *
  33  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  34  * @version $Id$
  35  */
  36 public class Project extends AbstractBean {
  37
  38         /** Name of the “name” property. */
  39         public static final String PROPERTY_NAME = "name";
  40
  41         /** Name of the “description” property. */
  42         public static final String PROPERTY_DESCRIPTION = "description";
  43
  44         /** Name of the “public key” property. */
  45         public static final String PROPERTY_PUBLIC_KEY = "publicKey";
  46
  47         /** Name of the “private key” property. */
  48         public static final String PROPERTY_PRIVATE_KEY = "privateKey";
  49
  50         /** Name of the “base path” property. */
  51         public static final String PROPERTY_BASE_PATH = "basePath";
  52
  53         /** Name of the “base path entries” property. */
  54         public static final String PROPERTY_BASE_PATH_ENTRIES = "basePathEntries";
  55
  56         /** Internal ID. */
  57         private String id;
  58
  59         /** The name of the project. */
  60         private String name;
  61
  62         /** The description of the project. */
  63         private String description;
  64
  65         /** The public key. */
  66         private String publicKey;
  67
  68         /** The private key. */
  69         private String privateKey;
  70
  71         /** The base path of the project. */
  72         private String basePath;
  73
  74         /** The list of files from the base path. */
  75         private List<Entry> basePathEntries = new ArrayList<Entry>();
  76
  77         /**
  78          * Returns the internal ID.
  79          *
  80          * @return The internal ID
  81          */
  82         String getId() {
  83                 return id;
  84         }
  85
  86         /**
  87          * Sets the internal ID.
  88          *
  89          * @param id
  90          *            The internal ID
  91          */
  92         void setId(String id) {
  93                 this.id = id;
  94         }
  95
  96         /**
  97          * Returns the name of the project.
  98          *
  99          * @return The name of the project
 100          */
 101         public String getName() {
 102                 return name;
 103         }
 104
 105         /**
 106          * Sets the name of the project.
 107          *
 108          * @param name
 109          *            The name of the project
 110          */
 111         public void setName(String name) {
 112                 String oldName = this.name;
 113                 this.name = name;
 114                 fireIfPropertyChanged(PROPERTY_NAME, oldName, name);
 115         }
 116
 117         /**
 118          * Returns the description of the project.
 119          *
 120          * @return The description of the project
 121          */
 122         public String getDescription() {
 123                 return description;
 124         }
 125
 126         /**
 127          * Sets the description of the project
 128          *
 129          * @param description
 130          *            The description of the project
 131          */
 132         public void setDescription(String description) {
 133                 String oldDescription = this.description;
 134                 this.description = description;
 135                 fireIfPropertyChanged(PROPERTY_DESCRIPTION, oldDescription, description);
 136         }
 137
 138         /**
 139          * Returns the public key of the project.
 140          *
 141          * @return The public key of the project
 142          */
 143         public String getPublicKey() {
 144                 return publicKey;
 145         }
 146
 147         /**
 148          * Sets the public key of the project.
 149          *
 150          * @param publicKey
 151          *            The public key of the project
 152          */
 153         void setPublicKey(String publicKey) {
 154                 String oldPublicKey = this.publicKey;
 155                 this.publicKey = publicKey;
 156                 fireIfPropertyChanged(PROPERTY_PUBLIC_KEY, oldPublicKey, publicKey);
 157         }
 158
 159         /**
 160          * Returns the private key of the project.
 161          *
 162          * @return The private key of the project
 163          */
 164         public String getPrivateKey() {
 165                 return privateKey;
 166         }
 167
 168         /**
 169          * Sets the private key of the project.
 170          *
 171          * @param privateKey
 172          *            The private key of the project
 173          */
 174         void setPrivateKey(String privateKey) {
 175                 String oldPrivateKey = this.privateKey;
 176                 this.privateKey = privateKey;
 177                 fireIfPropertyChanged(PROPERTY_PRIVATE_KEY, oldPrivateKey, privateKey);
 178         }
 179
 180         /**
 181          * Returns the base path of the project.
 182          *
 183          * @return The base path of the project
 184          */
 185         public String getBasePath() {
 186                 return basePath;
 187         }
 188
 189         /**
 190          * Sets the base path of the project.
 191          *
 192          * @param basePath
 193          *            The base path of the project
 194          */
 195         public void setBasePath(String basePath) {
 196                 String oldBasePath = this.basePath;
 197                 this.basePath = basePath;
 198                 fireIfPropertyChanged(PROPERTY_BASE_PATH, oldBasePath, basePath);
 199         }
 200
 201         /**
 202          * Rescans the base path for new or changed files.
 203          */
 204         public void rescanBasePath() {
 205                 List<Entry> entries = new ArrayList<Entry>();
 206                 scanPath("", entries);
 207                 basePathEntries.clear();
 208                 basePathEntries.addAll(entries);
 209                 firePropertyChange(PROPERTY_BASE_PATH_ENTRIES, null, null);
 210         }
 211
 212         /**
 213          * Returns the list of files from the base path.
 214          *
 215          * @return The list of files from the base path
 216          */
 217         public List<Entry> getBasePathEntries() {
 218                 return basePathEntries;
 219         }
 220
 221         //
 222         // PRIVATE METHODS
 223         //
 224
 225         /**
 226          * Scans the given path relative to {@link #basePath} for files and adds
 227          * them to the given list of entries.
 228          *
 229          * @param currentPath
 230          *            The current path, relative to the base path
 231          * @param entries
 232          *            The list of entries
 233          */
 234         private void scanPath(String currentPath, List<Entry> entries) {
 235                 File currentDirectory = new File(basePath + File.separatorChar + currentPath);
 236                 if (!currentDirectory.isDirectory()) {
 237                         return;
 238                 }
 239                 for (File file: currentDirectory.listFiles()) {
 240                         String fileName = currentPath + file.getName();
 241                         if (file.isDirectory()) {
 242                                 scanPath(fileName + File.separatorChar, entries);
 243                                 continue;
 244                         }
 245                         PhysicalEntry entry = new PhysicalEntry();
 246                         entry.setName(fileName);
 247                         entry.setPath(file.getPath());
 248                         entry.setInsert(!file.isHidden());
 249                         entries.add(entry);
 250                 }
 251         }
 252
 253 }