Changeset 32870 for main/trunk

Timestamp:

2019-03-06T17:41:15+13:00 (5 years ago)

Author:

ak19

Message:

1. set_set now renamed to set_oaiset after Dr Bainbridge suggested the variable name could be better. 2. Dr Bainbridge suggested informative comments around why ACTIVE and DEACTIVATED constants were Integers and not ints for anyone reading the code in future. 3. When (de)activating a collection, better to check that the collname is not in collection_name_list rather than checking against set_oaiset. This is because set_oaiset can contain values like 'lucene-jdbm-demo:cl1' which are not collection names but which are oaisets. 4. Corrected part of a display string.

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/core/OAIReceptionist.java (modified) (9 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/core/OAIReceptionist.java

@@ -72 +72 @@
   */
   protected Vector<Integer> collection_state_list = null;
-  /** Possible states for a collection */
+  /** Possible states for a collection.
+    * NOTE: Being done with Integer instead of int because they're put into Vectors and they can only contain Objects not primitive data types.
+  */
   protected static final Integer DEACTIVATED = new Integer(0);
   protected static final Integer ACTIVE = new Integer(1);
@@ -79 +81 @@
   protected boolean noRecordsMatch = false;
       
-  /** A set of all known 'sets' */
-  protected HashSet<String> set_set = null;
+  /** A set of all known 'sets' TODO: set_oaiset as name */
+  protected HashSet<String> set_oaiset = null;
 
   protected boolean has_super_colls = false;
@@ -185 +187 @@
   }
   private boolean configureSetInfo() {
-    this.set_set = new HashSet<String>();
+    this.set_oaiset = new HashSet<String>();
 
     // First, we get a list of all the OAI enabled collections
@@ -278 +280 @@
           // not in there yet
           subcolls = new Vector<String>();
-          this.set_set.add(set_spec);
+          this.set_oaiset.add(set_spec);
           this.super_coll_map.put(set_spec, subcolls);
           // the first time a supercoll is mentioned, add into the set list
@@ -290 +292 @@
       // add in the set
       listsets_element.appendChild(listsets_doc.importNode(set, true));
-      this.set_set.add(set_spec);
+      this.set_oaiset.add(set_spec);
     }
       } // for each set in the collection
@@ -409 +411 @@
         String collname = request.getAttribute(GSXML.SYSTEM_TYPE_ACTIVATE);
         // don't bother activating if it's not an OAI collection
-        if (!this.set_set.contains(collname)) {
+        if (!this.collection_name_list.contains(collname)) {
             return OAIXML.createDeActivationOfNonOAICollResponse(OAIXML.ACTIVATION, collname);
         }
@@ -417 +419 @@
         String collname = request.getAttribute(GSXML.SYSTEM_TYPE_DEACTIVATE);
         // don't bother deactivating if it's not an OAI collection
-        if (!this.set_set.contains(collname)) {
+        if (!this.collection_name_list.contains(collname)) {
             return OAIXML.createDeActivationOfNonOAICollResponse(OAIXML.DEACTIVATION, collname);
         }
@@ -620 +622 @@
       if(set_requested == true) {
     set_spec_str = param_map.get(OAIXML.SET);
-    if (!this.set_set.contains(set_spec_str)) {
+    if (!this.set_oaiset.contains(set_spec_str)) {
       // the set is not one we know about
       logger.error("requested set is not found in this repository");
@@ -692 +694 @@
             // 0 collections are active, but (the remaining one) would have been deactivated, not other reason
             String errorCode = (record_type.equals(OAIXML.RECORD)) ? OAIXML.NO_RECORDS_MATCH : OAIXML.ID_DOES_NOT_EXIST; // GetRecords vs GetIdentifiers request
-            return OAIXML.createErrorMessage(errorCode, "OAI collections temporarily active. Likely because of collection rebuilding. Check back shortly.");
+            return OAIXML.createErrorMessage(errorCode, "OAI collections temporarily inactive. Likely because of (a) collection rebuilding. Check back shortly.");
         }
     }