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

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

@@ -76 +76 @@
      * @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) {
-        return this.getDocumentMetadata(docIDs);
+     * metadata is requested 
+     * @param metadata is the list of metadata elements requested. If "all" is specified
+     * then all metadata is requested. */
+    public String retrieveDocumentMetadata(String collection, String[] docIDs, String[] metadata) {
+    return this.getDocumentMetadata(docIDs, metadata);
     }
     
@@ -85 +87 @@
      * @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) {
-        return this.getDocumentMetadata(docID);
+     * requested.
+     * @param metadata is the list of metadata elements requested. If "all" is specified
+     * then all metadata is requested. */
+    public String retrieveDocumentMetadata(String collection, String docID, String[] metadata) {
+        return this.getDocumentMetadata(docID, metadata);
     }
 
@@ -96 +100 @@
      * are requested */
     public String retrieveTitleMetadata(String collection, String[] docIDs) {
-        return this.getTitleMetadata(docIDs);
+        return this.getDocumentMetadata(docIDs, new String[] {"Title"});
     }
     
@@ -105 +109 @@
      * requested */
     public String retrieveTitleMetadata(String collection, String docID) {
-        return this.getTitleMetadata(docID);
+        return this.getDocumentMetadata(docID, new String[] {"Title"});
     }
 
@@ -134 +138 @@
      * hierarchical structures are requested */
     public String retrieveDocumentStructure(String collection, String[] docIDs) {
-        return this.getDocumentStructure(docIDs);
+        return this.getDocumentStructure(docIDs, new String[]{"descendants"}, new String[]{""});
     }
     
@@ -144 +148 @@
      * structure is requested*/
     public String retrieveDocumentStructure(String collection, String docID) {
-        return this.getDocumentStructure(docID);
+        return this.getDocumentStructure(docID, new String[]{"descendants"}, new String[]{""});
     }
 
@@ -156 +160 @@
      * hierarchical structures are requested */
     public String retrieveDocumentChildren(String collection, String[] docIDs) {
-        return this.getChildren(docIDs);
+        return this.getDocumentStructure(docIDs, new String[]{"children"}, new String[]{""});
     }
     
@@ -166 +170 @@
      * structure is requested */
     public String retrieveDocumentChildren(String collection, String docID) {
-        return this.getChildren(docID);
-    }
-    
-    /** @return a String representing Greenstone3 ClassifierBrowse XML 
+        return this.getDocumentStructure(docID, new String[]{"children"}, new String[]{""});
+    }
+    
+    /** @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. It's already included in the
+     * docID for a Fedora DL.
+     * @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 this.getDocumentStructure(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. It's already included in the
+     * docID for a Fedora DL.
+     * @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 this.getDocumentStructure(docID, structure, info);
+    }
+
+
+    /** @return a String representing Greenstone3 ClassifierBrowse XML 
      * giving the entire *structure* of the classification denoted by 
      * classifierID (including the structures of document descendents of 
@@ -177 +215 @@
      * @param collection is the name of the collection 
      * @param service is the name of the browse service (=ClassifierBrowse usually)
+     * @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) 
+    public String retrieveBrowseStructure(String collection, String service, String[] classifierIDs, 
+            String[] structure, String[] info) 
     {
-        return this.browse(collection, classifierIDs);
+        return this.browse(collection, classifierIDs, structure, info);
     }
 
@@ -190 +232 @@
      * 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.browseMetadataRetrieve(nodeIDs);
+        return this.browseMetadataRetrieve(nodeIDs, metafields);
     }