Changeset 1941 for trunk/gsdl/src/recpt/formattools.cpp

Timestamp:

2001-02-09T15:41:33+13:00 (23 years ago)

Author:

jmt14

Message:

Modified files:

browsetools.cpp documentaction.cpp formattools.cpp
formattools.h

File:

• trunk/gsdl/src/recpt/formattools.cpp (modified) (7 diffs)

trunk/gsdl/src/recpt/formattools.cpp

@@ -69 +69 @@
   DocumentHeading = "{Or}{[parent(Top):Title],[Title],untitled}<br>";
   DocumentContents = true;
-  DocumentArrowsBottom = true;
+  DocumentArrowsBottom = true; 
   DocumentButtons.erase (DocumentButtons.begin(), DocumentButtons.end());
   //  DocumentButtons.push_back ("Expand Text");
@@ -75 +75 @@
   DocumentButtons.push_back ("Detach");
   DocumentButtons.push_back ("Highlight");
+  RelatedDocuments = "";
   DocumentText = "<center><table width=_pagewidth_><tr><td>[Text]</td></tr></table></center>";
   formatstrings.erase (formatstrings.begin(), formatstrings.end());
@@ -171 +172 @@
   return day + " " + month + " " + year;
 }  
+
+
+//this function gets the information associated with the relation
+//metadata for the document associated with 'docinfo'. This relation
+//metadata consists of a line of pairs containing 'collection, document OID'
+//(this is the OID of the document related to the current document, and
+//the collection the related document belongs to). For each of these pairs
+//the title metadata is obtained and then an html link between the title
+//of the related doc and the document's position (the document will be
+//found in "<a href=\"_httpdocument_&c=collection&cl=search&d=OID">
+//(where collection is the related documents collection, and OID is the
+//related documents OID).  A list of these html links are made for as many
+//related documents as there are. This list is then returned. If there are
+//no related documents available for the current document then the string
+//'.. no related documents .. ' is returned.
+text_t get_related_docs(const text_t& collection, recptproto* collectproto,
+               ResultDocInfo_t &docinfo, ostream& logout){
+  
+  text_tset metadata;
+
+  //insert the metadata we wish to collect
+  metadata.insert("relation"); 
+  metadata.insert("Title");  
+  metadata.insert("Subject"); //for emails, where title data doesn't apply
+ 
+  FilterResponse_t response;
+  text_t relation = ""; //string for displaying relation metadata
+  text_t relationTitle = ""; //the related documents Title (or subject)
+  text_t &relationOID = ""; //the related documents OID  
+
+  //get the information associated with the metadata for current doc
+  if (get_info (docinfo.OID, collection, metadata, 
+        false, collectproto, response, logout)) {
+    
+    //if the relation metadata exists, store for displaying
+    if(!response.docInfo[0].metadata["relation"].values.empty()){
+      relationOID += response.docInfo[0].metadata["relation"].values[0];
+
+      //split relation data into pairs of collectionname,ID number
+      text_tarray relationpairs;
+      splitchar (relationOID.begin(), relationOID.end(), ' ', relationpairs);
+      
+      text_tarray::const_iterator currDoc = relationpairs.begin();  
+      text_tarray::const_iterator lastDoc = relationpairs.end();
+
+      //iterate through the pairs to split and display
+      while(currDoc != lastDoc){
+    
+    //split pairs into collectionname and ID 
+    text_tarray relationdata;
+    splitchar ((*currDoc).begin(), (*currDoc).end(), ',', relationdata);
+    
+    //get first element in the array (collection)
+    text_tarray::const_iterator doc_data = relationdata.begin();
+    text_t document_collection = *doc_data;
+    doc_data++; //increment to get next item in array (oid)
+    text_t document_OID = *doc_data;
+    
+    //create html link to related document
+    relation += "<a href=\"_httpdocument_&c=" + document_collection;
+    relation += "&cl=search&d=" + document_OID;
+       
+    //get the information associated with the metadata for related doc
+    if (get_info (document_OID, document_collection, metadata,
+              false, collectproto, response, logout)) {
+      
+      //if title metadata doesn't exist, collect subject metadata
+      //if that doesn't exist, just call it 'related document'
+      if (!response.docInfo[0].metadata["Title"].values[0].empty())
+        relationTitle = response.docInfo[0].metadata["Title"].values[0];
+      else if (!response.docInfo[0].metadata["Subject"].values.empty())
+        relationTitle = response.docInfo[0].metadata["Subject"].values[0];
+      else relationTitle =  "RELATED DOCUMENT";
+      
+    }
+    
+    //link the related document's title to its page
+    relation += "\">" + relationTitle + "</a>"; 
+    relation += "  (" + document_collection + ")<br>";
+    
+    currDoc++;
+      }
+    }
+    
+  } 
+
+  if(relation.empty()) //no relation data for documnet
+    relation = ".. no related documents .. ";
+
+  return relation;
+}
+
+
 
 static void get_parent_options (text_t &instring, metadata_t &metaoption) {
@@ -238 +332 @@
   else if (meta == "Text")
     formatlistptr->command = comDoc;
+  
+  else if (meta == "RelatedDocuments")
+   formatlistptr->command = comRel;
 
   else if (meta == "highlight")
@@ -645 +742 @@
 }
 
+
+
 text_t format_string (const text_t& collection, recptproto* collectproto,
               ResultDocInfo_t &docinfo, displayclass &disp, 
@@ -666 +765 @@
   case comNum:
     return docinfo.result_num;
+  case comRel: //if [RelatedDocuments] appears in format string, collect relation data
+    return get_related_docs(collection, collectproto, docinfo, logout);
   case comMeta:
 
@@ -692 +793 @@
         = get_formatted_string(collection, collectproto, 
                        response.docInfo[0], disp, expanded_formatlistptr, 
-                       link,icon,highlight,
-                       logout);
+                       link, icon, highlight, logout);
           
           return expanded_metavalue;