source: other-projects/trunk/gs3-webservices-democlient/docs/GS3DemoClient/org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html@ 15490

Last change on this file since 15490 was 15490, checked in by ak19, 16 years ago

Updated docs significantly
File size: 45.7 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.5.0_10) on Thu May 15 13:34:11 NZST 2008 -->
6<TITLE>
7FedoraServicesAPIA
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.dlservices.FedoraServicesAPIA class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="FedoraServicesAPIA";
18}
19</SCRIPT>
20<NOSCRIPT>
21</NOSCRIPT>
22
23</HEAD>
24
25<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28<!-- ========= START OF TOP NAVBAR ======= -->
29<A NAME="navbar_top"><!-- --></A>
30<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32<TR>
33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34<A NAME="navbar_top_firstrow"><!-- --></A>
35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45</TABLE>
46</TD>
47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48</EM>
49</TD>
50</TR>
51
52<TR>
53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54&nbsp;<A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.CancelException.html" title="class in org.greenstone.gs3client.dlservices"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices"><B>NEXT CLASS</B></A></FONT></TD>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../../index.html?org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="FedoraServicesAPIA.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59&nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
63 }
64 //-->
65</SCRIPT>
66<NOSCRIPT>
67 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
68</NOSCRIPT>
69
70
71</FONT></TD>
72</TR>
73<TR>
74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.greenstone.fedora.services.FedoraGS3Connection">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
78</TR>
79</TABLE>
80<A NAME="skip-navbar_top"></A>
81<!-- ========= END OF TOP NAVBAR ========= -->
82
83<HR>
84<!-- ======== START OF CLASS DATA ======== -->
85<H2>
86<FONT SIZE="-1">
87org.greenstone.gs3client.dlservices</FONT>
88<BR>
89Class FedoraServicesAPIA</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.greenstone.fedora.services.FedoraConnection
93 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.greenstone.fedora.services.FedoraGS3Connection
94 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.dlservices.FedoraServicesAPIA</B>
95</PRE>
96<DL>
97<DT><B>All Implemented Interfaces:</B> <DD>org.greenstone.fedora.services.FedoraGS3DL, org.greenstone.fedora.services.FedoraToGS3Interface, org.greenstone.fedora.services.FedoraToGS3Interface.Constants, <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></DD>
98</DL>
99<HR>
100<DL>
101<DT><PRE>public class <B>FedoraServicesAPIA</B><DT>extends org.greenstone.fedora.services.FedoraGS3Connection<DT>implements <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></DL>
102</PRE>
103
104<P>
105FedoraServicesAPIA implements DigitalLibraryServicesAPIA for enabling the
106 Java-client to access a Fedora repository of Greenstone digital objects.
107 This is made possible by its use of the FedoraGS3.jar file's functionality,
108 as made available through the FedoraGS3Connection class.
109<P>
110
111<P>
112<DL>
113<DT><B>Author:</B></DT>
114 <DD>ak19</DD>
115</DL>
116<HR>
117
118<P>
119<!-- ======== NESTED CLASS SUMMARY ======== -->
120
121<A NAME="nested_class_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Nested Class Summary</B></FONT></TH>
126</TR>
127</TABLE>
128&nbsp;<A NAME="nested_classes_inherited_from_class_org.greenstone.gs3client.dlservices.DigitalLibraryServicesAPIA"><!-- --></A>
129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
131<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.greenstone.gs3client.dlservices.<A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></B></TH>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.CancelException.html" title="class in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA.CancelException</A></CODE></TD>
135</TR>
136</TABLE>
137&nbsp;
138<A NAME="nested_classes_inherited_from_class_org.greenstone.fedora.services.FedoraToGS3Interface"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
141<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.greenstone.fedora.services.FedoraToGS3Interface</B></TH>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD><CODE>org.greenstone.fedora.services.FedoraToGS3Interface.Constants</CODE></TD>
145</TR>
146</TABLE>
147&nbsp;
148<!-- =========== FIELD SUMMARY =========== -->
149
150<A NAME="field_summary"><!-- --></A>
151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
153<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
154<B>Field Summary</B></FONT></TH>
155</TR>
156</TABLE>
157&nbsp;<A NAME="fields_inherited_from_class_org.greenstone.fedora.services.FedoraGS3Connection"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
160<TH ALIGN="left"><B>Fields inherited from class org.greenstone.fedora.services.FedoraGS3Connection</B></TH>
161</TR>
162<TR BGCOLOR="white" CLASS="TableRowColor">
163<TD><CODE>CHILDREN, DESCENDANTS, fedoraGSearch, gSearchWSDLSuffix, gSearchWSDLURL, serviceNames, SERVICES</CODE></TD>
164</TR>
165</TABLE>
166&nbsp;<A NAME="fields_inherited_from_class_org.greenstone.fedora.services.FedoraConnection"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
169<TH ALIGN="left"><B>Fields inherited from class org.greenstone.fedora.services.FedoraConnection</B></TH>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD><CODE>APIA, baseURL, builder, defaultPortAddressSuffix, fedoraVersion, GET, INTERNAL_NODE, lang, maxresults, portAddressSuffix, SUPPORTED_VERSION, TYPE</CODE></TD>
173</TR>
174</TABLE>
175&nbsp;<A NAME="fields_inherited_from_class_org.greenstone.gs3client.dlservices.DigitalLibraryServicesAPIA"><!-- --></A>
176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
178<TH ALIGN="left"><B>Fields inherited from interface org.greenstone.gs3client.dlservices.<A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></B></TH>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#propertiesFile">propertiesFile</A></CODE></TD>
182</TR>
183</TABLE>
184&nbsp;<A NAME="fields_inherited_from_class_org.greenstone.fedora.services.FedoraToGS3Interface.Constants"><!-- --></A>
185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
187<TH ALIGN="left"><B>Fields inherited from interface org.greenstone.fedora.services.FedoraToGS3Interface.Constants</B></TH>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD><CODE>ALL_FIELDS, ALL_TITLES, ASSOCFILEPREFIX, COMMA, DOC_TITLES, FIELDNAME_ATT, FULLTEXT, GS3FilePathMacro, MAXDOCS, NUM_DOCS_MATCHED, OCCURS_ATT, QUERY, SIMPLEFIELD_ATT</CODE></TD>
191</TR>
192</TABLE>
193&nbsp;<A NAME="fields_inherited_from_class_org.greenstone.fedora.services.FedoraGS3DL"><!-- --></A>
194<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
196<TH ALIGN="left"><B>Fields inherited from interface org.greenstone.fedora.services.FedoraGS3DL</B></TH>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD><CODE>_COLLECTION, COLLECTION, COLLECTIONNAME, COLON, DC, DLS, ENGLISH, EX, FEDORA_GS3, GREENSTONE, GREENSTONE_, HYPHEN, ID, METADATA, NAME, PERIOD, QUALIFIER, SECTION, SECTION_ELEMENT, TITLE, TOC, UTF8, WILDCARD</CODE></TD>
200</TR>
201</TABLE>
202&nbsp;
203<!-- ======== CONSTRUCTOR SUMMARY ======== -->
204
205<A NAME="constructor_summary"><!-- --></A>
206<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
207<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
208<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
209<B>Constructor Summary</B></FONT></TH>
210</TR>
211<TR BGCOLOR="white" CLASS="TableRowColor">
212<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#FedoraServicesAPIA()">FedoraServicesAPIA</A></B>()</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor</TD>
216</TR>
217</TABLE>
218&nbsp;
219<!-- ========== METHOD SUMMARY =========== -->
220
221<A NAME="method_summary"><!-- --></A>
222<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
223<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
224<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
225<B>Method Summary</B></FONT></TH>
226</TR>
227<TR BGCOLOR="white" CLASS="TableRowColor">
228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
230<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#describe()">describe</A></B>()</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#getAssocFileBaseURL(org.greenstone.gs3client.data.DocumentNodeData)">getAssocFileBaseURL</A></B>(<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</CODE>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#getDisplayName()">getDisplayName</A></B>()</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#query(java.lang.String, java.lang.String, java.util.Map)">query</A></B>(java.lang.String&nbsp;collection,
255 java.lang.String&nbsp;service,
256 java.util.Map&nbsp;nameValParamsMap)</CODE>
257
258<BR>
259&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
260</TR>
261<TR BGCOLOR="white" CLASS="TableRowColor">
262<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
263<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
264<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveBrowseMetadata</A></B>(java.lang.String&nbsp;collection,
265 java.lang.String&nbsp;service,
266 java.lang.String[]&nbsp;nodeIDs)</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
274<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveBrowseStructure(java.lang.String, java.lang.String, java.lang.String)">retrieveBrowseStructure</A></B>(java.lang.String&nbsp;collection,
275 java.lang.String&nbsp;service,
276 java.lang.String&nbsp;classifierID)</CODE>
277
278<BR>
279&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
280</TR>
281<TR BGCOLOR="white" CLASS="TableRowColor">
282<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
284<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String)">retrieveDocumentChildren</A></B>(java.lang.String&nbsp;collection,
285 java.lang.String&nbsp;docID)</CODE>
286
287<BR>
288&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
292<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
293<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String[])">retrieveDocumentChildren</A></B>(java.lang.String&nbsp;collection,
294 java.lang.String[]&nbsp;docIDs)</CODE>
295
296<BR>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
298</TR>
299<TR BGCOLOR="white" CLASS="TableRowColor">
300<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
302<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String)">retrieveDocumentContent</A></B>(java.lang.String&nbsp;collection,
303 java.lang.String&nbsp;docID)</CODE>
304
305<BR>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
311<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String[])">retrieveDocumentContent</A></B>(java.lang.String&nbsp;collection,
312 java.lang.String[]&nbsp;docIDs)</CODE>
313
314<BR>
315&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
316</TR>
317<TR BGCOLOR="white" CLASS="TableRowColor">
318<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
320<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String)">retrieveDocumentMetadata</A></B>(java.lang.String&nbsp;collection,
321 java.lang.String&nbsp;docID)</CODE>
322
323<BR>
324&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
325</TR>
326<TR BGCOLOR="white" CLASS="TableRowColor">
327<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
328<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
329<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String[])">retrieveDocumentMetadata</A></B>(java.lang.String&nbsp;collection,
330 java.lang.String[]&nbsp;docIDs)</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
334</TR>
335<TR BGCOLOR="white" CLASS="TableRowColor">
336<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
338<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String)">retrieveDocumentStructure</A></B>(java.lang.String&nbsp;collection,
339 java.lang.String&nbsp;docID)</CODE>
340
341<BR>
342&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
343</TR>
344<TR BGCOLOR="white" CLASS="TableRowColor">
345<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
346<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
347<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String[])">retrieveDocumentStructure</A></B>(java.lang.String&nbsp;collection,
348 java.lang.String[]&nbsp;docIDs)</CODE>
349
350<BR>
351&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
352</TR>
353<TR BGCOLOR="white" CLASS="TableRowColor">
354<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
355<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
356<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String)">retrieveTitleMetadata</A></B>(java.lang.String&nbsp;collection,
357 java.lang.String&nbsp;docID)</CODE>
358
359<BR>
360&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
361</TR>
362<TR BGCOLOR="white" CLASS="TableRowColor">
363<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
364<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
365<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String[])">retrieveTitleMetadata</A></B>(java.lang.String&nbsp;collection,
366 java.lang.String[]&nbsp;docIDs)</CODE>
367
368<BR>
369&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
370</TR>
371</TABLE>
372&nbsp;<A NAME="methods_inherited_from_class_org.greenstone.fedora.services.FedoraGS3Connection"><!-- --></A>
373<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
374<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
375<TH ALIGN="left"><B>Methods inherited from class org.greenstone.fedora.services.FedoraGS3Connection</B></TH>
376</TR>
377<TR BGCOLOR="white" CLASS="TableRowColor">
378<TD><CODE>addMetadataWithFixedTagName, addMetadataWithNamespacedTagNames, browse, browseMetadataRetrieve, containsSectionNumber, createClassifierElement, createDocNodeFromSubsection, createDocStructure, createNameValuePairElement, createResponseMessage, createServiceList, describeCollection, describeCollectionService, describeCollectionServices, describeFieldQueryService, describeService, describeTextQueryService, fieldQuery, getChildren, getChildren, getCollectionList, getCollectionMetadata, getCollectionMetadata, getContent, getContent, getContentBody, getDocPIDFromDocID, getDocumentMetadata, getDocumentMetadata, getDocumentStructure, getDocumentStructure, getGSearchWSDLURL, getMetadata, getMetadata, getSectionIDFromDocID, getServiceList, getServiceNames, getStructure, getStructure, getStructureElement, getTitleMetadata, getTitleMetadata, getTitleMetadata, initSearchFunctionality, main, setGSearchWSDLURL, setInitialisationProperties, textQuery</CODE></TD>
379</TR>
380</TABLE>
381&nbsp;<A NAME="methods_inherited_from_class_org.greenstone.fedora.services.FedoraConnection"><!-- --></A>
382<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
383<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
384<TH ALIGN="left"><B>Methods inherited from class org.greenstone.fedora.services.FedoraConnection</B></TH>
385</TR>
386<TR BGCOLOR="white" CLASS="TableRowColor">
387<TD><CODE>browseTitlesByLetter, convertToMetaNumber, createAPIA, findObjectsWithTitlesContaining, getAssocFileBaseURL, getBaseURL, getChildrenOfSection, getChildrenOfSectionXML, getCollectionDocs, getCollectionName, getCollectionNames, getCollectionPID, getCollectionPIDs, getCollections, getCollectionTitle, getCollectionTitles, getDC, getDLS, getDocName, getDocTitle, getDocTitles, getEX, getFedoraVersion, getItem, getLanguage, getMaxResults, getPortAddressURL, getSection, getSectionDCMetadata, getSectionEXMetadata, getSectionNames, getSectionNumbers, getSectionTitle, getSectionTitles, getSubsection, getSubsectionXML, getSubstructure, getSupportedVersion, getTitle, getTitle, getTitles, getTOC, init, removePrefix, searchDocumentTitles, setLanguage, setMaxResults, showAuthenticationPopup</CODE></TD>
388</TR>
389</TABLE>
390&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
391<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
392<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
393<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
394</TR>
395<TR BGCOLOR="white" CLASS="TableRowColor">
396<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
397</TR>
398</TABLE>
399&nbsp;<A NAME="methods_inherited_from_class_org.greenstone.gs3client.dlservices.DigitalLibraryServicesAPIA"><!-- --></A>
400<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
401<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
402<TH ALIGN="left"><B>Methods inherited from interface org.greenstone.gs3client.dlservices.<A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></B></TH>
403</TR>
404<TR BGCOLOR="white" CLASS="TableRowColor">
405<TD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeCollection(java.lang.String)">describeCollection</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeCollectionService(java.lang.String, java.lang.String)">describeCollectionService</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeService(java.lang.String)">describeService</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getAssocFileBaseURL()">getAssocFileBaseURL</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getLanguage()">getLanguage</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#setLanguage(java.lang.String)">setLanguage</A></CODE></TD>
406</TR>
407</TABLE>
408&nbsp;
409<P>
410
411<!-- ========= CONSTRUCTOR DETAIL ======== -->
412
413<A NAME="constructor_detail"><!-- --></A>
414<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
415<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
416<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
417<B>Constructor Detail</B></FONT></TH>
418</TR>
419</TABLE>
420
421<A NAME="FedoraServicesAPIA()"><!-- --></A><H3>
422FedoraServicesAPIA</H3>
423<PRE>
424public <B>FedoraServicesAPIA</B>()
425 throws java.lang.Exception</PRE>
426<DL>
427<DD>Default constructor
428<P>
429<DL>
430
431<DT><B>Throws:</B>
432<DD><CODE>java.lang.Exception</CODE></DL>
433</DL>
434
435<!-- ============ METHOD DETAIL ========== -->
436
437<A NAME="method_detail"><!-- --></A>
438<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
439<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
440<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
441<B>Method Detail</B></FONT></TH>
442</TR>
443</TABLE>
444
445<A NAME="getDisplayName()"><!-- --></A><H3>
446getDisplayName</H3>
447<PRE>
448public java.lang.String <B>getDisplayName</B>()</PRE>
449<DL>
450<DD><DL>
451<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getDisplayName()">getDisplayName</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
452</DD>
453<DD><DL>
454
455<DT><B>Returns:</B><DD>the name of this digital library for displaying in the client</DL>
456</DD>
457</DL>
458<HR>
459
460<A NAME="getAssocFileBaseURL(org.greenstone.gs3client.data.DocumentNodeData)"><!-- --></A><H3>
461getAssocFileBaseURL</H3>
462<PRE>
463public java.lang.String <B>getAssocFileBaseURL</B>(<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</PRE>
464<DL>
465<DD><DL>
466<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getAssocFileBaseURL(org.greenstone.gs3client.data.DocumentNodeData)">getAssocFileBaseURL</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
467</DD>
468<DD><DL>
469
470<DT><B>Returns:</B><DD>the directory path to the associated files of the given document
471 node. For instance, the base url of a JEditorPane's HTML documents can be
472 set to this.</DL>
473</DD>
474</DL>
475<HR>
476
477<A NAME="describe()"><!-- --></A><H3>
478describe</H3>
479<PRE>
480public java.lang.String <B>describe</B>()</PRE>
481<DL>
482<DD><DL>
483<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describe()">describe</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
484</DD>
485<DD><DL>
486
487<DT><B>Returns:</B><DD>Greenstone3 XML describe response message with information
488 about collections contained and services (and any serviceRacks) supported
489 by the Digital library.</DL>
490</DD>
491</DL>
492<HR>
493
494<A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String[])"><!-- --></A><H3>
495retrieveDocumentMetadata</H3>
496<PRE>
497public java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String&nbsp;collection,
498 java.lang.String[]&nbsp;docIDs)</PRE>
499<DL>
500<DD><DL>
501<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String[])">retrieveDocumentMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
502</DD>
503<DD><DL>
504<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose
505 metadata is requested
506<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
507 containing all the metadata of all the documents indicated by docIDs</DL>
508</DD>
509</DL>
510<HR>
511
512<A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
513retrieveDocumentMetadata</H3>
514<PRE>
515public java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String&nbsp;collection,
516 java.lang.String&nbsp;docID)</PRE>
517<DL>
518<DD><DL>
519<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String)">retrieveDocumentMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
520</DD>
521<DD><DL>
522<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is the document identifier of the document whose metadata is
523 requested
524<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
525 containing all the metadata of the document denoted by docID</DL>
526</DD>
527</DL>
528<HR>
529
530<A NAME="retrieveTitleMetadata(java.lang.String, java.lang.String[])"><!-- --></A><H3>
531retrieveTitleMetadata</H3>
532<PRE>
533public java.lang.String <B>retrieveTitleMetadata</B>(java.lang.String&nbsp;collection,
534 java.lang.String[]&nbsp;docIDs)</PRE>
535<DL>
536<DD><DL>
537<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String[])">retrieveTitleMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
538</DD>
539<DD><DL>
540<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose titles
541 are requested
542<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
543 containing only the title metadata of the documents denoted by docIDs</DL>
544</DD>
545</DL>
546<HR>
547
548<A NAME="retrieveTitleMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
549retrieveTitleMetadata</H3>
550<PRE>
551public java.lang.String <B>retrieveTitleMetadata</B>(java.lang.String&nbsp;collection,
552 java.lang.String&nbsp;docID)</PRE>
553<DL>
554<DD><DL>
555<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String)">retrieveTitleMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
556</DD>
557<DD><DL>
558<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is the document identifier of the document whose titles is
559 requested
560<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
561 containing only the title metadata of the document denoted by docID</DL>
562</DD>
563</DL>
564<HR>
565
566<A NAME="retrieveDocumentContent(java.lang.String, java.lang.String[])"><!-- --></A><H3>
567retrieveDocumentContent</H3>
568<PRE>
569public java.lang.String <B>retrieveDocumentContent</B>(java.lang.String&nbsp;collection,
570 java.lang.String[]&nbsp;docIDs)</PRE>
571<DL>
572<DD><DL>
573<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String[])">retrieveDocumentContent</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
574</DD>
575<DD><DL>
576<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose (text)
577 contents are requested
578<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentContentRetrieve XML
579 containing the document contents of the documents indicated by docIDs</DL>
580</DD>
581</DL>
582<HR>
583
584<A NAME="retrieveDocumentContent(java.lang.String, java.lang.String)"><!-- --></A><H3>
585retrieveDocumentContent</H3>
586<PRE>
587public java.lang.String <B>retrieveDocumentContent</B>(java.lang.String&nbsp;collection,
588 java.lang.String&nbsp;docID)</PRE>
589<DL>
590<DD><DL>
591<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String)">retrieveDocumentContent</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
592</DD>
593<DD><DL>
594<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is the document identifier of the document whose (text)
595 content is requested
596<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentContentRetrieve XML
597 containing the document contents of the document indicated by docID</DL>
598</DD>
599</DL>
600<HR>
601
602<A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String[])"><!-- --></A><H3>
603retrieveDocumentStructure</H3>
604<PRE>
605public java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String&nbsp;collection,
606 java.lang.String[]&nbsp;docIDs)</PRE>
607<DL>
608<DD><DL>
609<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String[])">retrieveDocumentStructure</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
610</DD>
611<DD><DL>
612<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose
613 hierarchical structures are requested
614<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
615 containing the document structure of the documents indicated by docIDs:
616 this means all their descendents</DL>
617</DD>
618</DL>
619<HR>
620
621<A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String)"><!-- --></A><H3>
622retrieveDocumentStructure</H3>
623<PRE>
624public java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String&nbsp;collection,
625 java.lang.String&nbsp;docID)</PRE>
626<DL>
627<DD><DL>
628<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String)">retrieveDocumentStructure</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
629</DD>
630<DD><DL>
631<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is the document identifier of the document whose hierarchical
632 structure is requested
633<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
634 containing the document structure of the document indicated by docID:
635 this means all its descendents</DL>
636</DD>
637</DL>
638<HR>
639
640<A NAME="retrieveDocumentChildren(java.lang.String, java.lang.String[])"><!-- --></A><H3>
641retrieveDocumentChildren</H3>
642<PRE>
643public java.lang.String <B>retrieveDocumentChildren</B>(java.lang.String&nbsp;collection,
644 java.lang.String[]&nbsp;docIDs)</PRE>
645<DL>
646<DD><DL>
647<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String[])">retrieveDocumentChildren</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
648</DD>
649<DD><DL>
650<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose
651 hierarchical structures are requested
652<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
653 containing a view of the document structure of the documents denoted by
654 docs where only the requested documents and their direct children are
655 returned.</DL>
656</DD>
657</DL>
658<HR>
659
660<A NAME="retrieveDocumentChildren(java.lang.String, java.lang.String)"><!-- --></A><H3>
661retrieveDocumentChildren</H3>
662<PRE>
663public java.lang.String <B>retrieveDocumentChildren</B>(java.lang.String&nbsp;collection,
664 java.lang.String&nbsp;docID)</PRE>
665<DL>
666<DD><DL>
667<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String)">retrieveDocumentChildren</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
668</DD>
669<DD><DL>
670<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is the document identifier of the document whose hierarchical
671 structure is requested
672<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
673 containing a view of the document structure of the document denoted by
674 docID where only the document and its direct children are returned.</DL>
675</DD>
676</DL>
677<HR>
678
679<A NAME="retrieveBrowseStructure(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
680retrieveBrowseStructure</H3>
681<PRE>
682public java.lang.String <B>retrieveBrowseStructure</B>(java.lang.String&nbsp;collection,
683 java.lang.String&nbsp;service,
684 java.lang.String&nbsp;classifierID)</PRE>
685<DL>
686<DD><DL>
687<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveBrowseStructure(java.lang.String, java.lang.String, java.lang.String)">retrieveBrowseStructure</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
688</DD>
689<DD><DL>
690<DT><B>Parameters:</B><DD><CODE>classifierID</CODE> - is of the form CL# where the number (#) marks
691 out structured sections like CL1.1.3 or CL2<DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>service</CODE> - is the name of the browse service (=ClassifierBrowse usually)
692<DT><B>Returns:</B><DD>a String representing Greenstone3 ClassifierBrowse XML
693 giving the entire *structure* of the classification denoted by
694 classifierID (including the structures of document descendents of
695 the classifier).</DL>
696</DD>
697</DL>
698<HR>
699
700<A NAME="retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
701retrieveBrowseMetadata</H3>
702<PRE>
703public java.lang.String <B>retrieveBrowseMetadata</B>(java.lang.String&nbsp;collection,
704 java.lang.String&nbsp;service,
705 java.lang.String[]&nbsp;nodeIDs)</PRE>
706<DL>
707<DD><DL>
708<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveBrowseMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
709</DD>
710<DD><DL>
711<DT><B>Parameters:</B><DD><CODE>nodeIDs</CODE> - is of the form CL#.# where the number (#) marks
712 out structured sections like CL2.1.3. NodeIDs are generally subsections
713 of top-level classifierNodes (CL#, e.g. CL3).<DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>service</CODE> - is the name of the Browse's MetadataRetrieve service
714 (usually the browse service is ClassifierBrowse, in which case it always
715 has a retrieve service called ClassifierBrowseMetadataRetrieve)
716<DT><B>Returns:</B><DD>a String representing Greenstone3
717 ClassifierBrowseMetadataRetrieve XML giving all the metadata for
718 all the subclassifiers denoted by nodeIDs.</DL>
719</DD>
720</DL>
721<HR>
722
723<A NAME="query(java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3>
724query</H3>
725<PRE>
726public java.lang.String <B>query</B>(java.lang.String&nbsp;collection,
727 java.lang.String&nbsp;service,
728 java.util.Map&nbsp;nameValParamsMap)</PRE>
729<DL>
730<DD><DL>
731<DT><B>Specified by:</B><DD><CODE>query</CODE> in interface <CODE>org.greenstone.fedora.services.FedoraToGS3Interface</CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#query(java.lang.String, java.lang.String, java.util.Map)">query</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE><DT><B>Overrides:</B><DD><CODE>query</CODE> in class <CODE>org.greenstone.fedora.services.FedoraGS3Connection</CODE></DL>
732</DD>
733<DD><DL>
734<DT><B>Parameters:</B><DD><CODE>nameValParamsMap</CODE> - is a Map of name and value pairs for all the
735 query field data values. The names match the field names that
736 describeCollectionService() would have returned for the query service.<DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>service</CODE> - is the name of the query service
737 This method is only ever called when any of the services in the digital
738 library described themselves as type=query. Therefore any digital
739 libraries that have no query services, can just return emtpy message
740 strings (or even "") since this method will never be called on them
741 anyway.
742<DT><B>Returns:</B><DD>a String representing Greenstone3 XML for a query process
743 response returning the results for the query denoted by parameter
744 nameValParamsMap.</DL>
745</DD>
746</DL>
747<!-- ========= END OF CLASS DATA ========= -->
748<HR>
749
750
751<!-- ======= START OF BOTTOM NAVBAR ====== -->
752<A NAME="navbar_bottom"><!-- --></A>
753<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
754<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
755<TR>
756<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
757<A NAME="navbar_bottom_firstrow"><!-- --></A>
758<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
759 <TR ALIGN="center" VALIGN="top">
760 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
761 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
762 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
763 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
764 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
765 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
766 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
767 </TR>
768</TABLE>
769</TD>
770<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
771</EM>
772</TD>
773</TR>
774
775<TR>
776<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
777&nbsp;<A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.CancelException.html" title="class in org.greenstone.gs3client.dlservices"><B>PREV CLASS</B></A>&nbsp;
778&nbsp;<A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices"><B>NEXT CLASS</B></A></FONT></TD>
779<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
780 <A HREF="../../../../index.html?org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html" target="_top"><B>FRAMES</B></A> &nbsp;
781&nbsp;<A HREF="FedoraServicesAPIA.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
782&nbsp;<SCRIPT type="text/javascript">
783 <!--
784 if(window==top) {
785 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
786 }
787 //-->
788</SCRIPT>
789<NOSCRIPT>
790 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
791</NOSCRIPT>
792
793
794</FONT></TD>
795</TR>
796<TR>
797<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
798 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.greenstone.fedora.services.FedoraGS3Connection">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
799<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
800DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
801</TR>
802</TABLE>
803<A NAME="skip-navbar_bottom"></A>
804<!-- ======== END OF BOTTOM NAVBAR ======= -->
805
806<HR>
807
808</BODY>
809</HTML>
Note: See TracBrowser for help on using the repository browser.