| 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>
|
|---|
| 7 | DigitalLibraryServicesAPIA
|
|---|
| 8 | </TITLE>
|
|---|
| 9 |
|
|---|
| 10 | <META NAME="keywords" CONTENT="org.greenstone.gs3client.dlservices.DigitalLibraryServicesAPIA interface">
|
|---|
| 11 |
|
|---|
| 12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
|---|
| 13 |
|
|---|
| 14 | <SCRIPT type="text/javascript">
|
|---|
| 15 | function windowTitle()
|
|---|
| 16 | {
|
|---|
| 17 | parent.document.title="DigitalLibraryServicesAPIA";
|
|---|
| 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> </TD>
|
|---|
| 38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|---|
| 39 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|---|
| 40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|---|
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|---|
| 42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|---|
| 43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | PREV CLASS
|
|---|
| 55 | <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.CancelException.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/DigitalLibraryServicesAPIA.html" target="_top"><B>FRAMES</B></A>
|
|---|
| 58 | <A HREF="DigitalLibraryServicesAPIA.html" target="_top"><B>NO FRAMES</B></A>
|
|---|
| 59 | <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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|---|
| 76 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 77 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <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">
|
|---|
| 87 | org.greenstone.gs3client.dlservices</FONT>
|
|---|
| 88 | <BR>
|
|---|
| 89 | Interface DigitalLibraryServicesAPIA</H2>
|
|---|
| 90 | <DL>
|
|---|
| 91 | <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices">FedoraServicesAPIA</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices">GS3ServicesAPIA</A></DD>
|
|---|
| 92 | </DL>
|
|---|
| 93 | <HR>
|
|---|
| 94 | <DL>
|
|---|
| 95 | <DT><PRE>public interface <B>DigitalLibraryServicesAPIA</B></DL>
|
|---|
| 96 | </PRE>
|
|---|
| 97 |
|
|---|
| 98 | <P>
|
|---|
| 99 | Interface that defines the digital library methods that need to be
|
|---|
| 100 | provided by a digital library that's going to be incorporated into the
|
|---|
| 101 | Greenstone Java-Client, so that the client may be able to use/access
|
|---|
| 102 | its functionality.
|
|---|
| 103 |
|
|---|
| 104 | Note that the Strings returned by all defined methods -- with the exception
|
|---|
| 105 | of getLanguage() -- represent Greenstone3 XML response messages, as defined
|
|---|
| 106 | in the Greenstone3 manual.
|
|---|
| 107 | These methods do not throw exceptions, but rather embed any error information
|
|---|
| 108 | in the XML Strings returned, as is done in Greenstone3 XML response
|
|---|
| 109 | messages.
|
|---|
| 110 |
|
|---|
| 111 | The final 'A' of DigitalLibraryServicesAPIA stands for Access, as the
|
|---|
| 112 | methods defined here are to give access to a digital library's repository.
|
|---|
| 113 | <P>
|
|---|
| 114 |
|
|---|
| 115 | <P>
|
|---|
| 116 | <DL>
|
|---|
| 117 | <DT><B>Author:</B></DT>
|
|---|
| 118 | <DD>ak19</DD>
|
|---|
| 119 | </DL>
|
|---|
| 120 | <HR>
|
|---|
| 121 |
|
|---|
| 122 | <P>
|
|---|
| 123 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
|---|
| 124 |
|
|---|
| 125 | <A NAME="nested_class_summary"><!-- --></A>
|
|---|
| 126 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 127 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 128 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 129 | <B>Nested Class Summary</B></FONT></TH>
|
|---|
| 130 | </TR>
|
|---|
| 131 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 132 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 133 | <CODE>static class</CODE></FONT></TD>
|
|---|
| 134 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.CancelException.html" title="class in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA.CancelException</A></B></CODE>
|
|---|
| 135 |
|
|---|
| 136 | <BR>
|
|---|
| 137 | If there's a dialog, then the CancelException can be used to indicate
|
|---|
| 138 | that the user cancelled out of it rather than having seen it through.</TD>
|
|---|
| 139 | </TR>
|
|---|
| 140 | </TABLE>
|
|---|
| 141 | <!-- =========== FIELD SUMMARY =========== -->
|
|---|
| 142 |
|
|---|
| 143 | <A NAME="field_summary"><!-- --></A>
|
|---|
| 144 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 145 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 146 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 147 | <B>Field Summary</B></FONT></TH>
|
|---|
| 148 | </TR>
|
|---|
| 149 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 150 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 151 | <CODE>static java.io.File</CODE></FONT></TD>
|
|---|
| 152 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#propertiesFile">propertiesFile</A></B></CODE>
|
|---|
| 153 |
|
|---|
| 154 | <BR>
|
|---|
| 155 | The properties file containing the initial digital library connection
|
|---|
| 156 | settings which get displayed in the connection dialog fields</TD>
|
|---|
| 157 | </TR>
|
|---|
| 158 | </TABLE>
|
|---|
| 159 |
|
|---|
| 160 | <!-- ========== METHOD SUMMARY =========== -->
|
|---|
| 161 |
|
|---|
| 162 | <A NAME="method_summary"><!-- --></A>
|
|---|
| 163 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 164 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 165 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 166 | <B>Method Summary</B></FONT></TH>
|
|---|
| 167 | </TR>
|
|---|
| 168 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 169 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 170 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 171 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describe()">describe</A></B>()</CODE>
|
|---|
| 172 |
|
|---|
| 173 | <BR>
|
|---|
| 174 | </TD>
|
|---|
| 175 | </TR>
|
|---|
| 176 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 177 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 178 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 179 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeCollection(java.lang.String)">describeCollection</A></B>(java.lang.String collection)</CODE>
|
|---|
| 180 |
|
|---|
| 181 | <BR>
|
|---|
| 182 | </TD>
|
|---|
| 183 | </TR>
|
|---|
| 184 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 185 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 186 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 187 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeCollectionService(java.lang.String, java.lang.String)">describeCollectionService</A></B>(java.lang.String collection,
|
|---|
| 188 | java.lang.String service)</CODE>
|
|---|
| 189 |
|
|---|
| 190 | <BR>
|
|---|
| 191 | </TD>
|
|---|
| 192 | </TR>
|
|---|
| 193 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 194 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 195 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 196 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeService(java.lang.String)">describeService</A></B>(java.lang.String service)</CODE>
|
|---|
| 197 |
|
|---|
| 198 | <BR>
|
|---|
| 199 | </TD>
|
|---|
| 200 | </TR>
|
|---|
| 201 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 202 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 203 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 204 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getAssocFileBaseURL()">getAssocFileBaseURL</A></B>()</CODE>
|
|---|
| 205 |
|
|---|
| 206 | <BR>
|
|---|
| 207 | </TD>
|
|---|
| 208 | </TR>
|
|---|
| 209 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 210 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 211 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 212 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.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> docNode)</CODE>
|
|---|
| 213 |
|
|---|
| 214 | <BR>
|
|---|
| 215 | </TD>
|
|---|
| 216 | </TR>
|
|---|
| 217 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 218 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 219 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 220 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getDisplayName()">getDisplayName</A></B>()</CODE>
|
|---|
| 221 |
|
|---|
| 222 | <BR>
|
|---|
| 223 | </TD>
|
|---|
| 224 | </TR>
|
|---|
| 225 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 226 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 227 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 228 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getLanguage()">getLanguage</A></B>()</CODE>
|
|---|
| 229 |
|
|---|
| 230 | <BR>
|
|---|
| 231 | Gets the language that's set as the preferred language.</TD>
|
|---|
| 232 | </TR>
|
|---|
| 233 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 234 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 235 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 236 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#query(java.lang.String, java.lang.String, java.util.Map)">query</A></B>(java.lang.String collection,
|
|---|
| 237 | java.lang.String service,
|
|---|
| 238 | java.util.Map nameValParamsMap)</CODE>
|
|---|
| 239 |
|
|---|
| 240 | <BR>
|
|---|
| 241 | </TD>
|
|---|
| 242 | </TR>
|
|---|
| 243 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 244 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 245 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 246 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveBrowseMetadata</A></B>(java.lang.String collection,
|
|---|
| 247 | java.lang.String service,
|
|---|
| 248 | java.lang.String[] nodeIDs)</CODE>
|
|---|
| 249 |
|
|---|
| 250 | <BR>
|
|---|
| 251 | </TD>
|
|---|
| 252 | </TR>
|
|---|
| 253 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 254 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 255 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 256 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveBrowseStructure(java.lang.String, java.lang.String, java.lang.String)">retrieveBrowseStructure</A></B>(java.lang.String collection,
|
|---|
| 257 | java.lang.String service,
|
|---|
| 258 | java.lang.String classifierID)</CODE>
|
|---|
| 259 |
|
|---|
| 260 | <BR>
|
|---|
| 261 | </TD>
|
|---|
| 262 | </TR>
|
|---|
| 263 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 264 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 265 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 266 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String)">retrieveDocumentChildren</A></B>(java.lang.String collection,
|
|---|
| 267 | java.lang.String docID)</CODE>
|
|---|
| 268 |
|
|---|
| 269 | <BR>
|
|---|
| 270 | </TD>
|
|---|
| 271 | </TR>
|
|---|
| 272 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 273 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 274 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 275 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String[])">retrieveDocumentChildren</A></B>(java.lang.String collection,
|
|---|
| 276 | java.lang.String[] docIDs)</CODE>
|
|---|
| 277 |
|
|---|
| 278 | <BR>
|
|---|
| 279 | </TD>
|
|---|
| 280 | </TR>
|
|---|
| 281 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 282 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 283 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 284 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String)">retrieveDocumentContent</A></B>(java.lang.String collection,
|
|---|
| 285 | java.lang.String docID)</CODE>
|
|---|
| 286 |
|
|---|
| 287 | <BR>
|
|---|
| 288 | </TD>
|
|---|
| 289 | </TR>
|
|---|
| 290 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 291 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 292 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 293 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String[])">retrieveDocumentContent</A></B>(java.lang.String collection,
|
|---|
| 294 | java.lang.String[] docIDs)</CODE>
|
|---|
| 295 |
|
|---|
| 296 | <BR>
|
|---|
| 297 | </TD>
|
|---|
| 298 | </TR>
|
|---|
| 299 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 300 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 301 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 302 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String)">retrieveDocumentMetadata</A></B>(java.lang.String collection,
|
|---|
| 303 | java.lang.String docID)</CODE>
|
|---|
| 304 |
|
|---|
| 305 | <BR>
|
|---|
| 306 | </TD>
|
|---|
| 307 | </TR>
|
|---|
| 308 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 309 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 310 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 311 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String[])">retrieveDocumentMetadata</A></B>(java.lang.String collection,
|
|---|
| 312 | java.lang.String[] docIDs)</CODE>
|
|---|
| 313 |
|
|---|
| 314 | <BR>
|
|---|
| 315 | </TD>
|
|---|
| 316 | </TR>
|
|---|
| 317 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 318 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 319 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 320 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String)">retrieveDocumentStructure</A></B>(java.lang.String collection,
|
|---|
| 321 | java.lang.String docID)</CODE>
|
|---|
| 322 |
|
|---|
| 323 | <BR>
|
|---|
| 324 | </TD>
|
|---|
| 325 | </TR>
|
|---|
| 326 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 327 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 328 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 329 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String[])">retrieveDocumentStructure</A></B>(java.lang.String collection,
|
|---|
| 330 | java.lang.String[] docIDs)</CODE>
|
|---|
| 331 |
|
|---|
| 332 | <BR>
|
|---|
| 333 | </TD>
|
|---|
| 334 | </TR>
|
|---|
| 335 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 336 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 337 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 338 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String)">retrieveTitleMetadata</A></B>(java.lang.String collection,
|
|---|
| 339 | java.lang.String docID)</CODE>
|
|---|
| 340 |
|
|---|
| 341 | <BR>
|
|---|
| 342 | </TD>
|
|---|
| 343 | </TR>
|
|---|
| 344 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 345 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 346 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 347 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String[])">retrieveTitleMetadata</A></B>(java.lang.String collection,
|
|---|
| 348 | java.lang.String[] docIDs)</CODE>
|
|---|
| 349 |
|
|---|
| 350 | <BR>
|
|---|
| 351 | </TD>
|
|---|
| 352 | </TR>
|
|---|
| 353 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 354 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 355 | <CODE> void</CODE></FONT></TD>
|
|---|
| 356 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#setLanguage(java.lang.String)">setLanguage</A></B>(java.lang.String language)</CODE>
|
|---|
| 357 |
|
|---|
| 358 | <BR>
|
|---|
| 359 | Sets the preferred language (code) for metadata and other content to be
|
|---|
| 360 | returned on request messages.</TD>
|
|---|
| 361 | </TR>
|
|---|
| 362 | </TABLE>
|
|---|
| 363 |
|
|---|
| 364 | <P>
|
|---|
| 365 |
|
|---|
| 366 | <!-- ============ FIELD DETAIL =========== -->
|
|---|
| 367 |
|
|---|
| 368 | <A NAME="field_detail"><!-- --></A>
|
|---|
| 369 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 370 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 371 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 372 | <B>Field Detail</B></FONT></TH>
|
|---|
| 373 | </TR>
|
|---|
| 374 | </TABLE>
|
|---|
| 375 |
|
|---|
| 376 | <A NAME="propertiesFile"><!-- --></A><H3>
|
|---|
| 377 | propertiesFile</H3>
|
|---|
| 378 | <PRE>
|
|---|
| 379 | static final java.io.File <B>propertiesFile</B></PRE>
|
|---|
| 380 | <DL>
|
|---|
| 381 | <DD>The properties file containing the initial digital library connection
|
|---|
| 382 | settings which get displayed in the connection dialog fields
|
|---|
| 383 | <P>
|
|---|
| 384 | <DL>
|
|---|
| 385 | </DL>
|
|---|
| 386 | </DL>
|
|---|
| 387 |
|
|---|
| 388 | <!-- ============ METHOD DETAIL ========== -->
|
|---|
| 389 |
|
|---|
| 390 | <A NAME="method_detail"><!-- --></A>
|
|---|
| 391 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 392 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 393 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 394 | <B>Method Detail</B></FONT></TH>
|
|---|
| 395 | </TR>
|
|---|
| 396 | </TABLE>
|
|---|
| 397 |
|
|---|
| 398 | <A NAME="getDisplayName()"><!-- --></A><H3>
|
|---|
| 399 | getDisplayName</H3>
|
|---|
| 400 | <PRE>
|
|---|
| 401 | java.lang.String <B>getDisplayName</B>()</PRE>
|
|---|
| 402 | <DL>
|
|---|
| 403 | <DD><DL>
|
|---|
| 404 |
|
|---|
| 405 | <DT><B>Returns:</B><DD>the name of this digital library for displaying in the client</DL>
|
|---|
| 406 | </DD>
|
|---|
| 407 | </DL>
|
|---|
| 408 | <HR>
|
|---|
| 409 |
|
|---|
| 410 | <A NAME="getAssocFileBaseURL()"><!-- --></A><H3>
|
|---|
| 411 | getAssocFileBaseURL</H3>
|
|---|
| 412 | <PRE>
|
|---|
| 413 | java.lang.String <B>getAssocFileBaseURL</B>()</PRE>
|
|---|
| 414 | <DL>
|
|---|
| 415 | <DD><DL>
|
|---|
| 416 |
|
|---|
| 417 | <DT><B>Returns:</B><DD>the overall directory path for associated files (not including
|
|---|
| 418 | the document's nodeID/pid). This can be used to formulate the base url of
|
|---|
| 419 | JEditorPane's HTML documents. If the documents from any digital library
|
|---|
| 420 | do not contain relative paths, or otherwise deal with the resolution of
|
|---|
| 421 | relative urls themselves, then return "" from here.</DL>
|
|---|
| 422 | </DD>
|
|---|
| 423 | </DL>
|
|---|
| 424 | <HR>
|
|---|
| 425 |
|
|---|
| 426 | <A NAME="getAssocFileBaseURL(org.greenstone.gs3client.data.DocumentNodeData)"><!-- --></A><H3>
|
|---|
| 427 | getAssocFileBaseURL</H3>
|
|---|
| 428 | <PRE>
|
|---|
| 429 | java.lang.String <B>getAssocFileBaseURL</B>(<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> docNode)</PRE>
|
|---|
| 430 | <DL>
|
|---|
| 431 | <DD><DL>
|
|---|
| 432 |
|
|---|
| 433 | <DT><B>Returns:</B><DD>the directory path to the associated files of the given document
|
|---|
| 434 | node. For instance, the base url of a JEditorPane's HTML documents can be
|
|---|
| 435 | set to this.</DL>
|
|---|
| 436 | </DD>
|
|---|
| 437 | </DL>
|
|---|
| 438 | <HR>
|
|---|
| 439 |
|
|---|
| 440 | <A NAME="setLanguage(java.lang.String)"><!-- --></A><H3>
|
|---|
| 441 | setLanguage</H3>
|
|---|
| 442 | <PRE>
|
|---|
| 443 | void <B>setLanguage</B>(java.lang.String language)</PRE>
|
|---|
| 444 | <DL>
|
|---|
| 445 | <DD>Sets the preferred language (code) for metadata and other content to be
|
|---|
| 446 | returned on request messages. If the preferred language is not available,
|
|---|
| 447 | the implementation may choose to send English back instead, or failing
|
|---|
| 448 | that, send the data in any other available language.
|
|---|
| 449 | <P>
|
|---|
| 450 | <DD><DL>
|
|---|
| 451 | <DT><B>Parameters:</B><DD><CODE>language</CODE> - has to be a language code as recognised by Greenstone3
|
|---|
| 452 | (the language codes used by W3C probably). E.g. "en" for English.</DL>
|
|---|
| 453 | </DD>
|
|---|
| 454 | </DL>
|
|---|
| 455 | <HR>
|
|---|
| 456 |
|
|---|
| 457 | <A NAME="getLanguage()"><!-- --></A><H3>
|
|---|
| 458 | getLanguage</H3>
|
|---|
| 459 | <PRE>
|
|---|
| 460 | java.lang.String <B>getLanguage</B>()</PRE>
|
|---|
| 461 | <DL>
|
|---|
| 462 | <DD>Gets the language that's set as the preferred language.
|
|---|
| 463 | <P>
|
|---|
| 464 | <DD><DL>
|
|---|
| 465 |
|
|---|
| 466 | <DT><B>Returns:</B><DD>the language code as recognised by Greenstone3 (which are the
|
|---|
| 467 | language codes used by W3C probably). E.g. "en" for English.</DL>
|
|---|
| 468 | </DD>
|
|---|
| 469 | </DL>
|
|---|
| 470 | <HR>
|
|---|
| 471 |
|
|---|
| 472 | <A NAME="describe()"><!-- --></A><H3>
|
|---|
| 473 | describe</H3>
|
|---|
| 474 | <PRE>
|
|---|
| 475 | java.lang.String <B>describe</B>()</PRE>
|
|---|
| 476 | <DL>
|
|---|
| 477 | <DD><DL>
|
|---|
| 478 |
|
|---|
| 479 | <DT><B>Returns:</B><DD>Greenstone3 XML describe response message with information
|
|---|
| 480 | about collections contained and services (and any serviceRacks) supported
|
|---|
| 481 | by the Digital library.</DL>
|
|---|
| 482 | </DD>
|
|---|
| 483 | </DL>
|
|---|
| 484 | <HR>
|
|---|
| 485 |
|
|---|
| 486 | <A NAME="describeCollection(java.lang.String)"><!-- --></A><H3>
|
|---|
| 487 | describeCollection</H3>
|
|---|
| 488 | <PRE>
|
|---|
| 489 | java.lang.String <B>describeCollection</B>(java.lang.String collection)</PRE>
|
|---|
| 490 | <DL>
|
|---|
| 491 | <DD><DL>
|
|---|
| 492 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection to be described
|
|---|
| 493 | <DT><B>Returns:</B><DD>Greenstone3 XML describe response message originating from a
|
|---|
| 494 | collection, describing the collection (display items) as well as
|
|---|
| 495 | listing any services supported specifically by the collection.</DL>
|
|---|
| 496 | </DD>
|
|---|
| 497 | </DL>
|
|---|
| 498 | <HR>
|
|---|
| 499 |
|
|---|
| 500 | <A NAME="describeCollectionService(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 501 | describeCollectionService</H3>
|
|---|
| 502 | <PRE>
|
|---|
| 503 | java.lang.String <B>describeCollectionService</B>(java.lang.String collection,
|
|---|
| 504 | java.lang.String service)</PRE>
|
|---|
| 505 | <DL>
|
|---|
| 506 | <DD><DL>
|
|---|
| 507 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection to be described<DD><CODE>service</CODE> - is the name of the collection's service to be described
|
|---|
| 508 | <DT><B>Returns:</B><DD>Greenstone3 XML describe response message originating from a
|
|---|
| 509 | collection's service, describing the service (display items).</DL>
|
|---|
| 510 | </DD>
|
|---|
| 511 | </DL>
|
|---|
| 512 | <HR>
|
|---|
| 513 |
|
|---|
| 514 | <A NAME="describeService(java.lang.String)"><!-- --></A><H3>
|
|---|
| 515 | describeService</H3>
|
|---|
| 516 | <PRE>
|
|---|
| 517 | java.lang.String <B>describeService</B>(java.lang.String service)</PRE>
|
|---|
| 518 | <DL>
|
|---|
| 519 | <DD><DL>
|
|---|
| 520 | <DT><B>Parameters:</B><DD><CODE>service</CODE> - is the name of the collection's service to be described
|
|---|
| 521 | <DT><B>Returns:</B><DD>Greenstone3 XML describe response message originating from a
|
|---|
| 522 | general (non-collection specific) service, describing the requested
|
|---|
| 523 | service (for example with GS3 display items).</DL>
|
|---|
| 524 | </DD>
|
|---|
| 525 | </DL>
|
|---|
| 526 | <HR>
|
|---|
| 527 |
|
|---|
| 528 | <A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
|---|
| 529 | retrieveDocumentMetadata</H3>
|
|---|
| 530 | <PRE>
|
|---|
| 531 | java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String collection,
|
|---|
| 532 | java.lang.String[] docIDs)</PRE>
|
|---|
| 533 | <DL>
|
|---|
| 534 | <DD><DL>
|
|---|
| 535 | <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
|
|---|
| 536 | metadata is requested
|
|---|
| 537 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
|
|---|
| 538 | containing all the metadata of all the documents indicated by docIDs</DL>
|
|---|
| 539 | </DD>
|
|---|
| 540 | </DL>
|
|---|
| 541 | <HR>
|
|---|
| 542 |
|
|---|
| 543 | <A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 544 | retrieveDocumentMetadata</H3>
|
|---|
| 545 | <PRE>
|
|---|
| 546 | java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String collection,
|
|---|
| 547 | java.lang.String docID)</PRE>
|
|---|
| 548 | <DL>
|
|---|
| 549 | <DD><DL>
|
|---|
| 550 | <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
|
|---|
| 551 | requested
|
|---|
| 552 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
|
|---|
| 553 | containing all the metadata of the document denoted by docID</DL>
|
|---|
| 554 | </DD>
|
|---|
| 555 | </DL>
|
|---|
| 556 | <HR>
|
|---|
| 557 |
|
|---|
| 558 | <A NAME="retrieveTitleMetadata(java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
|---|
| 559 | retrieveTitleMetadata</H3>
|
|---|
| 560 | <PRE>
|
|---|
| 561 | java.lang.String <B>retrieveTitleMetadata</B>(java.lang.String collection,
|
|---|
| 562 | java.lang.String[] docIDs)</PRE>
|
|---|
| 563 | <DL>
|
|---|
| 564 | <DD><DL>
|
|---|
| 565 | <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
|
|---|
| 566 | are requested
|
|---|
| 567 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
|
|---|
| 568 | containing only the title metadata of the documents denoted by docIDs</DL>
|
|---|
| 569 | </DD>
|
|---|
| 570 | </DL>
|
|---|
| 571 | <HR>
|
|---|
| 572 |
|
|---|
| 573 | <A NAME="retrieveTitleMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 574 | retrieveTitleMetadata</H3>
|
|---|
| 575 | <PRE>
|
|---|
| 576 | java.lang.String <B>retrieveTitleMetadata</B>(java.lang.String collection,
|
|---|
| 577 | java.lang.String docID)</PRE>
|
|---|
| 578 | <DL>
|
|---|
| 579 | <DD><DL>
|
|---|
| 580 | <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
|
|---|
| 581 | requested
|
|---|
| 582 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
|
|---|
| 583 | containing only the title metadata of the document denoted by docID</DL>
|
|---|
| 584 | </DD>
|
|---|
| 585 | </DL>
|
|---|
| 586 | <HR>
|
|---|
| 587 |
|
|---|
| 588 | <A NAME="retrieveDocumentContent(java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
|---|
| 589 | retrieveDocumentContent</H3>
|
|---|
| 590 | <PRE>
|
|---|
| 591 | java.lang.String <B>retrieveDocumentContent</B>(java.lang.String collection,
|
|---|
| 592 | java.lang.String[] docIDs)</PRE>
|
|---|
| 593 | <DL>
|
|---|
| 594 | <DD><DL>
|
|---|
| 595 | <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)
|
|---|
| 596 | contents are requested
|
|---|
| 597 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentContentRetrieve XML
|
|---|
| 598 | containing the document contents of the documents indicated by docIDs</DL>
|
|---|
| 599 | </DD>
|
|---|
| 600 | </DL>
|
|---|
| 601 | <HR>
|
|---|
| 602 |
|
|---|
| 603 | <A NAME="retrieveDocumentContent(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 604 | retrieveDocumentContent</H3>
|
|---|
| 605 | <PRE>
|
|---|
| 606 | java.lang.String <B>retrieveDocumentContent</B>(java.lang.String collection,
|
|---|
| 607 | java.lang.String docID)</PRE>
|
|---|
| 608 | <DL>
|
|---|
| 609 | <DD><DL>
|
|---|
| 610 | <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)
|
|---|
| 611 | content is requested
|
|---|
| 612 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentContentRetrieve XML
|
|---|
| 613 | containing the document contents of the document indicated by docID</DL>
|
|---|
| 614 | </DD>
|
|---|
| 615 | </DL>
|
|---|
| 616 | <HR>
|
|---|
| 617 |
|
|---|
| 618 | <A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
|---|
| 619 | retrieveDocumentStructure</H3>
|
|---|
| 620 | <PRE>
|
|---|
| 621 | java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String collection,
|
|---|
| 622 | java.lang.String[] docIDs)</PRE>
|
|---|
| 623 | <DL>
|
|---|
| 624 | <DD><DL>
|
|---|
| 625 | <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
|
|---|
| 626 | hierarchical structures are requested
|
|---|
| 627 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
|
|---|
| 628 | containing the document structure of the documents indicated by docIDs:
|
|---|
| 629 | this means all their descendents</DL>
|
|---|
| 630 | </DD>
|
|---|
| 631 | </DL>
|
|---|
| 632 | <HR>
|
|---|
| 633 |
|
|---|
| 634 | <A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 635 | retrieveDocumentStructure</H3>
|
|---|
| 636 | <PRE>
|
|---|
| 637 | java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String collection,
|
|---|
| 638 | java.lang.String docID)</PRE>
|
|---|
| 639 | <DL>
|
|---|
| 640 | <DD><DL>
|
|---|
| 641 | <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
|
|---|
| 642 | structure is requested
|
|---|
| 643 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
|
|---|
| 644 | containing the document structure of the document indicated by docID:
|
|---|
| 645 | this means all its descendents</DL>
|
|---|
| 646 | </DD>
|
|---|
| 647 | </DL>
|
|---|
| 648 | <HR>
|
|---|
| 649 |
|
|---|
| 650 | <A NAME="retrieveDocumentChildren(java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
|---|
| 651 | retrieveDocumentChildren</H3>
|
|---|
| 652 | <PRE>
|
|---|
| 653 | java.lang.String <B>retrieveDocumentChildren</B>(java.lang.String collection,
|
|---|
| 654 | java.lang.String[] docIDs)</PRE>
|
|---|
| 655 | <DL>
|
|---|
| 656 | <DD><DL>
|
|---|
| 657 | <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
|
|---|
| 658 | hierarchical structures are requested
|
|---|
| 659 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
|
|---|
| 660 | containing a view of the document structure of the documents denoted by
|
|---|
| 661 | docs where only the requested documents and their direct children are
|
|---|
| 662 | returned.</DL>
|
|---|
| 663 | </DD>
|
|---|
| 664 | </DL>
|
|---|
| 665 | <HR>
|
|---|
| 666 |
|
|---|
| 667 | <A NAME="retrieveDocumentChildren(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 668 | retrieveDocumentChildren</H3>
|
|---|
| 669 | <PRE>
|
|---|
| 670 | java.lang.String <B>retrieveDocumentChildren</B>(java.lang.String collection,
|
|---|
| 671 | java.lang.String docID)</PRE>
|
|---|
| 672 | <DL>
|
|---|
| 673 | <DD><DL>
|
|---|
| 674 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is an document identifier of the document whose hierarchical
|
|---|
| 675 | structure is requested
|
|---|
| 676 | <DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
|
|---|
| 677 | containing a view of the document structure of the document denoted by
|
|---|
| 678 | docID where only the document and its direct children are returned.</DL>
|
|---|
| 679 | </DD>
|
|---|
| 680 | </DL>
|
|---|
| 681 | <HR>
|
|---|
| 682 |
|
|---|
| 683 | <A NAME="retrieveBrowseStructure(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 684 | retrieveBrowseStructure</H3>
|
|---|
| 685 | <PRE>
|
|---|
| 686 | java.lang.String <B>retrieveBrowseStructure</B>(java.lang.String collection,
|
|---|
| 687 | java.lang.String service,
|
|---|
| 688 | java.lang.String classifierID)</PRE>
|
|---|
| 689 | <DL>
|
|---|
| 690 | <DD><DL>
|
|---|
| 691 | <DT><B>Parameters:</B><DD><CODE>classifierID</CODE> - is of the form CL# where the number (#) marks
|
|---|
| 692 | 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)
|
|---|
| 693 | <DT><B>Returns:</B><DD>a String representing Greenstone3 ClassifierBrowse XML
|
|---|
| 694 | giving the entire *structure* of the classification denoted by
|
|---|
| 695 | classifierID (including the structures of document descendents of
|
|---|
| 696 | the classifier).</DL>
|
|---|
| 697 | </DD>
|
|---|
| 698 | </DL>
|
|---|
| 699 | <HR>
|
|---|
| 700 |
|
|---|
| 701 | <A NAME="retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
|---|
| 702 | retrieveBrowseMetadata</H3>
|
|---|
| 703 | <PRE>
|
|---|
| 704 | java.lang.String <B>retrieveBrowseMetadata</B>(java.lang.String collection,
|
|---|
| 705 | java.lang.String service,
|
|---|
| 706 | java.lang.String[] nodeIDs)</PRE>
|
|---|
| 707 | <DL>
|
|---|
| 708 | <DD><DL>
|
|---|
| 709 | <DT><B>Parameters:</B><DD><CODE>nodeIDs</CODE> - is of the form CL#.# where the number (#) marks
|
|---|
| 710 | out structured sections like CL2.1.3. NodeIDs are generally subsections
|
|---|
| 711 | 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
|
|---|
| 712 | (usually the browse service is ClassifierBrowse, in which case it always
|
|---|
| 713 | has a retrieve service called ClassifierBrowseMetadataRetrieve)
|
|---|
| 714 | <DT><B>Returns:</B><DD>a String representing Greenstone3
|
|---|
| 715 | ClassifierBrowseMetadataRetrieve XML giving all the metadata for
|
|---|
| 716 | all the subclassifiers denoted by nodeIDs.</DL>
|
|---|
| 717 | </DD>
|
|---|
| 718 | </DL>
|
|---|
| 719 | <HR>
|
|---|
| 720 |
|
|---|
| 721 | <A NAME="query(java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3>
|
|---|
| 722 | query</H3>
|
|---|
| 723 | <PRE>
|
|---|
| 724 | java.lang.String <B>query</B>(java.lang.String collection,
|
|---|
| 725 | java.lang.String service,
|
|---|
| 726 | java.util.Map nameValParamsMap)</PRE>
|
|---|
| 727 | <DL>
|
|---|
| 728 | <DD><DL>
|
|---|
| 729 | <DT><B>Parameters:</B><DD><CODE>nameValParamsMap</CODE> - is a Map of name and value pairs for all the
|
|---|
| 730 | query field data values. The names match the field names that
|
|---|
| 731 | 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
|
|---|
| 732 | This method is only ever called when any of the services in the digital
|
|---|
| 733 | library described themselves as type=query. Therefore any digital
|
|---|
| 734 | libraries that have no query services, can just return emtpy message
|
|---|
| 735 | strings (or even "") since this method will never be called on them
|
|---|
| 736 | anyway.
|
|---|
| 737 | <DT><B>Returns:</B><DD>a String representing Greenstone3 XML for a query process
|
|---|
| 738 | response returning the results for the query denoted by parameter
|
|---|
| 739 | nameValParamsMap.</DL>
|
|---|
| 740 | </DD>
|
|---|
| 741 | </DL>
|
|---|
| 742 | <!-- ========= END OF CLASS DATA ========= -->
|
|---|
| 743 | <HR>
|
|---|
| 744 |
|
|---|
| 745 |
|
|---|
| 746 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|---|
| 747 | <A NAME="navbar_bottom"><!-- --></A>
|
|---|
| 748 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|---|
| 749 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|---|
| 750 | <TR>
|
|---|
| 751 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|---|
| 752 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|---|
| 753 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|---|
| 754 | <TR ALIGN="center" VALIGN="top">
|
|---|
| 755 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|---|
| 756 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|---|
| 757 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|---|
| 758 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|---|
| 759 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|---|
| 760 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|---|
| 761 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|---|
| 762 | </TR>
|
|---|
| 763 | </TABLE>
|
|---|
| 764 | </TD>
|
|---|
| 765 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|---|
| 766 | </EM>
|
|---|
| 767 | </TD>
|
|---|
| 768 | </TR>
|
|---|
| 769 |
|
|---|
| 770 | <TR>
|
|---|
| 771 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 772 | PREV CLASS
|
|---|
| 773 | <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.CancelException.html" title="class in org.greenstone.gs3client.dlservices"><B>NEXT CLASS</B></A></FONT></TD>
|
|---|
| 774 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 775 | <A HREF="../../../../index.html?org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" target="_top"><B>FRAMES</B></A>
|
|---|
| 776 | <A HREF="DigitalLibraryServicesAPIA.html" target="_top"><B>NO FRAMES</B></A>
|
|---|
| 777 | <SCRIPT type="text/javascript">
|
|---|
| 778 | <!--
|
|---|
| 779 | if(window==top) {
|
|---|
| 780 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|---|
| 781 | }
|
|---|
| 782 | //-->
|
|---|
| 783 | </SCRIPT>
|
|---|
| 784 | <NOSCRIPT>
|
|---|
| 785 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|---|
| 786 | </NOSCRIPT>
|
|---|
| 787 |
|
|---|
| 788 |
|
|---|
| 789 | </FONT></TD>
|
|---|
| 790 | </TR>
|
|---|
| 791 | <TR>
|
|---|
| 792 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 793 | SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|---|
| 794 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 795 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|---|
| 796 | </TR>
|
|---|
| 797 | </TABLE>
|
|---|
| 798 | <A NAME="skip-navbar_bottom"></A>
|
|---|
| 799 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|---|
| 800 |
|
|---|
| 801 | <HR>
|
|---|
| 802 |
|
|---|
| 803 | </BODY>
|
|---|
| 804 | </HTML>
|
|---|
