| 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 Sun Apr 27 20:42:38 NZST 2008 -->
|
|---|
| 6 | <TITLE>
|
|---|
| 7 | FedoraToGS3Interface
|
|---|
| 8 | </TITLE>
|
|---|
| 9 |
|
|---|
| 10 | <META NAME="keywords" CONTENT="org.greenstone.fedora.services.FedoraToGS3Interface 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="FedoraToGS3Interface";
|
|---|
| 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="../../../../org/greenstone/fedora/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|---|
| 38 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|---|
| 39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|---|
| 40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|---|
| 41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|---|
| 42 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|---|
| 43 | </TR>
|
|---|
| 44 | </TABLE>
|
|---|
| 45 | </TD>
|
|---|
| 46 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|---|
| 47 | </EM>
|
|---|
| 48 | </TD>
|
|---|
| 49 | </TR>
|
|---|
| 50 |
|
|---|
| 51 | <TR>
|
|---|
| 52 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 53 | <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.ServerNotFoundException.html" title="class in org.greenstone.fedora.services"><B>PREV CLASS</B></A>
|
|---|
| 54 | <A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.Constants.html" title="interface in org.greenstone.fedora.services"><B>NEXT CLASS</B></A></FONT></TD>
|
|---|
| 55 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 56 | <A HREF="../../../../index.html?org/greenstone/fedora/services/FedoraToGS3Interface.html" target="_top"><B>FRAMES</B></A>
|
|---|
| 57 | <A HREF="FedoraToGS3Interface.html" target="_top"><B>NO FRAMES</B></A>
|
|---|
| 58 | <SCRIPT type="text/javascript">
|
|---|
| 59 | <!--
|
|---|
| 60 | if(window==top) {
|
|---|
| 61 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|---|
| 62 | }
|
|---|
| 63 | //-->
|
|---|
| 64 | </SCRIPT>
|
|---|
| 65 | <NOSCRIPT>
|
|---|
| 66 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|---|
| 67 | </NOSCRIPT>
|
|---|
| 68 |
|
|---|
| 69 |
|
|---|
| 70 | </FONT></TD>
|
|---|
| 71 | </TR>
|
|---|
| 72 | <TR>
|
|---|
| 73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 74 | SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|---|
| 75 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 76 | DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|---|
| 77 | </TR>
|
|---|
| 78 | </TABLE>
|
|---|
| 79 | <A NAME="skip-navbar_top"></A>
|
|---|
| 80 | <!-- ========= END OF TOP NAVBAR ========= -->
|
|---|
| 81 |
|
|---|
| 82 | <HR>
|
|---|
| 83 | <!-- ======== START OF CLASS DATA ======== -->
|
|---|
| 84 | <H2>
|
|---|
| 85 | <FONT SIZE="-1">
|
|---|
| 86 | org.greenstone.fedora.services</FONT>
|
|---|
| 87 | <BR>
|
|---|
| 88 | Interface FedoraToGS3Interface</H2>
|
|---|
| 89 | <DL>
|
|---|
| 90 | <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Connection.html" title="class in org.greenstone.fedora.services">FedoraGS3Connection</A></DD>
|
|---|
| 91 | </DL>
|
|---|
| 92 | <HR>
|
|---|
| 93 | <DL>
|
|---|
| 94 | <DT><PRE>public interface <B>FedoraToGS3Interface</B></DL>
|
|---|
| 95 | </PRE>
|
|---|
| 96 |
|
|---|
| 97 | <P>
|
|---|
| 98 | The following methods return the same data as FedoraGS3DL, but formatted as
|
|---|
| 99 | Greenstone Response-Message XML. This way our java-client can parse
|
|---|
| 100 | the returned XML in the same way and store them in the same datastructures.
|
|---|
| 101 | <P>
|
|---|
| 102 |
|
|---|
| 103 | <P>
|
|---|
| 104 | <DL>
|
|---|
| 105 | <DT><B>Author:</B></DT>
|
|---|
| 106 | <DD>ak19</DD>
|
|---|
| 107 | </DL>
|
|---|
| 108 | <HR>
|
|---|
| 109 |
|
|---|
| 110 | <P>
|
|---|
| 111 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
|---|
| 112 |
|
|---|
| 113 | <A NAME="nested_class_summary"><!-- --></A>
|
|---|
| 114 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 115 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 116 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 117 | <B>Nested Class Summary</B></FONT></TH>
|
|---|
| 118 | </TR>
|
|---|
| 119 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 120 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 121 | <CODE>static interface</CODE></FONT></TD>
|
|---|
| 122 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.Constants.html" title="interface in org.greenstone.fedora.services">FedoraToGS3Interface.Constants</A></B></CODE>
|
|---|
| 123 |
|
|---|
| 124 | <BR>
|
|---|
| 125 | Interface declaring some string constants of literals to look for</TD>
|
|---|
| 126 | </TR>
|
|---|
| 127 | </TABLE>
|
|---|
| 128 |
|
|---|
| 129 | <!-- ========== METHOD SUMMARY =========== -->
|
|---|
| 130 |
|
|---|
| 131 | <A NAME="method_summary"><!-- --></A>
|
|---|
| 132 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 133 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 134 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 135 | <B>Method Summary</B></FONT></TH>
|
|---|
| 136 | </TR>
|
|---|
| 137 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 138 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 139 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 140 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#browse(java.lang.String, java.lang.String)">browse</A></B>(java.lang.String collectionName,
|
|---|
| 141 | java.lang.String classifierID)</CODE>
|
|---|
| 142 |
|
|---|
| 143 | <BR>
|
|---|
| 144 | This method performs the implemented browse operation: allowing the
|
|---|
| 145 | user to browse the titles of documents in the given collection by letter
|
|---|
| 146 | and returning the results.</TD>
|
|---|
| 147 | </TR>
|
|---|
| 148 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 149 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 150 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 151 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#browseMetadataRetrieve(java.lang.String[])">browseMetadataRetrieve</A></B>(java.lang.String[] classNodeIDs)</CODE>
|
|---|
| 152 |
|
|---|
| 153 | <BR>
|
|---|
| 154 | This method performs something equivalent to a greenstone3
|
|---|
| 155 | ClassifierBrowseMetadataRetrieve on the classifierNodeIDs</TD>
|
|---|
| 156 | </TR>
|
|---|
| 157 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 158 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 159 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 160 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#describeCollection(java.lang.String)">describeCollection</A></B>(java.lang.String collectionName)</CODE>
|
|---|
| 161 |
|
|---|
| 162 | <BR>
|
|---|
| 163 | </TD>
|
|---|
| 164 | </TR>
|
|---|
| 165 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 166 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 167 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 168 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#describeCollectionService(java.lang.String, java.lang.String)">describeCollectionService</A></B>(java.lang.String collectionName,
|
|---|
| 169 | java.lang.String serviceName)</CODE>
|
|---|
| 170 |
|
|---|
| 171 | <BR>
|
|---|
| 172 | All collections in this Digital Library (Fedora Repository) share
|
|---|
| 173 | the same services, so this method returns the same as
|
|---|
| 174 | describeService(serviceName).</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/fedora/services/FedoraToGS3Interface.html#describeCollectionServices(java.lang.String)">describeCollectionServices</A></B>(java.lang.String collectionName)</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/fedora/services/FedoraToGS3Interface.html#describeService(java.lang.String)">describeService</A></B>(java.lang.String serviceName)</CODE>
|
|---|
| 188 |
|
|---|
| 189 | <BR>
|
|---|
| 190 | All collections in this Digital Library (Fedora Repository) share
|
|---|
| 191 | the same services, so this method returns the same as
|
|---|
| 192 | describeCollectionService(collName, serviceName).</TD>
|
|---|
| 193 | </TR>
|
|---|
| 194 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 195 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 196 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 197 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getChildren(java.lang.String)">getChildren</A></B>(java.lang.String docID)</CODE>
|
|---|
| 198 |
|
|---|
| 199 | <BR>
|
|---|
| 200 | </TD>
|
|---|
| 201 | </TR>
|
|---|
| 202 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 203 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 204 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 205 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getChildren(java.lang.String[])">getChildren</A></B>(java.lang.String[] docIDs)</CODE>
|
|---|
| 206 |
|
|---|
| 207 | <BR>
|
|---|
| 208 | </TD>
|
|---|
| 209 | </TR>
|
|---|
| 210 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 211 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 212 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 213 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getCollectionList()">getCollectionList</A></B>()</CODE>
|
|---|
| 214 |
|
|---|
| 215 | <BR>
|
|---|
| 216 | </TD>
|
|---|
| 217 | </TR>
|
|---|
| 218 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 219 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 220 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 221 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getCollectionMetadata(java.lang.String)">getCollectionMetadata</A></B>(java.lang.String collID)</CODE>
|
|---|
| 222 |
|
|---|
| 223 | <BR>
|
|---|
| 224 | Given a collectionID, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 225 | response message that gives the metadata for the collection identified</TD>
|
|---|
| 226 | </TR>
|
|---|
| 227 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 228 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 229 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 230 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getCollectionMetadata(java.lang.String[])">getCollectionMetadata</A></B>(java.lang.String[] collIDs)</CODE>
|
|---|
| 231 |
|
|---|
| 232 | <BR>
|
|---|
| 233 | Given a list of collectionIDs, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 234 | response message that gives the metadata for each collection identified</TD>
|
|---|
| 235 | </TR>
|
|---|
| 236 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 237 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 238 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 239 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getContent(java.lang.String)">getContent</A></B>(java.lang.String docID)</CODE>
|
|---|
| 240 |
|
|---|
| 241 | <BR>
|
|---|
| 242 | Given a list of document identifiers that are either docPIDs or
|
|---|
| 243 | concatenations of docPID+sectionID, this method retrieves their contents.</TD>
|
|---|
| 244 | </TR>
|
|---|
| 245 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 246 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 247 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 248 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getContent(java.lang.String[])">getContent</A></B>(java.lang.String[] docIDs)</CODE>
|
|---|
| 249 |
|
|---|
| 250 | <BR>
|
|---|
| 251 | Given a document identifier that is either a docPID or a concatenation
|
|---|
| 252 | of docPID+sectionID, this method retrieves the content for it.</TD>
|
|---|
| 253 | </TR>
|
|---|
| 254 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 255 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 256 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 257 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getDocumentMetadata(java.lang.String)">getDocumentMetadata</A></B>(java.lang.String docID)</CODE>
|
|---|
| 258 |
|
|---|
| 259 | <BR>
|
|---|
| 260 | Given a document identifier, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 261 | response message containing the metadata for the document.</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/fedora/services/FedoraToGS3Interface.html#getDocumentMetadata(java.lang.String[])">getDocumentMetadata</A></B>(java.lang.String[] docIDs)</CODE>
|
|---|
| 267 |
|
|---|
| 268 | <BR>
|
|---|
| 269 | Given a list of document identifiers, a GS3 DocumentMetadataRetrieve
|
|---|
| 270 | response message is returned containing the metadata for each document.</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/fedora/services/FedoraToGS3Interface.html#getDocumentStructure(java.lang.String)">getDocumentStructure</A></B>(java.lang.String docID)</CODE>
|
|---|
| 276 |
|
|---|
| 277 | <BR>
|
|---|
| 278 | </TD>
|
|---|
| 279 | </TR>
|
|---|
| 280 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 281 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 282 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 283 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getDocumentStructure(java.lang.String[])">getDocumentStructure</A></B>(java.lang.String[] docIDs)</CODE>
|
|---|
| 284 |
|
|---|
| 285 | <BR>
|
|---|
| 286 | </TD>
|
|---|
| 287 | </TR>
|
|---|
| 288 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 289 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 290 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 291 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getMetadata(java.lang.String[])">getMetadata</A></B>(java.lang.String[] docIDsOrCollIDs)</CODE>
|
|---|
| 292 |
|
|---|
| 293 | <BR>
|
|---|
| 294 | </TD>
|
|---|
| 295 | </TR>
|
|---|
| 296 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 297 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 298 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 299 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getServiceList()">getServiceList</A></B>()</CODE>
|
|---|
| 300 |
|
|---|
| 301 | <BR>
|
|---|
| 302 | </TD>
|
|---|
| 303 | </TR>
|
|---|
| 304 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 305 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 306 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 307 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getTitleMetadata(java.lang.String)">getTitleMetadata</A></B>(java.lang.String docID)</CODE>
|
|---|
| 308 |
|
|---|
| 309 | <BR>
|
|---|
| 310 | Given a document identifier, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 311 | response message containing ONLY the Title metadata for the document.</TD>
|
|---|
| 312 | </TR>
|
|---|
| 313 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 314 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 315 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 316 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#getTitleMetadata(java.lang.String[])">getTitleMetadata</A></B>(java.lang.String[] docIDs)</CODE>
|
|---|
| 317 |
|
|---|
| 318 | <BR>
|
|---|
| 319 | Given a document identifier, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 320 | response message containing ONLY the Title metadata for the documents.</TD>
|
|---|
| 321 | </TR>
|
|---|
| 322 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 323 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 324 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 325 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html#query(java.lang.String, java.lang.String, java.util.Map)">query</A></B>(java.lang.String collection,
|
|---|
| 326 | java.lang.String service,
|
|---|
| 327 | java.util.Map nameValParamsMap)</CODE>
|
|---|
| 328 |
|
|---|
| 329 | <BR>
|
|---|
| 330 | </TD>
|
|---|
| 331 | </TR>
|
|---|
| 332 | </TABLE>
|
|---|
| 333 |
|
|---|
| 334 | <P>
|
|---|
| 335 |
|
|---|
| 336 | <!-- ============ METHOD DETAIL ========== -->
|
|---|
| 337 |
|
|---|
| 338 | <A NAME="method_detail"><!-- --></A>
|
|---|
| 339 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 340 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 341 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 342 | <B>Method Detail</B></FONT></TH>
|
|---|
| 343 | </TR>
|
|---|
| 344 | </TABLE>
|
|---|
| 345 |
|
|---|
| 346 | <A NAME="getServiceList()"><!-- --></A><H3>
|
|---|
| 347 | getServiceList</H3>
|
|---|
| 348 | <PRE>
|
|---|
| 349 | java.lang.String <B>getServiceList</B>()</PRE>
|
|---|
| 350 | <DL>
|
|---|
| 351 | <DD><DL>
|
|---|
| 352 |
|
|---|
| 353 | <DT><B>Returns:</B><DD>a GS3 response message for a describe services request:
|
|---|
| 354 | indicating the list of services supported by the Fedora-Greenstone
|
|---|
| 355 | interface. These are DocumentContentRetrieve, DocumentMetadataRetrieve,
|
|---|
| 356 | DocumentStructureRetrieve, BrowseByLetter - as indicated by member
|
|---|
| 357 | variable serviceNames.</DL>
|
|---|
| 358 | </DD>
|
|---|
| 359 | </DL>
|
|---|
| 360 | <HR>
|
|---|
| 361 |
|
|---|
| 362 | <A NAME="getCollectionList()"><!-- --></A><H3>
|
|---|
| 363 | getCollectionList</H3>
|
|---|
| 364 | <PRE>
|
|---|
| 365 | java.lang.String <B>getCollectionList</B>()</PRE>
|
|---|
| 366 | <DL>
|
|---|
| 367 | <DD><DL>
|
|---|
| 368 |
|
|---|
| 369 | <DT><B>Returns:</B><DD>a GS3 describe response message listing the collections and
|
|---|
| 370 | collection-specific metadata stored in the Fedora-Greenstone repository.</DL>
|
|---|
| 371 | </DD>
|
|---|
| 372 | </DL>
|
|---|
| 373 | <HR>
|
|---|
| 374 |
|
|---|
| 375 | <A NAME="describeCollection(java.lang.String)"><!-- --></A><H3>
|
|---|
| 376 | describeCollection</H3>
|
|---|
| 377 | <PRE>
|
|---|
| 378 | java.lang.String <B>describeCollection</B>(java.lang.String collectionName)</PRE>
|
|---|
| 379 | <DL>
|
|---|
| 380 | <DD><DL>
|
|---|
| 381 | <DT><B>Parameters:</B><DD><CODE>collectionName</CODE> - - the name of the collection that is to be described.
|
|---|
| 382 | It will be converted to a fedora collection pid, which is of the form
|
|---|
| 383 | "greenstone:<collectionName>-collection".
|
|---|
| 384 | <DT><B>Returns:</B><DD>a GS3 describe response message for a collection in the
|
|---|
| 385 | Fedora-Greenstone repository.</DL>
|
|---|
| 386 | </DD>
|
|---|
| 387 | </DL>
|
|---|
| 388 | <HR>
|
|---|
| 389 |
|
|---|
| 390 | <A NAME="describeCollectionServices(java.lang.String)"><!-- --></A><H3>
|
|---|
| 391 | describeCollectionServices</H3>
|
|---|
| 392 | <PRE>
|
|---|
| 393 | java.lang.String <B>describeCollectionServices</B>(java.lang.String collectionName)</PRE>
|
|---|
| 394 | <DL>
|
|---|
| 395 | <DD><DL>
|
|---|
| 396 | <DT><B>Parameters:</B><DD><CODE>collectionName</CODE> - - the name of the collection whose services are to
|
|---|
| 397 | be described. It will be converted to a fedora collection pid, which is of
|
|---|
| 398 | the form "greenstone:<collectionName>-collection".
|
|---|
| 399 | <DT><B>Returns:</B><DD>a GS3 describe response message for the services of a collection
|
|---|
| 400 | in the Fedora-Greenstone repository. So far, these services are the same for
|
|---|
| 401 | all fedora collections: they are the services given in member variable
|
|---|
| 402 | serviceNames: DocumentContent/Metadata/StructureRetrieve, browse.</DL>
|
|---|
| 403 | </DD>
|
|---|
| 404 | </DL>
|
|---|
| 405 | <HR>
|
|---|
| 406 |
|
|---|
| 407 | <A NAME="describeCollectionService(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 408 | describeCollectionService</H3>
|
|---|
| 409 | <PRE>
|
|---|
| 410 | java.lang.String <B>describeCollectionService</B>(java.lang.String collectionName,
|
|---|
| 411 | java.lang.String serviceName)</PRE>
|
|---|
| 412 | <DL>
|
|---|
| 413 | <DD>All collections in this Digital Library (Fedora Repository) share
|
|---|
| 414 | the same services, so this method returns the same as
|
|---|
| 415 | describeService(serviceName).
|
|---|
| 416 | <P>
|
|---|
| 417 | <DD><DL>
|
|---|
| 418 | <DT><B>Parameters:</B><DD><CODE>collectionName</CODE> - - the name of the collection whose service is to
|
|---|
| 419 | be described. It will be converted to a fedora collection pid, which is of
|
|---|
| 420 | the form "greenstone:<collectionName>-collection".<DD><CODE>serviceName</CODE> - - the name of the service in the collection which is to
|
|---|
| 421 | be described.
|
|---|
| 422 | <DT><B>Returns:</B><DD>a GS3 describe response message for the requested service
|
|---|
| 423 | of the given collection. DocumentContent/Metadata/StructureRetrieve
|
|---|
| 424 | return nothing special except their names; browse (and any query)
|
|---|
| 425 | return more complex XML responses.</DL>
|
|---|
| 426 | </DD>
|
|---|
| 427 | </DL>
|
|---|
| 428 | <HR>
|
|---|
| 429 |
|
|---|
| 430 | <A NAME="describeService(java.lang.String)"><!-- --></A><H3>
|
|---|
| 431 | describeService</H3>
|
|---|
| 432 | <PRE>
|
|---|
| 433 | java.lang.String <B>describeService</B>(java.lang.String serviceName)</PRE>
|
|---|
| 434 | <DL>
|
|---|
| 435 | <DD>All collections in this Digital Library (Fedora Repository) share
|
|---|
| 436 | the same services, so this method returns the same as
|
|---|
| 437 | describeCollectionService(collName, serviceName).
|
|---|
| 438 | <P>
|
|---|
| 439 | <DD><DL>
|
|---|
| 440 | <DT><B>Parameters:</B><DD><CODE>serviceName</CODE> - - the name of the service in the collection which is to
|
|---|
| 441 | be described.
|
|---|
| 442 | <DT><B>Returns:</B><DD>a GS3 describe response message for the requested service
|
|---|
| 443 | of the given collection. DocumentContent/Metadata/StructureRetrieve
|
|---|
| 444 | return nothing special except their names; browse (and any query)
|
|---|
| 445 | return more complex XML responses.
|
|---|
| 446 | All collections in this Digital Library (Fedora Repository) share
|
|---|
| 447 | the same services, so this method returns the same as
|
|---|
| 448 | describeService(serviceName).</DL>
|
|---|
| 449 | </DD>
|
|---|
| 450 | </DL>
|
|---|
| 451 | <HR>
|
|---|
| 452 |
|
|---|
| 453 | <A NAME="getContent(java.lang.String)"><!-- --></A><H3>
|
|---|
| 454 | getContent</H3>
|
|---|
| 455 | <PRE>
|
|---|
| 456 | java.lang.String <B>getContent</B>(java.lang.String docID)</PRE>
|
|---|
| 457 | <DL>
|
|---|
| 458 | <DD>Given a list of document identifiers that are either docPIDs or
|
|---|
| 459 | concatenations of docPID+sectionID, this method retrieves their contents.
|
|---|
| 460 | <P>
|
|---|
| 461 | <DD><DL>
|
|---|
| 462 | <DT><B>Parameters:</B><DD><CODE>docID</CODE> - is expected to be of the form
|
|---|
| 463 | "greenstone:<collectionName>-<docPID>-<sectionNumber>" or
|
|---|
| 464 | "greenstone:<collectionName>-<docPID>"
|
|---|
| 465 | If it is "greenstone:<collectionName>-<docPID>", then the content for
|
|---|
| 466 | "greenstone:<collectionName>-1" ("greenstone:<collectionName>-Section1")
|
|---|
| 467 | is returned.</DL>
|
|---|
| 468 | </DD>
|
|---|
| 469 | </DL>
|
|---|
| 470 | <HR>
|
|---|
| 471 |
|
|---|
| 472 | <A NAME="getContent(java.lang.String[])"><!-- --></A><H3>
|
|---|
| 473 | getContent</H3>
|
|---|
| 474 | <PRE>
|
|---|
| 475 | java.lang.String <B>getContent</B>(java.lang.String[] docIDs)</PRE>
|
|---|
| 476 | <DL>
|
|---|
| 477 | <DD>Given a document identifier that is either a docPID or a concatenation
|
|---|
| 478 | of docPID+sectionID, this method retrieves the content for it.
|
|---|
| 479 | <P>
|
|---|
| 480 | <DD><DL>
|
|---|
| 481 | <DT><B>Parameters:</B><DD><CODE>docIDs</CODE> - an array of document IDs where each is expected to be of the
|
|---|
| 482 | form "greenstone:<collectionName>-<docPID>-<sectionNumber>"
|
|---|
| 483 | or "greenstone:<collectionName>-<docPID>"
|
|---|
| 484 | If it is "greenstone:<collectionName>-<docPID>", then the content for
|
|---|
| 485 | "greenstone:<collectionName>-1" ("greenstone:<collectionName>-Section1")
|
|---|
| 486 | is returned.</DL>
|
|---|
| 487 | </DD>
|
|---|
| 488 | </DL>
|
|---|
| 489 | <HR>
|
|---|
| 490 |
|
|---|
| 491 | <A NAME="getDocumentStructure(java.lang.String)"><!-- --></A><H3>
|
|---|
| 492 | getDocumentStructure</H3>
|
|---|
| 493 | <PRE>
|
|---|
| 494 | java.lang.String <B>getDocumentStructure</B>(java.lang.String docID)</PRE>
|
|---|
| 495 | <DL>
|
|---|
| 496 | <DD><DL>
|
|---|
| 497 | <DT><B>Parameters:</B><DD><CODE>docID</CODE> - the identifier for the document whose structure is required.
|
|---|
| 498 | This is either of the format "greenstone:<collectionName>-<docPID>"
|
|---|
| 499 | OR "greenstone:<collectionName>-<docPID>-"
|
|---|
| 500 | where "greenstone:<collectionName>-<docPID>-1" is the same as
|
|---|
| 501 | "greenstone:<collectionName>-<docPID>" and will return the same response
|
|---|
| 502 | <DT><B>Returns:</B><DD>the documentStructure of the document or section given by docID.
|
|---|
| 503 | The structure is returned in the XML format of a Greenstone3
|
|---|
| 504 | DocumentStructureRetrieve response message. This method returns the entire
|
|---|
| 505 | subSection of the docID (that is, all descendents included).</DL>
|
|---|
| 506 | </DD>
|
|---|
| 507 | </DL>
|
|---|
| 508 | <HR>
|
|---|
| 509 |
|
|---|
| 510 | <A NAME="getChildren(java.lang.String)"><!-- --></A><H3>
|
|---|
| 511 | getChildren</H3>
|
|---|
| 512 | <PRE>
|
|---|
| 513 | java.lang.String <B>getChildren</B>(java.lang.String docID)</PRE>
|
|---|
| 514 | <DL>
|
|---|
| 515 | <DD><DL>
|
|---|
| 516 | <DT><B>Parameters:</B><DD><CODE>docID</CODE> - the identifier for the document whose structure is required.
|
|---|
| 517 | This is of the format "greenstone:<collectionName>-<docPID>"
|
|---|
| 518 | OR "greenstone:<collectionName>-<docPID>-"
|
|---|
| 519 | where "greenstone:<collectionName>-<docPID>-1" is the same as
|
|---|
| 520 | "greenstone:<collectionName>-<docPID>" and will return the same response
|
|---|
| 521 | <DT><B>Returns:</B><DD>a view of the structure of the document or section given by docID
|
|---|
| 522 | which contains only the section and its direct children. This structure is
|
|---|
| 523 | returned in the XML format of a Greenstone3 DocumentStructureRetrieve
|
|---|
| 524 | response message.</DL>
|
|---|
| 525 | </DD>
|
|---|
| 526 | </DL>
|
|---|
| 527 | <HR>
|
|---|
| 528 |
|
|---|
| 529 | <A NAME="getDocumentStructure(java.lang.String[])"><!-- --></A><H3>
|
|---|
| 530 | getDocumentStructure</H3>
|
|---|
| 531 | <PRE>
|
|---|
| 532 | java.lang.String <B>getDocumentStructure</B>(java.lang.String[] docIDs)</PRE>
|
|---|
| 533 | <DL>
|
|---|
| 534 | <DD><DL>
|
|---|
| 535 | <DT><B>Parameters:</B><DD><CODE>docIDs</CODE> - an array of document identifiers whose structures are requested
|
|---|
| 536 | These are of the format "greenstone:<collectionName>-<docPID>"
|
|---|
| 537 | OR "greenstone:<collectionName>-<docPID>-<sectionNumber>"
|
|---|
| 538 | where "greenstone:<collectionName>-<docPID>-1" is the same as
|
|---|
| 539 | "greenstone:<collectionName>-<docPID>" and will return the same response
|
|---|
| 540 | <DT><B>Returns:</B><DD>the documentStructure of the documents or sections given by docIDs.
|
|---|
| 541 | The structure is returned in the XML format of a Greenstone3
|
|---|
| 542 | DocumentStructureRetrieve response message. This method returns the entire
|
|---|
| 543 | subSection of each docID (that is, all descendents included).</DL>
|
|---|
| 544 | </DD>
|
|---|
| 545 | </DL>
|
|---|
| 546 | <HR>
|
|---|
| 547 |
|
|---|
| 548 | <A NAME="getChildren(java.lang.String[])"><!-- --></A><H3>
|
|---|
| 549 | getChildren</H3>
|
|---|
| 550 | <PRE>
|
|---|
| 551 | java.lang.String <B>getChildren</B>(java.lang.String[] docIDs)</PRE>
|
|---|
| 552 | <DL>
|
|---|
| 553 | <DD><DL>
|
|---|
| 554 | <DT><B>Parameters:</B><DD><CODE>docIDs</CODE> - an array of document identifiers whose structures are requested
|
|---|
| 555 | These are of the format "greenstone:<collectionName>-<docPID>"
|
|---|
| 556 | OR "greenstone:<collectionName>-<docPID>-<sectionNumber>"
|
|---|
| 557 | where "greenstone:<collectionName>-<docPID>-1" is the same as
|
|---|
| 558 | "greenstone:<collectionName>-<docPID>" and will return the same response
|
|---|
| 559 | <DT><B>Returns:</B><DD>the documentStructure of the documents or sections given by docIDs
|
|---|
| 560 | but only the sections and their children (not any further descendents).
|
|---|
| 561 | The structure is returned in the XML format of a Greenstone3
|
|---|
| 562 | DocumentStructureRetrieve response message.</DL>
|
|---|
| 563 | </DD>
|
|---|
| 564 | </DL>
|
|---|
| 565 | <HR>
|
|---|
| 566 |
|
|---|
| 567 | <A NAME="getCollectionMetadata(java.lang.String[])"><!-- --></A><H3>
|
|---|
| 568 | getCollectionMetadata</H3>
|
|---|
| 569 | <PRE>
|
|---|
| 570 | java.lang.String <B>getCollectionMetadata</B>(java.lang.String[] collIDs)</PRE>
|
|---|
| 571 | <DL>
|
|---|
| 572 | <DD>Given a list of collectionIDs, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 573 | response message that gives the metadata for each collection identified
|
|---|
| 574 | <P>
|
|---|
| 575 | <DD><DL>
|
|---|
| 576 | <DT><B>Parameters:</B><DD><CODE>collIDs</CODE> - is an array of fedora pids identifying collections in the
|
|---|
| 577 | fedora repository
|
|---|
| 578 | <DT><B>Returns:</B><DD>a GS3 DocumentMetadataRetrieve response message containing the
|
|---|
| 579 | EX metadata for all the requested collections</DL>
|
|---|
| 580 | </DD>
|
|---|
| 581 | </DL>
|
|---|
| 582 | <HR>
|
|---|
| 583 |
|
|---|
| 584 | <A NAME="getDocumentMetadata(java.lang.String[])"><!-- --></A><H3>
|
|---|
| 585 | getDocumentMetadata</H3>
|
|---|
| 586 | <PRE>
|
|---|
| 587 | java.lang.String <B>getDocumentMetadata</B>(java.lang.String[] docIDs)</PRE>
|
|---|
| 588 | <DL>
|
|---|
| 589 | <DD>Given a list of document identifiers, a GS3 DocumentMetadataRetrieve
|
|---|
| 590 | response message is returned containing the metadata for each document.
|
|---|
| 591 | <P>
|
|---|
| 592 | <DD><DL>
|
|---|
| 593 | <DT><B>Parameters:</B><DD><CODE>docIDs</CODE> - is an array of document identifiers (docID can either be <pid>s
|
|---|
| 594 | items (documents) in the fedora repository, or "<pid>-sectionNumber".
|
|---|
| 595 | <DT><B>Returns:</B><DD>a GS3 DocumentMetadataRetrieve response message containing the
|
|---|
| 596 | EX, DC, DLS metadata for all the requested documents</DL>
|
|---|
| 597 | </DD>
|
|---|
| 598 | </DL>
|
|---|
| 599 | <HR>
|
|---|
| 600 |
|
|---|
| 601 | <A NAME="getCollectionMetadata(java.lang.String)"><!-- --></A><H3>
|
|---|
| 602 | getCollectionMetadata</H3>
|
|---|
| 603 | <PRE>
|
|---|
| 604 | java.lang.String <B>getCollectionMetadata</B>(java.lang.String collID)</PRE>
|
|---|
| 605 | <DL>
|
|---|
| 606 | <DD>Given a collectionID, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 607 | response message that gives the metadata for the collection identified
|
|---|
| 608 | <P>
|
|---|
| 609 | <DD><DL>
|
|---|
| 610 | <DT><B>Parameters:</B><DD><CODE>collID</CODE> - is a fedora pid identifying a collection in its repository
|
|---|
| 611 | <DT><B>Returns:</B><DD>a GS3 DocumentMetadataRetrieve response message containing the
|
|---|
| 612 | EX metadata for the requested collection</DL>
|
|---|
| 613 | </DD>
|
|---|
| 614 | </DL>
|
|---|
| 615 | <HR>
|
|---|
| 616 |
|
|---|
| 617 | <A NAME="getDocumentMetadata(java.lang.String)"><!-- --></A><H3>
|
|---|
| 618 | getDocumentMetadata</H3>
|
|---|
| 619 | <PRE>
|
|---|
| 620 | java.lang.String <B>getDocumentMetadata</B>(java.lang.String docID)</PRE>
|
|---|
| 621 | <DL>
|
|---|
| 622 | <DD>Given a document identifier, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 623 | response message containing the metadata for the document.
|
|---|
| 624 | <P>
|
|---|
| 625 | <DD><DL>
|
|---|
| 626 | <DT><B>Parameters:</B><DD><CODE>docID</CODE> - is a document identifier (docID can either be a <pid>
|
|---|
| 627 | of an item (document) in the fedora repository, or it can be
|
|---|
| 628 | "<pid>-sectionNumber".
|
|---|
| 629 | <DT><B>Returns:</B><DD>a GS3 DocumentMetadataRetrieve response message containing the
|
|---|
| 630 | EX, DC, DLS metadata for all the requested document</DL>
|
|---|
| 631 | </DD>
|
|---|
| 632 | </DL>
|
|---|
| 633 | <HR>
|
|---|
| 634 |
|
|---|
| 635 | <A NAME="getMetadata(java.lang.String[])"><!-- --></A><H3>
|
|---|
| 636 | getMetadata</H3>
|
|---|
| 637 | <PRE>
|
|---|
| 638 | java.lang.String <B>getMetadata</B>(java.lang.String[] docIDsOrCollIDs)</PRE>
|
|---|
| 639 | <DL>
|
|---|
| 640 | <DD><DL>
|
|---|
| 641 | <DT><B>Parameters:</B><DD><CODE>docIDsOrCollIDs</CODE> - is an array of identifiers which may be either the
|
|---|
| 642 | fedora pids for collections, or otherwise may be a document identifier.
|
|---|
| 643 | In the last case, the document ID may consist of either
|
|---|
| 644 | "documentPID-sectionNumber" or may just be just fedora documentPID
|
|---|
| 645 | <DT><B>Returns:</B><DD>a greenstone DocumentMetadataRetrieve response for the
|
|---|
| 646 | documents or collections indicated by the docIDsOrCollIDs.</DL>
|
|---|
| 647 | </DD>
|
|---|
| 648 | </DL>
|
|---|
| 649 | <HR>
|
|---|
| 650 |
|
|---|
| 651 | <A NAME="getTitleMetadata(java.lang.String)"><!-- --></A><H3>
|
|---|
| 652 | getTitleMetadata</H3>
|
|---|
| 653 | <PRE>
|
|---|
| 654 | java.lang.String <B>getTitleMetadata</B>(java.lang.String docID)</PRE>
|
|---|
| 655 | <DL>
|
|---|
| 656 | <DD>Given a document identifier, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 657 | response message containing ONLY the Title metadata for the document.
|
|---|
| 658 | <P>
|
|---|
| 659 | <DD><DL>
|
|---|
| 660 | <DT><B>Parameters:</B><DD><CODE>docID</CODE> - is a document identifier (docID can either be a <pid>
|
|---|
| 661 | of an item (document) in the fedora repository, or it can be
|
|---|
| 662 | "<pid>-sectionNumber".
|
|---|
| 663 | <DT><B>Returns:</B><DD>a GS3 DocumentMetadataRetrieve response message containing the
|
|---|
| 664 | Title metadata for the requested document</DL>
|
|---|
| 665 | </DD>
|
|---|
| 666 | </DL>
|
|---|
| 667 | <HR>
|
|---|
| 668 |
|
|---|
| 669 | <A NAME="getTitleMetadata(java.lang.String[])"><!-- --></A><H3>
|
|---|
| 670 | getTitleMetadata</H3>
|
|---|
| 671 | <PRE>
|
|---|
| 672 | java.lang.String <B>getTitleMetadata</B>(java.lang.String[] docIDs)</PRE>
|
|---|
| 673 | <DL>
|
|---|
| 674 | <DD>Given a document identifier, returns a GS3 DocumentMetadataRetrieve
|
|---|
| 675 | response message containing ONLY the Title metadata for the documents.
|
|---|
| 676 | <P>
|
|---|
| 677 | <DD><DL>
|
|---|
| 678 | <DT><B>Parameters:</B><DD><CODE>docIDs</CODE> - is a list of document identifiers (where docID can either be
|
|---|
| 679 | a <pid> of an item (document) in the fedora repository, or it can be
|
|---|
| 680 | "<pid>-sectionNumber".
|
|---|
| 681 | <DT><B>Returns:</B><DD>a GS3 DocumentMetadataRetrieve response message containing the
|
|---|
| 682 | Title metadata for all the requested documents</DL>
|
|---|
| 683 | </DD>
|
|---|
| 684 | </DL>
|
|---|
| 685 | <HR>
|
|---|
| 686 |
|
|---|
| 687 | <A NAME="browseMetadataRetrieve(java.lang.String[])"><!-- --></A><H3>
|
|---|
| 688 | browseMetadataRetrieve</H3>
|
|---|
| 689 | <PRE>
|
|---|
| 690 | java.lang.String <B>browseMetadataRetrieve</B>(java.lang.String[] classNodeIDs)</PRE>
|
|---|
| 691 | <DL>
|
|---|
| 692 | <DD>This method performs something equivalent to a greenstone3
|
|---|
| 693 | ClassifierBrowseMetadataRetrieve on the classifierNodeIDs
|
|---|
| 694 | <P>
|
|---|
| 695 | <DD><DL>
|
|---|
| 696 | <DT><B>Parameters:</B><DD><CODE>classNodeIDs</CODE> - are the IDs of the classifierNode for which the metadata
|
|---|
| 697 | needs to be returned
|
|---|
| 698 | <DT><B>Returns:</B><DD>a GS3 ClassifierBrowseMetadataRetrieve response message which
|
|---|
| 699 | lists the metadata for all the classifierNodes passed as parameter.</DL>
|
|---|
| 700 | </DD>
|
|---|
| 701 | </DL>
|
|---|
| 702 | <HR>
|
|---|
| 703 |
|
|---|
| 704 | <A NAME="browse(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|---|
| 705 | browse</H3>
|
|---|
| 706 | <PRE>
|
|---|
| 707 | java.lang.String <B>browse</B>(java.lang.String collectionName,
|
|---|
| 708 | java.lang.String classifierID)</PRE>
|
|---|
| 709 | <DL>
|
|---|
| 710 | <DD>This method performs the implemented browse operation: allowing the
|
|---|
| 711 | user to browse the titles of documents in the given collection by letter
|
|---|
| 712 | and returning the results.
|
|---|
| 713 | <P>
|
|---|
| 714 | <DD><DL>
|
|---|
| 715 | <DT><B>Parameters:</B><DD><CODE>classifierID</CODE> - is the id of the classifier on which to browse. In
|
|---|
| 716 | this case, the classifier indicates whether we browse titles by letter, or
|
|---|
| 717 | browse (documents) by collection; and it is of the form <CL(letter)>.<DD><CODE>collectionName</CODE> - is the name of the collection whose documents
|
|---|
| 718 | starting with the given letter will be returned.
|
|---|
| 719 | <DT><B>Returns:</B><DD>a GS3 DocumentStructureRetrieve response message which lists all
|
|---|
| 720 | the documents that start with the letter indicated by parameter classifier.</DL>
|
|---|
| 721 | </DD>
|
|---|
| 722 | </DL>
|
|---|
| 723 | <HR>
|
|---|
| 724 |
|
|---|
| 725 | <A NAME="query(java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3>
|
|---|
| 726 | query</H3>
|
|---|
| 727 | <PRE>
|
|---|
| 728 | java.lang.String <B>query</B>(java.lang.String collection,
|
|---|
| 729 | java.lang.String service,
|
|---|
| 730 | java.util.Map nameValParamsMap)</PRE>
|
|---|
| 731 | <DL>
|
|---|
| 732 | <DD><DL>
|
|---|
| 733 | <DT><B>Parameters:</B><DD><CODE>nameValParamsMap</CODE> - is a Map of name and value pairs for all the
|
|---|
| 734 | query field data values. The names match the field names that
|
|---|
| 735 | 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
|
|---|
| 736 | This method is only ever called when any of the services in the digital
|
|---|
| 737 | library described themselves as type=query. Therefore any digital
|
|---|
| 738 | libraries that have no query services, can just return emtpy message
|
|---|
| 739 | strings (or even "") since this method will never be called on them
|
|---|
| 740 | anyway.
|
|---|
| 741 | <DT><B>Returns:</B><DD>a String representing Greenstone3 XML for a query process
|
|---|
| 742 | response returning the results for the query denoted by parameter
|
|---|
| 743 | nameValParamsMap.</DL>
|
|---|
| 744 | </DD>
|
|---|
| 745 | </DL>
|
|---|
| 746 | <!-- ========= END OF CLASS DATA ========= -->
|
|---|
| 747 | <HR>
|
|---|
| 748 |
|
|---|
| 749 |
|
|---|
| 750 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|---|
| 751 | <A NAME="navbar_bottom"><!-- --></A>
|
|---|
| 752 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|---|
| 753 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|---|
| 754 | <TR>
|
|---|
| 755 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|---|
| 756 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|---|
| 757 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|---|
| 758 | <TR ALIGN="center" VALIGN="top">
|
|---|
| 759 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/greenstone/fedora/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|---|
| 760 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|---|
| 761 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|---|
| 762 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|---|
| 763 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|---|
| 764 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|---|
| 765 | </TR>
|
|---|
| 766 | </TABLE>
|
|---|
| 767 | </TD>
|
|---|
| 768 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|---|
| 769 | </EM>
|
|---|
| 770 | </TD>
|
|---|
| 771 | </TR>
|
|---|
| 772 |
|
|---|
| 773 | <TR>
|
|---|
| 774 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 775 | <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.ServerNotFoundException.html" title="class in org.greenstone.fedora.services"><B>PREV CLASS</B></A>
|
|---|
| 776 | <A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.Constants.html" title="interface in org.greenstone.fedora.services"><B>NEXT CLASS</B></A></FONT></TD>
|
|---|
| 777 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 778 | <A HREF="../../../../index.html?org/greenstone/fedora/services/FedoraToGS3Interface.html" target="_top"><B>FRAMES</B></A>
|
|---|
| 779 | <A HREF="FedoraToGS3Interface.html" target="_top"><B>NO FRAMES</B></A>
|
|---|
| 780 | <SCRIPT type="text/javascript">
|
|---|
| 781 | <!--
|
|---|
| 782 | if(window==top) {
|
|---|
| 783 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|---|
| 784 | }
|
|---|
| 785 | //-->
|
|---|
| 786 | </SCRIPT>
|
|---|
| 787 | <NOSCRIPT>
|
|---|
| 788 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|---|
| 789 | </NOSCRIPT>
|
|---|
| 790 |
|
|---|
| 791 |
|
|---|
| 792 | </FONT></TD>
|
|---|
| 793 | </TR>
|
|---|
| 794 | <TR>
|
|---|
| 795 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 796 | SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|---|
| 797 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 798 | DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|---|
| 799 | </TR>
|
|---|
| 800 | </TABLE>
|
|---|
| 801 | <A NAME="skip-navbar_bottom"></A>
|
|---|
| 802 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|---|
| 803 |
|
|---|
| 804 | <HR>
|
|---|
| 805 |
|
|---|
| 806 | </BODY>
|
|---|
| 807 | </HTML>
|
|---|
