Changeset 37615

Timestamp:

2023-04-06T16:55:52+12:00 (14 months ago)

Author:

kjdon

Message:

this will now ask for format info from each collection in the documentNodeList, and get their format statements for the specified service. it groups these into a xsl:choose statement.

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/action/GeneralDocumentListAction.java (modified) (5 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/action/GeneralDocumentListAction.java

@@ -5 +5 @@
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.Map;
 
 import javax.xml.parsers.DocumentBuilder;
@@ -42 +43 @@
     // assume only one request
     Element request = (Element) GSXML.getChildByTagName(message, GSXML.REQUEST_ELEM);
-    logger.debug(" request=" + this.converter.getString(request));
+    //logger.debug(" request=" + this.converter.getString(request));
 
     UserContext userContext = new UserContext(request);
@@ -121 +122 @@
     }
 
+    NodeList doc_nodes = result_response.getElementsByTagName(GSXML.DOC_NODE_ELEM);
+    if (doc_nodes.getLength() == 0) {
+      // no docs in the result
+      return result;
+    }
+
+    // lets get format info for each collection
+    HashSet<String> collections = getCollectionNames(doc_nodes);
+
+    //get the format info for the service
+    Element base_format_elem = getFormatInfo(to, userContext);
+    // now get any from the collections, and combine into a big if/else block
+    Element combined_format = getAndCombineFormats(doc, base_format_elem, collections, service_name);
+
+    if (combined_format != null) {
+      // set the format type - what would it be for this??
+      //format_elem.setAttribute(GSXML.TYPE_ATT, "");
+      // add to the response
+      page_response.appendChild(combined_format);
+    }
+
     // we need to get metadata for the documents
+    // which metadata elements do we need?
     HashSet<String> doc_meta_names = new HashSet<String>();
     // always want this one
     doc_meta_names.add("root_assocfilepath");
     // we use extraMetadataList, plus anything that shows up in the service's format statement
-    //get the format info for the service
-    Element format_elem = getFormatInfo(to, userContext);
-    if (format_elem != null) {
-      // set the format type - what would it be for this??
-      //format_elem.setAttribute(GSXML.TYPE_ATT, "");
-      // add to the response
-      page_response.appendChild(doc.importNode(format_elem, true));
-    }
+
     // ... and find any metadata names mentioned in the format, or in extraMetadata
-    getRequiredMetadataNames(doc_meta_names, format_elem, request);
+    getRequiredMetadataNames(doc_meta_names, combined_format, request);
 
     // TODO, do we want docType and nodeType attributes for each doc Node??
-    addMetadataToDocNodes(result_response, doc_meta_names);
+    getAndAddMetadataToDocNodes(result_response, doc_meta_names);
     
     if (response_only)
@@ -162 +178 @@
     return result;
   }
-  
-  protected void addMetadataToDocNodes(Element result_elem, HashSet<String> meta_names) {
+
+  protected HashSet<String> getCollectionNames(NodeList docNodes) {
+    HashSet<String> coll_names = new HashSet<String>();
+    for (int i=0; i<docNodes.getLength(); i++) {
+      String collection = ((Element)docNodes.item(i)).getAttribute(GSXML.COLLECTION_ATT);
+      if (!collection.equals("")) {
+        coll_names.add(collection);
+      }
+    }
+    return coll_names;
+  }
+
+  // TODO - store this so don't need to get it each time.
+  protected Element getAndCombineFormats(Document result_doc, Element base_format, HashSet<String> collections, String service_name)
+  {
+    Element combined_format = result_doc.createElement(GSXML.FORMAT_ELEM);
+
+    // lets see if the collections are returning any local formats
+    Document doc = XMLConverter.newDOM();
+    Element message = doc.createElement(GSXML.MESSAGE_ELEM);
+
+    // service_name is an extra attribute
+    for (String coll : collections) { 
+      Element this_coll_request = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_FORMAT, coll, new UserContext());
+      this_coll_request.setAttribute(GSXML.SERVICE_ATT, service_name);
+      message.appendChild(this_coll_request);
+    }
+
+    // template match:mode is the key->collection->template element
+    HashMap<String, HashMap<String,Element>> template_map = new HashMap<String, HashMap<String,Element>>();
+    if (base_format != null) {
+      // to do - process the defaults differently. any non match tempaltes need to be added as is into hte result, and the options.
+      addFormatsToMap(template_map, base_format, "default_format", combined_format);
+    }
+
+    //send off the request
+    boolean has_coll_specific_format = false;
+    Element mr_response = (Element)this.mr.process(message);
+    // add all the resulting templates into the map
+    NodeList colls_responses = mr_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
+    for (int i=0; i<colls_responses.getLength(); i++) {
+      Element coll_response = (Element)colls_responses.item(i);
+      Element format = (Element)GSXML.getChildByTagName(coll_response, GSXML.FORMAT_ELEM);
+      if (format == null) continue;
+      String this_coll = coll_response.getAttribute(GSXML.FROM_ATT);
+      addFormatsToMap(template_map, format, this_coll, null);
+    }
+
+    // ok, now we need to go through the map, and join them up into a big <xsl:choose>
+    for(Map.Entry<String, HashMap<String, Element>> entry : template_map.entrySet()) {
+      String id = entry.getKey();
+      HashMap<String, Element> coll_map = entry.getValue();
+
+      Element new_template = result_doc.createElementNS("http://www.w3.org/1999/XSL/Transform", "xsl:template");
+      String[] id_parts = id.split(":");
+      String match = id_parts[0];
+      String mode = "";
+      if (id_parts.length==2) {
+        mode = id_parts[1];
+      }
+      new_template.setAttribute("match", match);
+      if (!mode.equals("")) {
+        new_template.setAttribute("mode", mode);
+      }
+      if (coll_map.size()==1 && coll_map.containsKey("default_format")) {
+        // we only have the default format - can copy it as is
+        new_template = (Element)result_doc.importNode(coll_map.get("default_format"), true);
+
+      } else if (coll_map.size()==1) {
+        // this is an error
+        logger.error("no default entry for xsl template!"); // todo better message
+      } else {
+        Element choose = result_doc.createElementNS("http://www.w3.org/1999/XSL/Transform", "xsl:choose");
+        new_template.appendChild(choose);
+        Element otherwise = null;
+        for (Map.Entry<String, Element> entry2 : coll_map.entrySet()) {
+          String coll = entry2.getKey();
+          Element template = entry2.getValue();
+          if (coll.equals("default_format")) {
+            // this is the otherwsie clause
+            otherwise = GSXML.duplicateWithNewNameNS(result_doc, template, "xsl:otherwise","http://www.w3.org/1999/XSL/Transform", false);
+            
+          } else {
+            // this is a when statement
+            Element when = GSXML.duplicateWithNewNameNS(result_doc, template, "xsl:when","http://www.w3.org/1999/XSL/Transform", false);
+            when.setAttribute("test", "@collection='"+coll+"'");
+            choose.appendChild(when);
+        }
+          if (otherwise != null) {
+            // append otherwise last
+            choose.appendChild(otherwise);
+          }
+          combined_format.appendChild(new_template);
+        
+        }
+        
+      } // for each entry in template map
+    }
+    return combined_format;
+  }
+  protected void addFormatsToMap(HashMap<String, HashMap<String, Element>> template_map, Element format_element, String coll_name, Element combined_format) {
+    Document doc = null;
+    if (combined_format != null) {
+      doc = combined_format.getOwnerDocument();
+    }
+    NodeList children = format_element.getChildNodes();
+    for (int j=0; j<children.getLength(); j++) {
+      Node this_child = children.item(j);
+      if (this_child instanceof Element) { // lets ignore any other kind of node
+        if (this_child.getNodeName().equals("xsl:template")) {
+          Element this_template = (Element)this_child;
+          String match = this_template.getAttribute("match");
+          if (match.equals("")) {
+            if (combined_format != null) {
+              combined_format.appendChild(doc.importNode(this_template,true));
+            }
+          } else {
+            String mode = this_template.getAttribute("mode");
+            String id = match+":"+mode;
+            HashMap<String, Element> coll_map = template_map.get(id);
+            if (coll_map == null) {
+              coll_map = new HashMap<String, Element>();
+              template_map.put(id, coll_map);
+            }
+            coll_map.put(coll_name, this_template);
+          }
+        } else {
+        // the node is not xsl:template, add it to combined format, if that has been supplied.
+          if (combined_format != null) {
+            combined_format.appendChild(doc.importNode(this_child, true));
+          }
+        }
+      }// if isa Element
+    } // for each node
+ 
+
+  }
+
+  protected void getAndAddMetadataToDocNodes(Element result_elem, HashSet<String> meta_names) {
     
     Document doc = XMLConverter.newDOM();
@@ -194 +347 @@
     // ok, send off the message
     Element dm_result = (Element)this.mr.process(message);
-
     String [] att_names = {GSXML.COLLECTION_ATT, GSXML.NODE_ID_ATT};
     // go throught he original list of doc nodes