Changeset 7224

Timestamp:

2004-04-23T14:56:30+12:00 (20 years ago)

Author:

kjdon

Message:

tidied up the getXXXDir methods in Utility. Utility.getCollectionDir (which returns the path to the collect directory) has been renamed to getCollectDir, and a new Utility.getCollectionDir is provided which returns the path to an individual collection's base dir

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• cdm/SuperCollectionManager.java (modified) (1 diff)
• collection/CollectionManager.java (modified) (13 diffs)
• collection/DeleteCollectionPrompt.java (modified) (2 diffs)
• collection/ExportCollectionPrompt.java (modified) (1 diff)
• collection/SaveCollectionTask.java (modified) (1 diff)
• file/FileNode.java (modified) (1 diff)
• gui/BuildOptions.java (modified) (1 diff)
• gui/GUIManager.java (modified) (1 diff)
• gui/NewCollectionDetailsPrompt.java (modified) (5 diffs)
• mem/MEMNode.java (modified) (1 diff)
• util/Utility.java (modified) (4 diffs)

trunk/gli/src/org/greenstone/gatherer/cdm/SuperCollectionManager.java

@@ -191 +191 @@
         // We start by building a model of the installed collections.
         collection_checklist_model = new ArrayList();
-        File gsdl_collection_directory = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+        File gsdl_collection_directory = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
         current_coll_name = Gatherer.c_man.getCollection().getName();
         File[] possible_collections = gsdl_collection_directory.listFiles();

trunk/gli/src/org/greenstone/gatherer/collection/CollectionManager.java

@@ -215 +215 @@
     closing_thread = Thread.currentThread();
     // Remove the lock on this file, then remove the collection.
-    File lock_file = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator + LOCK_FILE);
+    File lock_file = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()) + LOCK_FILE);
     lock_file.delete();
     if(lock_file.exists()) {
@@ -257 +257 @@
         makeCollection(description, email, name, title);
         progress.setProgress(1);
-        String a_dir = Utility.getCollectionDir(Gatherer.config.gsdl_path) + name + File.separator;
+        String a_dir = Utility.getCollectionDir(Gatherer.config.gsdl_path, name);
 
         // ACTIVE_DIR/log/
@@ -491 +491 @@
      */
     public String getCollectionArchive() {
-    return Utility.getArchiveDir(Gatherer.config.gsdl_path, collection.getName());
+    return Utility.getArchiveDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
     /** Constructs the absolute filename of the collection building directory, which should resemble "$GSDLHOME/collect/<col_name>/building/"
@@ -501 +501 @@
      */
     public String getCollectionBuild() {
-    return Utility.getBuildDir(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator);
+    return Utility.getBuildDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
 
@@ -512 +512 @@
      */
     public String getCollectionConfig() {
-    return Utility.getConfigDir(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator);
+    return Utility.getConfigDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
 
@@ -523 +523 @@
      */
     public String getCollectionDirectory() {
-    return Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator;
+    return Utility.getCollectionDir(Gatherer.config.gsdl_path,  collection.getName());
     }
 
@@ -534 +534 @@
      */
     public String getCollectionEtc() {
-    return Utility.getEtcDir(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator);
+    return Utility.getEtcDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
     /** Constructs the absolute filename of the collection file, which should resemble "$GSDLHOME/collect/<col_name>/<col_name>.col"
@@ -544 +544 @@
      */
     public String getCollectionFilename() {
-    return Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator + collection.getName() + ".col";
+    return Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()) + collection.getName() + ".col";
     }
     /** Constructs the absolute filename of the collection images directory, which should resemble "$GSDLHOME/collect/<col_name>/images/"
@@ -554 +554 @@
      */
     public String getCollectionImages() {
-    return Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator + StaticStrings.IMAGES_FOLDER;
+    return Utility.getImagesDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
     /** Constructs the absolute filename of the collection import directory, which should resemble "$GSDLHOME/collect/<col_name>/import/"
@@ -564 +564 @@
      */
     public String getCollectionImport() {
-    return Utility.getImportDir(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator);
+    return Utility.getImportDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
     /** Constructs the absolute filename of the collection index directory, which should resemble "$GSDLHOME/collect/<col_name>/index/"
@@ -574 +574 @@
      */
     public String getCollectionIndex() {
-    return Utility.getIndexDir(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator);
+    return Utility.getIndexDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
     /** Constructs the absolute filename of the collection log directory, which should resemble "$GSDLHOME/collect/<col_name>/log/"
@@ -584 +584 @@
      */
     public String getCollectionLog() {
-    return Utility.getLogDir(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator);
+    return Utility.getLogDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
     /** Constructs the absolute filename of the collection metadata directory, which should resemble "$GSDLHOME/collect/<col_name>/metadata/"
@@ -594 +594 @@
      */
     public String getCollectionMetadata() {
-    return Utility.getMetadataDir(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getName() + File.separator);
+    return Utility.getMetadataDir(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getName()));
     }
 

trunk/gli/src/org/greenstone/gatherer/collection/DeleteCollectionPrompt.java

@@ -217 +217 @@
     private void scanForCollections() {
     // Start at the collect dir.
-    String collect_directory_name = Utility.getCollectionDir(Gatherer.config.gsdl_path);
+    String collect_directory_name = Utility.getCollectDir(Gatherer.config.gsdl_path);
     File collect_directory = new File(collect_directory_name);
     if(collect_directory.exists()) {
@@ -311 +311 @@
         }
 
-        File delete_me = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path) + collection.getShortName() + File.separator);
+        File delete_me = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path, collection.getShortName()));
         if(Utility.delete(delete_me)) {
         if (Gatherer.c_man.getCollection() != null && collection.getShortName().equals(Gatherer.c_man.getCollection().getName())) {

trunk/gli/src/org/greenstone/gatherer/collection/ExportCollectionPrompt.java

@@ -345 +345 @@
     private void scanForCollections() {
     // Start at the collect dir.
-    String collect_directory_name = Utility.getCollectionDir(Gatherer.config.gsdl_path);
+    String collect_directory_name = Utility.getCollectDir(Gatherer.config.gsdl_path);
     File collect_directory = new File(collect_directory_name);
     if(collect_directory.exists()) {

trunk/gli/src/org/greenstone/gatherer/collection/SaveCollectionTask.java

@@ -163 +163 @@
         ArrayList files = new ArrayList();
         File collection_file = new File(Gatherer.c_man.getCollectionFilename());
-        File copied_dir = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path) + name);
+        File copied_dir = new File(Utility.getCollectDir(Gatherer.config.gsdl_path) + name);
         files.add(collection_file.getParentFile());
         while(files.size() > 0) {

trunk/gli/src/org/greenstone/gatherer/file/FileNode.java

@@ -273 +273 @@
         ///atherer.println("Map the 'Greenstone Collections' node.");
         // For each of the children directories, which are collections...
-        File start = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+        File start = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
         File cols[] = start.listFiles();
         ArrayTools.sort(cols);

trunk/gli/src/org/greenstone/gatherer/gui/BuildOptions.java

@@ -156 +156 @@
      */
     public BuildOptions() {
-    collectdir_value = Utility.getCollectionDir(Gatherer.config.gsdl_path);
+    collectdir_value = Utility.getCollectDir(Gatherer.config.gsdl_path);
     // If we have a collection open gets its details.
     if(Gatherer.c_man.ready()) {

trunk/gli/src/org/greenstone/gatherer/gui/GUIManager.java

@@ -719 +719 @@
         File file;
         if(Gatherer.config.gsdl_path != null) {
-        file = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+        file = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
         }
         else {

trunk/gli/src/org/greenstone/gatherer/gui/NewCollectionDetailsPrompt.java

@@ -51 +51 @@
         return false;
     }
-    File collection_directory = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+    File collection_directory = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
     File children[] = collection_directory.listFiles();
     for(int i = 0; children != null && i < children.length; i++) {
@@ -104 +104 @@
     // Model building. Build a model of all of the collections in the gsdl collect directory with the appropriate directories.
     Vector base_collection_model = new Vector();
-    File gsdl_collection_directory = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+    File gsdl_collection_directory = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
     File[] possible_collections = gsdl_collection_directory.listFiles();
     for (int i = 0; possible_collections != null && i < possible_collections.length; i++) {
@@ -322 +322 @@
 
     private boolean filenameClashes(String filename) {
-    File collection_directory = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+    File collection_directory = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
     File children[] = collection_directory.listFiles();
     for(int i = 0; children != null && i < children.length; i++) {
@@ -342 +342 @@
         File file;
         if(Gatherer.config.gsdl_path != null) {
-        file = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+        file = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
         }
         else {
@@ -417 +417 @@
            if(name_final.length() > 0) {
            // Determine if this filename is already in use.
-           File collection_directory = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+           File collection_directory = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
            File children[] = collection_directory.listFiles();
            for(int i = 0; children != null && i < children.length; i++) {

trunk/gli/src/org/greenstone/gatherer/mem/MEMNode.java

@@ -149 +149 @@
             boolean is_descendant = false;
             File source_path = new File((String)userObject);
-            File collect_path = new File(Utility.getCollectionDir(Gatherer.config.gsdl_path));
+            File collect_path = new File(Utility.getCollectDir(Gatherer.config.gsdl_path));
             File current_path = source_path;
             while(!is_descendant && current_path != null) {

trunk/gli/src/org/greenstone/gatherer/util/Utility.java

@@ -110 +110 @@
     /** Definition of an important directory name, in this case the location of help documentation. */
     static final public String HELP_DIR = BASE_DIR + "help" + File.separator;
+    /** Definition of an important directory name, in this case the images directory for the collection. */
+    static final public String IMAGES_DIR = "images" + File.separator;
     /** Definition of an important directory name, in this case the import directory for the collection. */
     static final public String IMPORT_DIR = "import" + File.separator;
@@ -460 +462 @@
 
     /** Method which constructs the archive directory given a certain collection.
-     * @param gsdl_path The location of the greenstone installation  as a <strong>String</strong>.
-     * @param col_name The collection name
+     * @param gsdl_path The location of the collection directory as a <strong>String</strong>.
      * @return The location of the given collections archive directory, also as a <strong>String</strong>.
      */
-    static public String getArchiveDir(String gsdl_path, String col_name) {
-    return gsdl_path + File.separator + COL_DIR + col_name + File.separator + ARCHIVE_DIR;
+    static public String getArchiveDir(String col_dir) {
+    return col_dir + ARCHIVE_DIR;
     }
     /** Method which constructs the build directory given a certain collection.
@@ -483 +484 @@
     return new File(getGLIUserFolder(), StaticStrings.CACHE_FOLDER);
     }
-    /** Method which constructs the collection directory for Greenstone.
+    /** Method which constructs the collect directory for Greenstone.
      * @param gsdl_path The location of the gsdl installation directory as a <strong>String</strong>.
      * @return The location of the collection directory, also as a <strong>String</strong>.
      */
-    public static String getCollectionDir(String gsdl_path) {
+    public static String getCollectDir(String gsdl_path) {
     return gsdl_path + COL_DIR;
     }
+    
+    /** Method which constructs a collection's top level directory
+     * @@param gsdl_path The location of the gsdl installation directory as a <strong>String</strong>.
+     * @param The name of the collection as a <strong>String</strong>.
+     * @return The location of the collection's base directory
+     */
+    public static String getCollectionDir(String gsdl_path, String coll_name) {
+    return getCollectDir(gsdl_path) + coll_name + File.separator;
+    }
+    
     /** Method which constructs the configuration file given a certain collection.
      * @param col_dir The location of the collection directory as a <strong>String</strong>.
@@ -610 +621 @@
     }
 
+    /** Method which constructs the images directory given a certain collection.
+     * @param col_dir The location of the collection directory as a <strong>String</strong>.
+     * @return The location of the given collections images directory, also as a <strong>String</strong>.
+     */
+    public static String getImagesDir(String col_dir) {
+    return col_dir + IMAGES_DIR;
+    }
     /** Method which constructs the import directory given a certain collection.
      * @param col_dir The location of the collection directory as a <strong>String</strong>.