Changeset 7224 for trunk/gli/src/org/greenstone/gatherer/util

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

File:

• trunk/gli/src/org/greenstone/gatherer/util/Utility.java (modified) (4 diffs)

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>.