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)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
other-projects/gs3-webservices-java-client/trunk/src/GS3DemoClient/org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.java
r21835 r22298 106 106 * collection, describing the collection (display items) as well as 107 107 * listing any services supported specifically by the collection. 108 * @param collection is the name of the collection to be described */108 * @param collection is the name of the collection to be described. */ 109 109 public String describeCollection(String collection); 110 110 … … 112 112 * collection's service, describing the service (display items). 113 113 * @param collection is the name of the collection to be described 114 * @param service is the name of the collection's service to be described */114 * @param service is the name of the collection's service to be described. */ 115 115 public String describeCollectionService(String collection, String service); 116 116 … … 125 125 * @param collection is the name of the collection 126 126 * @param docIDs is an array of document identifiers of documents whose 127 * metadata is requested */ 128 public String retrieveDocumentMetadata(String collection, String[] docIDs); 127 * metadata is requested 128 * @param metadata is the list of metadata elements to be retrieved for each doc */ 129 public String retrieveDocumentMetadata(String collection, String[] docIDs, String[] metadata); 129 130 130 131 /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML … … 132 133 * @param collection is the name of the collection 133 134 * @param docID is the document identifier of the document whose metadata is 134 * requested */ 135 public String retrieveDocumentMetadata(String collection, String docID); 135 * requested 136 * @param metadata is the list of metadata elements to be retrieved for each doc */ 137 public String retrieveDocumentMetadata(String collection, String docID, String[] metadata); 136 138 137 139 /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML … … 178 180 * structure is requested */ 179 181 public String retrieveDocumentStructure(String collection, String docID); 182 183 184 /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML 185 * containing the requested portion of the document structure of the documents 186 * indicated by docIDs: 187 * @param collection is the name of the collection 188 * @param docIDs is an array of document identifiers of documents whose 189 * hierarchical structures are requested 190 * @param structure - strings specifying the required structure of each document. 191 * It can be a combination of: ancestors, parent, siblings, children, descendants, entire. 192 * @param info - strings specifying the required structural info of each document. 193 * It can be any combination of: siblingPosition, numSiblings, numChildren. 194 */ 195 public String retrieveDocumentStructure(String collection, String[] docIDs, String[] structure, String[] info); 196 197 198 /** @return a String representing Greenstone3 DocumentMetadataRetrieve XML 199 * containing the requested portion of the document structure of the documents 200 * indicated by docIDs: 201 * @param collection is the name of the collection 202 * @param docID is the document identifier of the document whose hierarchical 203 * structure is requested 204 * @param structure - strings specifying the required structure of the document. 205 * It can be a combination of: ancestors, parent, siblings, children, descendants, entire. 206 * @param info - strings specifying the required structural info of the document. 207 * It can be any combination of: siblingPosition, numSiblings, numChildren. 208 */ 209 public String retrieveDocumentStructure(String collection, String docID, String[] structure, String[] info); 210 180 211 181 212 // UNUSED by the client, but still a very useful method: … … 205 236 * @param collection is the name of the collection 206 237 * @param service is the name of the browse service (=ClassifierBrowse usually) 207 */ 208 public String retrieveBrowseStructure( 209 String collection, String service, String[] classifierIDs); 238 * @param structure - the requested browse substructure. Can be any combination 239 * of ancestors, parent, siblings, children, descendants. 240 * @param info - the requested structural info. Can be numSiblings, siblingPosition, 241 * numChildren 242 */ 243 public String retrieveBrowseStructure(String collection, String service, 244 String[] classifierIDs, String[] structure, String[] info); 210 245 211 246 /** @return a String representing Greenstone3 … … 214 249 * @param nodeIDs is of the form CL#.# where the number (#) marks 215 250 * out structured sections like CL2.1.3. NodeIDs are generally subsections 216 * of top-level classifierNodes (CL#, e.g. CL3). 251 * of top-level classifierNodes (CL#, e.g. CL3). 252 * @param metafields are the classifier metadata fields that are to be returned. 217 253 * @param collection is the name of the collection 218 254 * @param service is the name of the Browse's MetadataRetrieve service 219 255 * (usually the browse service is ClassifierBrowse, in which case it always 220 256 * has a retrieve service called ClassifierBrowseMetadataRetrieve) */ 221 public String retrieveBrowseMetadata( 222 String collection, String service, String[] nodeIDs);257 public String retrieveBrowseMetadata(String collection, String service, 258 String[] nodeIDs, String[] metafields); 223 259 224 260 /** @return a String representing Greenstone3 XML for a query process
Note:
See TracChangeset
for help on using the changeset viewer.