Changeset 22300 for other-projects/gs3-webservices-java-client/trunk/src/GS3Fedora/org/greenstone/fedora/services/FedoraGS3DL.java

Timestamp:

2010-06-24T13:45:34+12:00 (14 years ago)

Author:

ak19

Message:

1. Changes to get Fedora to work with Greenstone3: to let the Greenstone3 Reader Interface work with a Fedora Repository behind the scenes. 2. No longer returns XML Strings formatted for display, but unformatted, since when it's converted to XML DOM on the Greenstone end, new lines introduced due to whitespace interfere with Greenstone 3's default parsing of the XML.

File:

• other-projects/gs3-webservices-java-client/trunk/src/GS3Fedora/org/greenstone/fedora/services/FedoraGS3DL.java (modified) (1 diff)

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

@@ -331 +331 @@
     /* METHODS FOR GETTING THE STRUCTURE OF DOCUMENTS */
 
-    /** @return the XML content of the TOC of just that portion of the TOC which   
-     * contains the section denoted by sectionID and its direct child subsections. 
-     * The children are returned in the order they are encountered, which 
-     * happens to be in the required order of ascending sectionID. 
-     * @param docPID is a fedora pid identifying a greenstone document object.
-     * @param sectionID identifies the particular section in the
-     * document denoted by docPID, may be a section name or number. */
-    public Element getChildrenOfSectionXML(String docPID, String sectionID)
-        throws RemoteException, UnsupportedEncodingException, 
-            SAXException, IOException;
-
-    /** @return a string representing the XML content of the TOC of just
-     * that portion of the TOC which contains the section denoted by sectionID  
-     * and its direct child subsections. 
-     * The children are returned in the order they are encountered, which 
-     * happens to be in the required order of ascending sectionID. 
-     * @param docPID is a fedora pid identifying a greenstone document object.
-     * @param sectionID identifies the particular section in the
-     * document denoted by docPID, may be a section name or number. */
-    public String getChildrenOfSection(String docPID, String sectionID)
-        throws RemoteException, UnsupportedEncodingException, 
-            SAXException, IOException, TransformerException;
-
     /** @return the part of the TOC XML file (which outlines doc structure)  
      * relating to the given section. This includes the section denoted by
      * sectionID as well as all descendent subsections thereof. 
-     * @param docPID is a fedora pid identifying a greenstone document object.
-     * @param sectionID identifies the particular section in the
-     * document denoted by docPID, may be a section name or number. */
-    public Element getSubsectionXML(String docPID, String sectionID)
-        throws RemoteException, UnsupportedEncodingException, 
-            SAXException, IOException;
-
-    /** @return a String representation of the part of the TOC XML file   
-     * (which outlines doc structure) relating to the given section. This    
-     * includes the section denoted by sectionID as well as all descendent  
-     * subsections thereof.
-     * @param docPID is a fedora pid identifying a greenstone document object.
-     * @param sectionID identifies the particular section in the
-     * document denoted by docPID, may be a section name or number. */
-    public String getSubsection(String docPID, String sectionID)
-        throws RemoteException, UnsupportedEncodingException, SAXException,  
-            IOException, TransformerException;
+     * @param docPID - a fedora pid identifying a greenstone document object.
+     * @param sectionID - identifies the particular section in the
+     * document denoted by docPID, may be a section name or number. 
+     * @param structure can contain any combination of: ancestors, parent, 
+     * siblings, children, descendants, entire, specifying the portion of 
+     * the structure to retrieve.
+     * @param info can contain any combination of: siblingPosition, numSiblings, 
+     * numChildren, requesting additional information about the structure. */
+    public Element getSectionStructureXML(String docPID, String sectionID, String structure, String info)
+        throws RemoteException, UnsupportedEncodingException, SAXException, IOException;
 
     /* BROWSING */