Changeset 36972 for main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/CollectionGroups.java

Timestamp:

2022-12-06T14:08:15+13:00 (17 months ago)

Author:

kjdon

Message:

now we use displayItems in preference to title, description, shortDescription elements. This allows language specific variants.

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/CollectionGroups.java (modified) (18 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/CollectionGroups.java

@@ -4 +4 @@
 
 import org.apache.log4j.Logger;
+import org.greenstone.gsdl3.util.DisplayItemUtil;
 import org.greenstone.gsdl3.util.GSFile;
 import org.greenstone.gsdl3.util.GSXML;
@@ -22 +23 @@
 
 import java.util.HashSet;
+import java.util.HashMap;
 import java.util.Iterator;
 
@@ -28 +30 @@
     private Element hierarchy = null;
     private Element groupDesc = null;
+  private HashMap<String, Element> group_descriptions_map = null; // new one for display items
 
     public static final String GROUP_CONTENT_SERVICE = "GroupCurrentContent";
+  // not used??
     public static final String UNIQUE_COLLECTIONS_SERVICE = "UniqueCollections";
+  // not used??
     public static final String COLLECTIONS_HIERARCHY_SERVICE = "CollectionsHierarchy";
-
+// hack, should be getting this from library servlet
+  private static final String DEFAULT_LANG = "en";
     static Logger logger = Logger.getLogger(org.greenstone.gsdl3.service.CollectionGroups.class.getName());
 
@@ -48 +54 @@
         }
 
+                group_descriptions_map = new HashMap<String, Element>();
         logger.info("Configuring CollectionGroups...");
         this.config_info = info;
@@ -69 +76 @@
         Element result = GSXML.createBasicResponse(doc, GSXML.SERVICE_TYPE_GROUPINFO);
         
-        
+        String lang = request.getAttribute(GSXML.LANG_ATT);
         // Get param list from request
         Element paramList = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
@@ -82 +89 @@
             }
         }
-        //Remove leading, ending / and dupliclated /
+        //Remove leading, ending / and duplicated /
         groupPath = groupPath.replaceAll("(/+)", "/");
         groupPath = groupPath.replaceAll("(^/+)|(/+$)", "");
@@ -132 +139 @@
                     Element currentGroup = (Element) currentContent.item(i);
                     String currentGroupName = currentGroup.getAttribute(GSXML.NAME_ATT);
-                    Element groupDescription = getGroupDescription(currentGroupName);
+                    Element groupDescription = getGroupDescription(doc, currentGroupName, lang);
                     
                     groupDescription.setAttribute(GSXML.POSITION_ATT, String.valueOf(i));
@@ -154 +161 @@
                 
             } else {
-                Element groupDescription = getPathInfo(groupPath);
+                          Element groupDescription = getPathInfo(groupPath, lang);
                 if (groupContent != null){
                     result.appendChild(doc.importNode(groupDescription, true));
@@ -235 +242 @@
         Document doc = XMLConverter.newDOM();
         UserContext userContext = new UserContext(request);
+                String lang = request.getAttribute(GSXML.LANG_ATT);
         // Prepare basic response
         Element result = GSXML.createBasicResponse(doc, GSXML.SERVICE_TYPE_GROUPINFO);
@@ -249 +257 @@
         //Get ungrouped collection list
         sanitizeCurrentContent(currentContent, searchableCollectionList);
-        addGroupInfo(currentContent, currentPath);
+        addGroupInfo(currentContent, currentPath, lang);
         addUngroupedCollections(currentContent, searchableCollectionList);
         addAllOption(currentContent);
@@ -271 +279 @@
     }
 
-    private void addGroupInfo(Element currentContent, String groupPath) {
+  private void addGroupInfo(Element currentContent, String groupPath, String lang) {
         NodeList groups = GSXML.getChildrenByTagName(currentContent,GSXML.GROUP_ELEM);
+                Document doc = currentContent.getOwnerDocument();
         for (int i=0;i<groups.getLength();i++){
             Element group = (Element) groups.item(i);
@@ -278 +287 @@
             String newPath = groupPath + "/" + name; 
             group.setAttribute(GSXML.PATH_ATT, newPath);
-            Element groupDescription = getGroupDescription(name);
+            Element groupDescription = getGroupDescription(doc, name, lang);
             Element titleEl = (Element) GSXML.getChildByTagName(groupDescription, GSXML.TITLE_ELEM);
             String title;
@@ -287 +296 @@
             }
             group.setAttribute(GSXML.TITLE_ELEM, title  );
-            addGroupInfo(group, newPath);
+            addGroupInfo(group, newPath, lang);
         }
         
@@ -401 +410 @@
     }
 
-    private void verifyGroupDescription(Document doc) {
+  private void verifyGroupDescription(Document doc) {
       if (groupDesc == null) {
         // we set up one for ourselves
@@ -419 +428 @@
                 groupTitle.setTextContent(name);
                 defaultDescription.appendChild(groupTitle);
+                                
+                                Element titleDisplayItem = DisplayItemUtil.createDisplayItem(doc, GSXML.DISPLAY_TEXT_NAME, DEFAULT_LANG, name);
+                                defaultDescription.appendChild(titleDisplayItem);
                 groupDesc.appendChild(defaultDescription);
             }
+                        Element this_di_list = doc.createElement("dummy");
+                        DisplayItemUtil.storeDisplayItems(this_di_list, foundDescription);
+                        group_descriptions_map.put(name, this_di_list);
         } 
         
     }
 
-    private Element getGroupDescription(String name) {
+    private Element getGroupDescriptionOld(String name) {
         Element description = (Element) GSXML.getNamedElement(groupDesc, GSXML.GROUP_ELEM, GSXML.NAME_ATT, name);
         if (description == null) {
@@ -432 +447 @@
         return description;
     }
+  private Element getGroupDescription(Document doc, String name, String lang) {
+    // get all the display items for group
+    Element all_di = group_descriptions_map.get(name);
+    Element new_di_list = doc.createElement(GSXML.GROUP_ELEM);
+    new_di_list.setAttribute(GSXML.NAME_ATT, name);
+    DisplayItemUtil.addLanguageSpecificDisplayItems(new_di_list, all_di, lang, DEFAULT_LANG, this.class_loader);
+
+    // now merge in the old style metadata - to be backwards compatible
+    Element old_style_desc = (Element) GSXML.getNamedElement(groupDesc, GSXML.GROUP_ELEM, GSXML.NAME_ATT, name);
+    if (old_style_desc != null) {
+      Element meta = (Element)GSXML.getChildByTagName(old_style_desc, "title");
+      if (meta != null) {
+        new_di_list.appendChild(doc.importNode(meta, true));
+      }
+      meta = (Element)GSXML.getChildByTagName(old_style_desc, "description");
+      if (meta != null) {
+        new_di_list.appendChild(doc.importNode(meta, true));
+      }
+      meta = (Element)GSXML.getChildByTagName(old_style_desc, "shortDescription");
+      if (meta != null) {
+        new_di_list.appendChild(doc.importNode(meta, true));
+      }    
+    }
+    return new_di_list;
+    
+  }
 
     private Element getUngroupedCollections(Element mr_collection_list) {
@@ -472 +513 @@
 
     }
-    private Element getPathInfo(String path) {
+  private Element getPathInfo(String path, String lang) {
 
         Document doc = XMLConverter.newDOM();
@@ -493 +534 @@
               }
               currentPath += pathSteps[i];
-                Element pathStepDescription = getGroupDescription(pathSteps[i]);
+                          Element pathStepDescription = getGroupDescription(doc, pathSteps[i], lang);
                 if (pathStepDescription != null){
                     pathStepDescription.setAttribute(GSXML.POSITION_ATT, String.valueOf(i));