Changeset 22308

Timestamp:

2010-06-26T19:11:44+12:00 (14 years ago)

Author:

ak19

Message:

Implemented and tested Browse structure retrieve for 'siblings'.

File:

• other-projects/gs3-webservices-java-client/trunk/src/GS3Fedora/org/greenstone/fedora/services/FedoraGS3Connection.java (modified) (6 diffs)

other-projects/gs3-webservices-java-client/trunk/src/GS3Fedora/org/greenstone/fedora/services/FedoraGS3Connection.java

@@ -1783 +1783 @@
      * @param classifierID - the ID of the (sub)classifier. Can be CL1, CL1.x, where x is
      * a letter.
-     * @param structure - the requested browse substructure. Can be any combination
-     * of ancestors, parent, siblings, children, descendants. siblings not yet implemented.
+     * @param structure - the requested browse substructure. Can be any combination of
+     * ancestors, parent, siblings, children, descendants. 'siblings' not yet implemented.
      * @param info - the requested structural info. Can be numSiblings, siblingPosition,
      * numChildren.
@@ -1795 +1795 @@
     FedoraGS3RunException ex = null; //any RemoteException or UnsupportedEncodingException
 
-    // TODO
-    if(structure.indexOf("siblings") != -1) {
-        LOG.error("Structure: siblings. Not yet implemented\n");
-    }
-
     if(structure.indexOf("entire") != -1) {
         structure = structure + "ancestors|descendants";
@@ -1825 +1820 @@
         nodeStructure.appendChild(root);
         if(structure.indexOf("descendants") != -1) {
-        getTitlesByLetterStructure(collectionName, root, classifierID, true);
+        getTitlesByLetterStructure(collectionName, root, classifierID, true, null);
         } else if(structure.indexOf("children") != -1) {
-        getTitlesByLetterStructure(collectionName, root, classifierID, false);
+        getTitlesByLetterStructure(collectionName, root, classifierID, false, null);
         }
+        // nothing to be done for siblings
     } 
     else if(firstLevel == secondLevel) { // CL1.x, where x is a number
         
-        if(structure.indexOf("parent") != -1 || structure.indexOf("ancestors") != -1) {
+        if(structure.indexOf("parent") != -1 
+           || structure.indexOf("ancestors") != -1 
+           || structure.indexOf("siblings") != -1) {
         String toplevelID = classifierID.substring(0, firstLevel);
         Element toplevelNode = doc.createElement(GSXML.CLASS_NODE_ELEM);
@@ -1842 +1840 @@
         classifierNodeList.appendChild(toplevelNode);
         toplevelNode.appendChild(nodeStructure);        
-           
         nodeStructure.appendChild(node);
-        node.appendChild(classNode);
+
+        if(structure.indexOf("siblings") != -1) { // get the children of the parents too
+            getTitlesByLetterStructure(collectionName, node, toplevelID, false, classNode);
+            // pass the requested node (classNode) so that it is attached in the correct 
+            // location among its siblings, and to ensure that it is not recreated.
+            // getTitlesByLetterStructure() will append classNode to node
+        } else {
+            node.appendChild(classNode);
+        }
         } else {
         Element node = (Element)classNode.cloneNode(true);
@@ -1926 +1931 @@
      * @param getDescendants - if true, get descendants of any documents found, otherwise
      * get just the children.
+     * @param wantedSibling - the node (already created) whose siblings are requested. We
+     * need to make sure not to recreate this node when creating its sibling nodes.
      * @return the given classifierNode, with the CL.x subclassifiers for the letters of
      * the alphabet that are represented in the document titles.
      */
     public Element getTitlesByLetterStructure(String collectionName, Element classifierNode,
-                           String classifierID, boolean getDescendants) 
-    {
+                          String classifierID, boolean getDescendants, 
+                          Element wantedSibling) 
+    {   
+    String ID = "";
+    if(wantedSibling != null) { // the pre-created classifier node whose siblings were requested
+        ID = wantedSibling.getAttribute(GSXML.NODE_ID_ATT);
+    }
+    
     Document doc = classifierNode.getOwnerDocument();
     FedoraGS3RunException ex = null; // any RemoteException or UnsupportedEncodingException
@@ -1946 +1959 @@
             continue; // skip letters that don't have any kids
         }
-        
-        // <classifierNode nodeID="CL1.x">
-        Element subClassifier = doc.createElement(GSXML.CLASS_NODE_ELEM);
-        Attr attribute = doc.createAttribute(GSXML.NODE_ID_ATT);
-        attribute.setValue(classifierID+"."+count);
-        subClassifier.setAttributeNode(attribute);
-        classifierNode.appendChild(subClassifier);
+        Element subClassifier = null;
+        if(wantedSibling != null && ID.equals(classifierID+"."+count)) {
+                // already have the requested node, don't recreate it
+            subClassifier = wantedSibling;
+        } else {
+            // <classifierNode nodeID="CL1.x">
+            subClassifier = doc.createElement(GSXML.CLASS_NODE_ELEM);
+            Attr attribute = doc.createAttribute(GSXML.NODE_ID_ATT);
+            attribute.setValue(classifierID+"."+count);
+            subClassifier.setAttributeNode(attribute);
+        }
+        classifierNode.appendChild(subClassifier); // either way, append the subClassifier node
         
         if(getDescendants) { // get the documents