Changeset 27528 for main/trunk

Timestamp:

2013-06-04T11:05:08+12:00 (11 years ago)

Author:

kjdon

Message:

implemented oaisupercollection. add to oai.cfg and the server will make a new set containing the specified collections

Location:

main/trunk/greenstone2/runtime-src/src/oaiservr

Files:

• abstractlistaction.cpp (modified) (3 diffs)
• listidsaction.cpp (modified) (1 diff)
• listsetsaction.cpp (modified) (2 diffs)
• listsetsaction.h (modified) (1 diff)
• oaiaction.cpp (modified) (1 diff)
• oaiconfig.cpp (modified) (4 diffs)
• oaiconfig.h (modified) (3 diffs)

main/trunk/greenstone2/runtime-src/src/oaiservr/abstractlistaction.cpp

@@ -55 +55 @@
     position = resumption_token.getPosition();
   }
-
-  // Case for "set" argument present -- output just the records in the specified set
+  
+  // is it a super collection??
+  bool is_super_collection = false;
+  
   if (set_name != "")
   {
+    text_tarray super_colls = this->configuration->getSuperCollectionsList();
+    for (int s = 0; s<super_colls.size(); s++) {
+      if (set_name == super_colls[s]) {
+    is_super_collection = true;
+    break;
+      }
+    }
+  }
+      
+  // Case for "set" argument present that is not a super collection -- output just the records in the specified set
+  if (set_name != "" && !is_super_collection) {
     // Separate the collection name and Greenstone classifier OID from the set name
     text_t collection_name = "";
@@ -72 +85 @@
 
   // Case for no "set" argument present -- output all records in all collections
+  // or we are a super collection
   else
   {
     // Get a list of the collections available
-    text_tarray& collections = this->configuration->getCollectionsList();
+    text_tarray collections;
+
+    if (is_super_collection) {
+      collections = this->configuration->getSuperCollectionCollections(set_name);
+    } else {
+      collections = this->configuration->getCollectionsList();
+    }
     if (collections.size() == 0)
     {
@@ -120 +140 @@
   return true;
 }
-
 
 bool abstractlistaction::output_content_for_set(ostream &output, recptproto *protocol, oaiargs &params, text_t collection_name, text_t gsdl_classifier_OID, text_t set_name)

main/trunk/greenstone2/runtime-src/src/oaiservr/listidsaction.cpp

@@ -179 +179 @@
     text_t set = params["set"];
 
+    // Is the set a super collection??
+    text_tarray &super_collections = this->configuration->getSuperCollectionsList();
+    bool super_collection_found = false;
+    for (int c = 0; c < super_collections.size(); c++)
+    {
+      if (super_collections[c] == set)
+      {
+    super_collection_found = true;
+    break;
+      }
+    }
+    if (super_collection_found) {
+      this->errorType = "";
+      return true;
+    }
+    
     // Extract the collection name from the set specification
     text_t collection = "";

main/trunk/greenstone2/runtime-src/src/oaiservr/listsetsaction.cpp

@@ -131 +131 @@
   }
 
+  // if no resumption token, output the super colls. Otherwise, start from 
+  // the collection list correct position.
+  // Assume for now that super coll list is always in the first list
+  text_t set_name ="";
+  if (position == "") {
+    text_tarray& supercolls = this->configuration->getSuperCollectionsList();
+    if (collections.size() != 0) {
+      text_tarray::iterator supercoll_iterator = supercolls.begin();
+      while (supercoll_iterator != supercolls.end()) {
+    set_name = (*supercoll_iterator);
+    output_content_for_supercol(output, set_name);
+    supercoll_iterator++;
+      }
+    }
+  }
   // Get the current collection from the position value
   text_t collection_name = "";
@@ -173 +188 @@
   return true;
 }
+
+bool listsetsaction::output_content_for_supercol(ostream &output, text_t supercoll) {
+    utf8outconvertclass utf8convert;
+    output << utf8convert << "  <set>\n";
+    output << utf8convert << "    <setSpec>" << supercoll << "</setSpec>\n";
+    if (this->configuration->getSetName(supercoll) != "")
+    {
+      output << utf8convert << "    <setName>" << this->configuration->getSetName(supercoll) << "</setName>\n";
+    }
+    else
+    {
+      output << utf8convert << "    <setName>" << supercoll << "</setName>\n";
+    }
+    if (this->configuration->getSetDescription(supercoll) != "")
+    {
+      output << utf8convert << "    <setDescription>" << this->configuration->getSetDescription(supercoll) << "</setDescription>\n";
+    }
+    output << utf8convert << "  </set>\n";
+    this->setsOutput++;
+}
+  
+
 
 

main/trunk/greenstone2/runtime-src/src/oaiservr/listsetsaction.h

@@ -40 +40 @@
   bool output_content(ostream &output, recptproto *protocol, oaiargs &params);
 
+  bool output_content_for_supercol(ostream &output, text_t supercoll);
   bool output_content_for_col(ostream &output, recptproto *protocol, oaiargs &params, text_t collection);
 };

main/trunk/greenstone2/runtime-src/src/oaiservr/oaiaction.cpp

@@ -413 +413 @@
     oaiclassifier::getCollectionFromOAIID(oaiLabel, collection_id);
     if(oaiVersion >= 200){
+
+      // A doc is always a member of its collection set
+      output << "      <setSpec>" << collection_id << "</setSpec>" << endl;
+      // are we part of a super collection?
+      text_tarray super_colls = this->configuration->getSuperCollectionsForThisCollection(collection_id);
+      if (super_colls.size()!=0) {
+    text_tarray::const_iterator super_start = super_colls.begin();
+    text_tarray::const_iterator super_end = super_colls.end();
+    while(super_start != super_end) {
+      output << "      <setSpec>" << *super_start << "</setSpec>" << endl;
+      ++ super_start;
+    }
+      }
+      
+      // Do we have subsets?
       text_tarray::const_iterator member = memberOf.begin();
       text_tarray::const_iterator memEnd = memberOf.end();
-
-      // As well as all the subsets that a doc appears in, it is also a member of the 'collection' set
-      output << "      <setSpec>" << collection_id << "</setSpec>" << endl;
       while (member != memEnd) {
     text_t oaiSet = *member;

main/trunk/greenstone2/runtime-src/src/oaiservr/oaiconfig.cpp

@@ -29 +29 @@
 #include <stdlib.h>
 #include "fileutil.h"
-
 
 /**
@@ -211 +210 @@
     }
   }
+  else if (key == "oaisupercollection" && cfgline.size() > 1) {
+
+    // Configure a hierarchical super set
+    // The line should read 
+    //
+    // oaisupercollection <setName> [collections part of this set]
+    //
+    // Records in specified collections will be advertised as being part 
+    // of the SetName set as well as their collectionName set
+    //
+    // This configuration should only appear in oai.cfg
+    //
+    if (this->collection != "") {
+      cerr << "Attempt to configure an oai super collection outside of oai.cfg" << endl;
+      cerr << "Configuration attempted in " << this->collection << " collection." << endl;
+      exit(1);
+    }
+    
+    text_t super_set = cfgline[0];
+    this->superCollectList.push_back(super_set);
+    this->superCollectMap[super_set] = new oaisupercollectconfig(super_set);
+    for (int c = 1; c < cfgline.size(); ++c) {
+      text_t sub_coll = cfgline[c];
+      // Add the collection into the list for this supercoll
+      this->superCollectMap[super_set]->collectionList.push_back(sub_coll);
+      // Add the super coll into the list for the collection
+      if (this->collectMap[sub_coll]== NULL) {
+    this->collectMap[sub_coll] = new oaicollectconfig(sub_coll);
+      }
+      this->collectMap[sub_coll]->superCollectList.push_back(super_set);
+    }
+  }
   else if (key == "oaimetadata" && cfgline.size() >= 1) {
     // List of metadata prefixes to suuport
@@ -274 +305 @@
     }
     if (value != "") {
-      if (this->collectMap[coll_name] == NULL) {
-    this->collectMap[coll_name] = new oaicollectconfig(coll_name);
-      }
-      if (key == "oaisetname") {
-    this->collectMap[coll_name]->setName = value;
-      } else if (key == "oaisetdescription") {
-    this->collectMap[coll_name]->setDescription = value;
+      // check first for super collection
+      if (this->superCollectMap[coll_name] != NULL) {
+    if (key == "oaisetname") {
+      this->superCollectMap[coll_name]->setName = value;
+    } else if (key == "oaisetdescription") {
+      this->superCollectMap[coll_name]->setDescription = value;
+    }
+      } else {
+    if (this->collectMap[coll_name] == NULL) {
+      this->collectMap[coll_name] = new oaicollectconfig(coll_name);
+    }
+    if (key == "oaisetname") {
+      this->collectMap[coll_name]->setName = value;
+    } else if (key == "oaisetdescription") {
+      this->collectMap[coll_name]->setDescription = value;
+    }
       }
     }
@@ -418 +458 @@
 text_t oaiconfig::getSetName(const text_t &setSpec)
 {
-  if (this->collectMap[setSpec] == NULL) {
-    return "" ;
-  }
+  if (this->collectMap[setSpec] != NULL) {
+    this->collectMap[setSpec]->setName;
+  }
+  if (this->superCollectMap[setSpec] != NULL) {
+    return this->superCollectMap[setSpec]->setName;
+  }
+  return "" ;
   
-  return this->collectMap[setSpec]->setName;
+}
+
+text_t oaiconfig::getSetDescription(const text_t &setSpec)
+{
+  if (this->collectMap[setSpec] != NULL) {
+  return this->collectMap[setSpec]->setDescription;
+  }
+  if (this->superCollectMap[setSpec] != NULL) {
+    return this->superCollectMap[setSpec]->setDescription;
+  }
   
-}
-
-text_t oaiconfig::getSetDescription(const text_t &setSpec)
-{
-  if (this->collectMap[setSpec] == NULL) {
-    return "" ;
-  }
+  return "" ;
   
-  return this->collectMap[setSpec]->setDescription;
-}
-
+}
+
+text_tarray oaiconfig::getSuperCollectionsForThisCollection(const text_t &collection) {
+
+  text_tarray super_colls;
+  if (this->superCollectList.size() == 0) {
+    return super_colls;
+  }
+
+  for (int s = 0; s < this->superCollectList.size(); s++) {
+    text_tarray colls = this->superCollectMap[this->superCollectList[s]]->collectionList;
+    for (int c = 0; c < colls.size(); c++)
+    {
+      if (colls[c] == collection)
+      {
+    super_colls.push_back(this->superCollectList[s]);
+    break;
+      }
+    }
+  }
+   
+  return super_colls;
+}

main/trunk/greenstone2/runtime-src/src/oaiservr/oaiconfig.h

@@ -39 +39 @@
   text_t    setDescription; // A display description for the set (collection)
   text_tmap fieldMap;    // maps from OAI name to GSDL name
+  text_tarray superCollectList; // a list of all super collections this belongs to
 };
 
 typedef map<text_t, oaicollectconfig *, lttext_t> oaicollectmap;
+
+class oaisupercollectconfig {
+ public:
+  oaisupercollectconfig(const text_t &supercollectionname) { this->supercollection = supercollectionname; }
+  text_t supercollection;
+  text_t setName; // A display name for the set (supercollection)
+  text_t setDescription; // A display description for the set (supercollection)
+  text_tarray collectionList; // a list of collections contained in this super collection
+};
+
+typedef map<text_t, oaisupercollectconfig *, lttext_t> oaisupercollectmap;
+
 
 class oaiconfig : configurable {
@@ -50 +63 @@
   virtual void  configure(const text_t &key, const text_tarray &cfgline);
   text_tarray & getCollectionsList() { return this->collectList; }
+  text_tarray & getSuperCollectionsList() { return this->superCollectList; }
+  text_tarray & getSuperCollectionCollections(const text_t super_coll) {
+    return this->superCollectMap[super_coll]->collectionList;
+  }
+  text_tarray getSuperCollectionsForThisCollection(const text_t &collection);
   text_tset & getMetadataSet() { return this->metadataSet; }
   text_t        getMapping(const text_t &collection, const text_t &collectfield);
@@ -86 +104 @@
   oaicollectmap collectMap; // The configuration of collections
   text_t collection;        // Used to track which collection is being configured
-  
+  text_tarray superCollectList; //a list of super collections. may be empty
+  oaisupercollectmap superCollectMap; // The configuration of the super collections
 };
 #endif