Changeset 22298 for other-projects/gs3-webservices-java-client/trunk/src/GS3DemoClient/org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.java

Timestamp:

2010-06-23T15:44:44+12:00 (14 years ago)

Author:

ak19

Message:

Changes to get Fedora to work with Greenstone3: to let the Greenstone3 Reader Interface work with a Fedora Repository behind the scenes.

File:

• other-projects/gs3-webservices-java-client/trunk/src/GS3DemoClient/org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.java (modified) (7 diffs)

other-projects/gs3-webservices-java-client/trunk/src/GS3DemoClient/org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.java

@@ -106 +106 @@
      * collection, describing the collection (display items) as well as
      * listing any services supported specifically by the collection. 
-     * @param collection is the name of the collection to be described */
+     * @param collection is the name of the collection to be described. */
     public String describeCollection(String collection);
     
@@ -112 +112 @@
      * collection's service, describing the service (display items). 
      * @param collection is the name of the collection to be described
-     * @param service is the name of the collection's service to be described */
+     * @param service is the name of the collection's service to be described. */
     public String describeCollectionService(String collection, String service);
     
@@ -125 +125 @@
      * @param collection is the name of the collection 
      * @param docIDs is an array of document identifiers of documents whose  
-     * metadata is requested */
-    public String retrieveDocumentMetadata(String collection, String[] docIDs);
+     * metadata is requested 
+     * @param metadata is the list of metadata elements to be retrieved for each doc */
+    public String retrieveDocumentMetadata(String collection, String[] docIDs, String[] metadata);
     
     /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML 
@@ -132 +133 @@
      * @param collection is the name of the collection 
      * @param docID is the document identifier of the document whose metadata is 
-     * requested */
-    public String retrieveDocumentMetadata(String collection, String docID);
+     * requested 
+     * @param metadata is the list of metadata elements to be retrieved for each doc */
+    public String retrieveDocumentMetadata(String collection, String docID, String[] metadata);
 
     /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML 
@@ -178 +180 @@
      * structure is requested */
     public String retrieveDocumentStructure(String collection, String docID); 
+
+
+        /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML
+     * containing the requested portion of the document structure of the documents 
+     * indicated by docIDs: 
+     * @param collection is the name of the collection 
+     * @param docIDs is an array of document identifiers of documents whose
+     * hierarchical structures are requested 
+     * @param structure - strings specifying the required structure of each document. 
+     * It can be a combination of: ancestors, parent, siblings, children, descendants, entire.
+     * @param info - strings specifying the required structural info of each document. 
+     * It can be any combination of: siblingPosition, numSiblings, numChildren.
+    */
+    public String retrieveDocumentStructure(String collection, String[] docIDs, String[] structure, String[] info);
+
+
+        /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML
+     * containing the requested portion of the document structure of the documents 
+     * indicated by docIDs: 
+     * @param collection is the name of the collection 
+     * @param docID is the document identifier of the document whose hierarchical
+     * structure is requested
+     * @param structure - strings specifying the required structure of the document. 
+     * It can be a combination of: ancestors, parent, siblings, children, descendants, entire.
+     * @param info - strings specifying the required structural info of the document. 
+     * It can be any combination of: siblingPosition, numSiblings, numChildren.
+    */
+    public String retrieveDocumentStructure(String collection, String docID, String[] structure, String[] info);
+
 
     // UNUSED by the client, but still a very useful method:
@@ -205 +236 @@
      * @param collection is the name of the collection 
      * @param service is the name of the browse service (=ClassifierBrowse usually) 
-    */
-    public String retrieveBrowseStructure(
-            String collection, String service, String[] classifierIDs);
+     * @param structure - the requested browse substructure. Can be any combination
+     * of ancestors, parent, siblings, children, descendants.
+     * @param info - the requested structural info. Can be numSiblings, siblingPosition,
+     * numChildren
+    */
+    public String retrieveBrowseStructure(String collection, String service, 
+                          String[] classifierIDs, String[] structure, String[] info);
 
     /** @return a String representing Greenstone3 
@@ -214 +249 @@
      * @param nodeIDs is of the form CL#.# where the number (#) marks
      * out structured sections like CL2.1.3. NodeIDs are generally subsections
-     * of top-level classifierNodes (CL#, e.g. CL3). 
+     * of top-level classifierNodes (CL#, e.g. CL3).
+     * @param metafields are the classifier metadata fields that are to be returned.
      * @param collection is the name of the collection 
      * @param service is the name of the Browse's MetadataRetrieve service 
      * (usually the browse service is ClassifierBrowse, in which case it always
      * has a retrieve service called ClassifierBrowseMetadataRetrieve) */
-    public String retrieveBrowseMetadata(
-            String collection, String service, String[] nodeIDs);
+    public String retrieveBrowseMetadata(String collection, String service,
+                         String[] nodeIDs, String[] metafields);
     
     /** @return a String representing Greenstone3 XML for a query process