Changeset 22298 for other-projects/gs3-webservices-java-client/trunk/src/GS3DemoClient/org/greenstone/gs3client/dlservices/GS3ServicesAPIA.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/GS3ServicesAPIA.java (modified) (7 diffs)

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

@@ -254 +254 @@
      * @return a String representing Greenstone3 DocumentMetadataRetrieve XML 
      * containing all the metadata of all the documents indicated by docIDs 
-    */
-    public String retrieveDocumentMetadata(String collection, String[] docIDs) {
-        return this.retrieveAllDocumentMetadata(collection, language, docIDs);
+     * @param metadata is the list of metadata elements to be retrieved for each doc.
+    */
+    public String retrieveDocumentMetadata(String collection, String[] docIDs, String[] metafields) {
+        return this.retrieveDocumentMetadata(collection, language, docIDs, metafields);
     }
     
@@ -266 +267 @@
      * @return a String representing Greenstone3 DocumentMetadataRetrieve XML 
      * containing all the metadata of the document denoted by docID 
-    */
-    public String retrieveDocumentMetadata(String collection, String docID) {
-        return this.retrieveAllDocumentMetadata(collection, language, 
-                new String[] { docID });
+     * @param metadata is the list of metadata elements to be retrieved for each doc.
+    */
+    public String retrieveDocumentMetadata(String collection, String docID, String[] metafields) {
+        return this.retrieveDocumentMetadata(collection, language, 
+                            new String[] { docID }, metafields);
     }
     
@@ -298 +300 @@
                 new String[] { docID }, titleMetaName);
     }
+
+    /** @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 retrieveDocumentStructure(collection, language, docIDs, structure, 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) {
+    return retrieveDocumentStructure(collection, language, 
+                  new String[] {docID}, structure, info);
+    }
     
     /** Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface 
@@ -310 +344 @@
         return this.retrieveEntireDocumentStructure(collection, language, docIDs);
     }
+
     /** Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface 
      * contract.
@@ -322 +357 @@
                 new String[] { docID });
     }
+
     
     /** Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface 
@@ -360 +396 @@
      * @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 this.browseDescendants(collection, service, 
-                language, classifierIDs );
+        return this.browse(collection, service, language, classifierIDs, structure, info);
     }
     
@@ -376 +415 @@
      * out structured sections like CL2.1.3. NodeIDs are generally subsections
      * 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 this.retrieveAllBrowseMetadata(collection, service, 
-                language, nodeIDs);
+        return this.retrieveBrowseMetadata(collection, service, language, nodeIDs, metafields);
     }