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 | FedoraGS3DL
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.greenstone.fedora.services.FedoraGS3DL 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="FedoraGS3DL";
|
---|
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/FedoraGS3Connection.html" title="class in org.greenstone.fedora.services"><B>PREV CLASS</B></A>
|
---|
54 | <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.html" title="class 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/FedoraGS3DL.html" target="_top"><B>FRAMES</B></A>
|
---|
57 | <A HREF="FedoraGS3DL.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: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
75 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
76 | DETAIL: <A HREF="#field_detail">FIELD</A> | 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 FedoraGS3DL</H2>
|
---|
89 | <DL>
|
---|
90 | <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html" title="class in org.greenstone.fedora.services">FedoraConnection</A>, <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>FedoraGS3DL</B></DL>
|
---|
95 | </PRE>
|
---|
96 |
|
---|
97 | <P>
|
---|
98 | Defines the methods that must be provided to retrieve the datastreams
|
---|
99 | specific to Greenstone documents stored in a Fedora repository.
|
---|
100 | <P>
|
---|
101 |
|
---|
102 | <P>
|
---|
103 | <DL>
|
---|
104 | <DT><B>Author:</B></DT>
|
---|
105 | <DD>ak19</DD>
|
---|
106 | </DL>
|
---|
107 | <HR>
|
---|
108 |
|
---|
109 | <P>
|
---|
110 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
111 |
|
---|
112 | <A NAME="field_summary"><!-- --></A>
|
---|
113 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
114 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
115 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
116 | <B>Field Summary</B></FONT></TH>
|
---|
117 | </TR>
|
---|
118 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
119 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
120 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
121 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#_COLLECTION">_COLLECTION</A></B></CODE>
|
---|
122 |
|
---|
123 | <BR>
|
---|
124 | </TD>
|
---|
125 | </TR>
|
---|
126 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
127 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
128 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
129 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#COLLECTION">COLLECTION</A></B></CODE>
|
---|
130 |
|
---|
131 | <BR>
|
---|
132 | </TD>
|
---|
133 | </TR>
|
---|
134 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
135 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
136 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
137 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#COLLECTIONNAME">COLLECTIONNAME</A></B></CODE>
|
---|
138 |
|
---|
139 | <BR>
|
---|
140 | </TD>
|
---|
141 | </TR>
|
---|
142 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
143 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
144 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
145 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#COLON">COLON</A></B></CODE>
|
---|
146 |
|
---|
147 | <BR>
|
---|
148 | </TD>
|
---|
149 | </TR>
|
---|
150 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
151 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
152 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
153 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#DC">DC</A></B></CODE>
|
---|
154 |
|
---|
155 | <BR>
|
---|
156 | Fedora's Dublin Core metadata</TD>
|
---|
157 | </TR>
|
---|
158 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
159 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
160 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
161 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#DLS">DLS</A></B></CODE>
|
---|
162 |
|
---|
163 | <BR>
|
---|
164 | DLS metadata of Greenstone documents - this metadata set is optionally
|
---|
165 | provided for top level documents.</TD>
|
---|
166 | </TR>
|
---|
167 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
168 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
169 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
170 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#ENGLISH">ENGLISH</A></B></CODE>
|
---|
171 |
|
---|
172 | <BR>
|
---|
173 | </TD>
|
---|
174 | </TR>
|
---|
175 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
176 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
177 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
178 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#EX">EX</A></B></CODE>
|
---|
179 |
|
---|
180 | <BR>
|
---|
181 | EX marks the XML metadata file that contains Greenstone extracted
|
---|
182 | metadata</TD>
|
---|
183 | </TR>
|
---|
184 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
185 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
186 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
187 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#FEDORA_GS3">FEDORA_GS3</A></B></CODE>
|
---|
188 |
|
---|
189 | <BR>
|
---|
190 | Instead of message router, we indicate that request messages
|
---|
191 | sent here come from FedoraGS3</TD>
|
---|
192 | </TR>
|
---|
193 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
194 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
195 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
196 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#GREENSTONE">GREENSTONE</A></B></CODE>
|
---|
197 |
|
---|
198 | <BR>
|
---|
199 | "greenstone" is the FEDORA PID prefix we'll be working with</TD>
|
---|
200 | </TR>
|
---|
201 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
202 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
203 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
204 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#GREENSTONE_">GREENSTONE_</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>static java.lang.String</CODE></FONT></TD>
|
---|
212 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#HYPHEN">HYPHEN</A></B></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>static java.lang.String</CODE></FONT></TD>
|
---|
220 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#ID">ID</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>static java.lang.String</CODE></FONT></TD>
|
---|
228 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#METADATA">METADATA</A></B></CODE>
|
---|
229 |
|
---|
230 | <BR>
|
---|
231 | </TD>
|
---|
232 | </TR>
|
---|
233 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
234 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
235 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
236 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#NAME">NAME</A></B></CODE>
|
---|
237 |
|
---|
238 | <BR>
|
---|
239 | </TD>
|
---|
240 | </TR>
|
---|
241 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
242 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
243 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
244 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#PERIOD">PERIOD</A></B></CODE>
|
---|
245 |
|
---|
246 | <BR>
|
---|
247 | </TD>
|
---|
248 | </TR>
|
---|
249 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
250 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
251 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
252 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#QUALIFIER">QUALIFIER</A></B></CODE>
|
---|
253 |
|
---|
254 | <BR>
|
---|
255 | </TD>
|
---|
256 | </TR>
|
---|
257 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
258 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
259 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
260 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#SECTION">SECTION</A></B></CODE>
|
---|
261 |
|
---|
262 | <BR>
|
---|
263 | The SECTION prefix in the name of a section's datastream;
|
---|
264 | eg.</TD>
|
---|
265 | </TR>
|
---|
266 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
267 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
268 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
269 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#SECTION_ELEMENT">SECTION_ELEMENT</A></B></CODE>
|
---|
270 |
|
---|
271 | <BR>
|
---|
272 | </TD>
|
---|
273 | </TR>
|
---|
274 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
275 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
276 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
277 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#TITLE">TITLE</A></B></CODE>
|
---|
278 |
|
---|
279 | <BR>
|
---|
280 | </TD>
|
---|
281 | </TR>
|
---|
282 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
283 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
284 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
285 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#TOC">TOC</A></B></CODE>
|
---|
286 |
|
---|
287 | <BR>
|
---|
288 | Table of contents for a Greenstone-Fedora document which outlines the
|
---|
289 | structure of the document.</TD>
|
---|
290 | </TR>
|
---|
291 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
292 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
293 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
294 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#UTF8">UTF8</A></B></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>static java.lang.String</CODE></FONT></TD>
|
---|
302 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#WILDCARD">WILDCARD</A></B></CODE>
|
---|
303 |
|
---|
304 | <BR>
|
---|
305 | </TD>
|
---|
306 | </TR>
|
---|
307 | </TABLE>
|
---|
308 |
|
---|
309 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
310 |
|
---|
311 | <A NAME="method_summary"><!-- --></A>
|
---|
312 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
313 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
314 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
315 | <B>Method Summary</B></FONT></TH>
|
---|
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/fedora/services/FedoraGS3DL.html#browseTitlesByLetter(java.lang.String, java.lang.String)">browseTitlesByLetter</A></B>(java.lang.String collName,
|
---|
321 | java.lang.String letter)</CODE>
|
---|
322 |
|
---|
323 | <BR>
|
---|
324 | Allows browsing document titles of a greenstone collection stored in
|
---|
325 | the fedora repository by letter.</TD>
|
---|
326 | </TR>
|
---|
327 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
328 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
329 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
330 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getAssocFileBaseURL()">getAssocFileBaseURL</A></B>()</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/fedora/services/FedoraGS3DL.html#getBaseURL()">getBaseURL</A></B>()</CODE>
|
---|
339 |
|
---|
340 | <BR>
|
---|
341 | </TD>
|
---|
342 | </TR>
|
---|
343 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
344 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
345 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
346 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getChildrenOfSection(java.lang.String, java.lang.String)">getChildrenOfSection</A></B>(java.lang.String docPID,
|
---|
347 | java.lang.String sectionID)</CODE>
|
---|
348 |
|
---|
349 | <BR>
|
---|
350 | </TD>
|
---|
351 | </TR>
|
---|
352 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
353 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
354 | <CODE> org.w3c.dom.Element</CODE></FONT></TD>
|
---|
355 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getChildrenOfSectionXML(java.lang.String, java.lang.String)">getChildrenOfSectionXML</A></B>(java.lang.String docPID,
|
---|
356 | java.lang.String sectionID)</CODE>
|
---|
357 |
|
---|
358 | <BR>
|
---|
359 | </TD>
|
---|
360 | </TR>
|
---|
361 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
362 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
363 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
364 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionDocs(java.lang.String)">getCollectionDocs</A></B>(java.lang.String colPID)</CODE>
|
---|
365 |
|
---|
366 | <BR>
|
---|
367 | </TD>
|
---|
368 | </TR>
|
---|
369 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
370 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
371 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
372 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionName(java.lang.String)">getCollectionName</A></B>(java.lang.String collPID)</CODE>
|
---|
373 |
|
---|
374 | <BR>
|
---|
375 | </TD>
|
---|
376 | </TR>
|
---|
377 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
378 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
379 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
380 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionNames(java.lang.String[])">getCollectionNames</A></B>(java.lang.String[] collPIDs)</CODE>
|
---|
381 |
|
---|
382 | <BR>
|
---|
383 | </TD>
|
---|
384 | </TR>
|
---|
385 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
386 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
387 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
388 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionPID(java.lang.String)">getCollectionPID</A></B>(java.lang.String collName)</CODE>
|
---|
389 |
|
---|
390 | <BR>
|
---|
391 | </TD>
|
---|
392 | </TR>
|
---|
393 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
394 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
395 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
396 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionPIDs(java.lang.String[])">getCollectionPIDs</A></B>(java.lang.String[] collNames)</CODE>
|
---|
397 |
|
---|
398 | <BR>
|
---|
399 | </TD>
|
---|
400 | </TR>
|
---|
401 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
402 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
403 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
404 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollections()">getCollections</A></B>()</CODE>
|
---|
405 |
|
---|
406 | <BR>
|
---|
407 | Gets all greenstone collections.</TD>
|
---|
408 | </TR>
|
---|
409 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
410 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
411 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
412 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionTitle(java.lang.String)">getCollectionTitle</A></B>(java.lang.String collPID)</CODE>
|
---|
413 |
|
---|
414 | <BR>
|
---|
415 | Gets the title of the collection denoted by the given collection's pid by
|
---|
416 | retrieving the title metadata for it from the collection's EX datastream.</TD>
|
---|
417 | </TR>
|
---|
418 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
419 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
420 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
421 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionTitles(java.lang.String[])">getCollectionTitles</A></B>(java.lang.String[] collPIDs)</CODE>
|
---|
422 |
|
---|
423 | <BR>
|
---|
424 | </TD>
|
---|
425 | </TR>
|
---|
426 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
427 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
428 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
429 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDC(java.lang.String)">getDC</A></B>(java.lang.String pid)</CODE>
|
---|
430 |
|
---|
431 | <BR>
|
---|
432 | All objects (incl "greenstone:*" objects) in fedora - be they collections,
|
---|
433 | top-level documents or document sections) have an EX datastream.</TD>
|
---|
434 | </TR>
|
---|
435 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
436 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
437 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
438 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDLS(java.lang.String)">getDLS</A></B>(java.lang.String pid)</CODE>
|
---|
439 |
|
---|
440 | <BR>
|
---|
441 | Some "greenstone:*" top-level documents in the fedora repository (but not
|
---|
442 | greenstone collections or document sections) have a DLS metadata datastream.</TD>
|
---|
443 | </TR>
|
---|
444 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
445 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
446 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
447 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDocName(java.lang.String)">getDocName</A></B>(java.lang.String docPID)</CODE>
|
---|
448 |
|
---|
449 | <BR>
|
---|
450 | </TD>
|
---|
451 | </TR>
|
---|
452 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
453 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
454 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
455 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDocTitle(java.lang.String)">getDocTitle</A></B>(java.lang.String docPID)</CODE>
|
---|
456 |
|
---|
457 | <BR>
|
---|
458 | Gets the title metadata for a particular doc object in a collection
|
---|
459 | denoted by docPID.</TD>
|
---|
460 | </TR>
|
---|
461 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
462 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
463 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
464 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDocTitles(java.lang.String[])">getDocTitles</A></B>(java.lang.String[] docPIDs)</CODE>
|
---|
465 |
|
---|
466 | <BR>
|
---|
467 | </TD>
|
---|
468 | </TR>
|
---|
469 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
470 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
471 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
472 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getEX(java.lang.String)">getEX</A></B>(java.lang.String pid)</CODE>
|
---|
473 |
|
---|
474 | <BR>
|
---|
475 | All "greenstone:*" objects in fedora (be they collections, top-level
|
---|
476 | documents or document sections) have an EX datastream.</TD>
|
---|
477 | </TR>
|
---|
478 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
479 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
480 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
481 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getLanguage()">getLanguage</A></B>()</CODE>
|
---|
482 |
|
---|
483 | <BR>
|
---|
484 | </TD>
|
---|
485 | </TR>
|
---|
486 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
487 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
488 | <CODE> int</CODE></FONT></TD>
|
---|
489 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getMaxResults()">getMaxResults</A></B>()</CODE>
|
---|
490 |
|
---|
491 | <BR>
|
---|
492 | The default maximum number of search results returned for a search.</TD>
|
---|
493 | </TR>
|
---|
494 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
495 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
496 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
497 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getPortAddressURL()">getPortAddressURL</A></B>()</CODE>
|
---|
498 |
|
---|
499 | <BR>
|
---|
500 | </TD>
|
---|
501 | </TR>
|
---|
502 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
503 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
504 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
505 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSection(java.lang.String, java.lang.String)">getSection</A></B>(java.lang.String docPID,
|
---|
506 | java.lang.String sectionID)</CODE>
|
---|
507 |
|
---|
508 | <BR>
|
---|
509 | </TD>
|
---|
510 | </TR>
|
---|
511 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
512 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
513 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
514 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionDCMetadata(java.lang.String, java.lang.String)">getSectionDCMetadata</A></B>(java.lang.String docPID,
|
---|
515 | java.lang.String sectionID)</CODE>
|
---|
516 |
|
---|
517 | <BR>
|
---|
518 | </TD>
|
---|
519 | </TR>
|
---|
520 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
521 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
522 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
523 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionEXMetadata(java.lang.String, java.lang.String)">getSectionEXMetadata</A></B>(java.lang.String docPID,
|
---|
524 | java.lang.String sectionID)</CODE>
|
---|
525 |
|
---|
526 | <BR>
|
---|
527 | </TD>
|
---|
528 | </TR>
|
---|
529 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
530 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
531 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
532 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionNames(java.lang.String)">getSectionNames</A></B>(java.lang.String docPID)</CODE>
|
---|
533 |
|
---|
534 | <BR>
|
---|
535 | Given the pid of a document fedora data object, this method will return
|
---|
536 | all itemIDs that are part of that data object and are Sections.</TD>
|
---|
537 | </TR>
|
---|
538 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
539 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
540 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
541 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionNumbers(java.lang.String)">getSectionNumbers</A></B>(java.lang.String docPID)</CODE>
|
---|
542 |
|
---|
543 | <BR>
|
---|
544 | Given the pid of a document fedora data object, this method will return all
|
---|
545 | itemIDs that are part of that data object and are Sections, but just the
|
---|
546 | Section numbers are returned.</TD>
|
---|
547 | </TR>
|
---|
548 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
549 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
550 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
551 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionTitle(java.lang.String, java.lang.String)">getSectionTitle</A></B>(java.lang.String docPID,
|
---|
552 | java.lang.String sectionID)</CODE>
|
---|
553 |
|
---|
554 | <BR>
|
---|
555 | </TD>
|
---|
556 | </TR>
|
---|
557 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
558 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
559 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
560 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionTitles(java.lang.String[], java.lang.String[])">getSectionTitles</A></B>(java.lang.String[] docPIDs,
|
---|
561 | java.lang.String[] sectionIDs)</CODE>
|
---|
562 |
|
---|
563 | <BR>
|
---|
564 | </TD>
|
---|
565 | </TR>
|
---|
566 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
567 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
568 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
569 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSubsection(java.lang.String, java.lang.String)">getSubsection</A></B>(java.lang.String docPID,
|
---|
570 | java.lang.String sectionID)</CODE>
|
---|
571 |
|
---|
572 | <BR>
|
---|
573 | </TD>
|
---|
574 | </TR>
|
---|
575 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
576 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
577 | <CODE> org.w3c.dom.Element</CODE></FONT></TD>
|
---|
578 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSubsectionXML(java.lang.String, java.lang.String)">getSubsectionXML</A></B>(java.lang.String docPID,
|
---|
579 | java.lang.String sectionID)</CODE>
|
---|
580 |
|
---|
581 | <BR>
|
---|
582 | </TD>
|
---|
583 | </TR>
|
---|
584 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
585 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
586 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
587 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getTitle(java.lang.String, java.lang.String)">getTitle</A></B>(java.lang.String docPID,
|
---|
588 | java.lang.String sectionID)</CODE>
|
---|
589 |
|
---|
590 | <BR>
|
---|
591 | </TD>
|
---|
592 | </TR>
|
---|
593 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
594 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
595 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
596 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getTitles(java.lang.String, java.lang.String[])">getTitles</A></B>(java.lang.String docPID,
|
---|
597 | java.lang.String[] sectionIDs)</CODE>
|
---|
598 |
|
---|
599 | <BR>
|
---|
600 | </TD>
|
---|
601 | </TR>
|
---|
602 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
603 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
604 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
605 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getTOC(java.lang.String)">getTOC</A></B>(java.lang.String pid)</CODE>
|
---|
606 |
|
---|
607 | <BR>
|
---|
608 | All "greenstone:*" objects in fedora (be they collections or documents)
|
---|
609 | have a TOC datastream.</TD>
|
---|
610 | </TR>
|
---|
611 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
612 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
613 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
614 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#searchDocumentTitles(java.lang.String, java.lang.String, boolean)">searchDocumentTitles</A></B>(java.lang.String collName,
|
---|
615 | java.lang.String titleContents,
|
---|
616 | boolean startsWith)</CODE>
|
---|
617 |
|
---|
618 | <BR>
|
---|
619 | Allows querying document titles of a greenstone collection stored in
|
---|
620 | the fedora repository for a term that may occur anywhere in their titles.</TD>
|
---|
621 | </TR>
|
---|
622 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
623 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
624 | <CODE> void</CODE></FONT></TD>
|
---|
625 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#setLanguage(java.lang.String)">setLanguage</A></B>(java.lang.String lang)</CODE>
|
---|
626 |
|
---|
627 | <BR>
|
---|
628 | Sets the the default language used to query for titles (and anything else
|
---|
629 | where there are multiple language options).</TD>
|
---|
630 | </TR>
|
---|
631 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
632 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
633 | <CODE> void</CODE></FONT></TD>
|
---|
634 | <TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#setMaxResults(int)">setMaxResults</A></B>(int maxresults)</CODE>
|
---|
635 |
|
---|
636 | <BR>
|
---|
637 | Set the default maximum number of search results returned for a search.</TD>
|
---|
638 | </TR>
|
---|
639 | </TABLE>
|
---|
640 |
|
---|
641 | <P>
|
---|
642 |
|
---|
643 | <!-- ============ FIELD DETAIL =========== -->
|
---|
644 |
|
---|
645 | <A NAME="field_detail"><!-- --></A>
|
---|
646 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
647 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
648 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
649 | <B>Field Detail</B></FONT></TH>
|
---|
650 | </TR>
|
---|
651 | </TABLE>
|
---|
652 |
|
---|
653 | <A NAME="FEDORA_GS3"><!-- --></A><H3>
|
---|
654 | FEDORA_GS3</H3>
|
---|
655 | <PRE>
|
---|
656 | static final java.lang.String <B>FEDORA_GS3</B></PRE>
|
---|
657 | <DL>
|
---|
658 | <DD>Instead of message router, we indicate that request messages
|
---|
659 | sent here come from FedoraGS3
|
---|
660 | <P>
|
---|
661 | <DL>
|
---|
662 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.FEDORA_GS3">Constant Field Values</A></DL>
|
---|
663 | </DL>
|
---|
664 | <HR>
|
---|
665 |
|
---|
666 | <A NAME="GREENSTONE"><!-- --></A><H3>
|
---|
667 | GREENSTONE</H3>
|
---|
668 | <PRE>
|
---|
669 | static final java.lang.String <B>GREENSTONE</B></PRE>
|
---|
670 | <DL>
|
---|
671 | <DD>"greenstone" is the FEDORA PID prefix we'll be working with
|
---|
672 | <P>
|
---|
673 | <DL>
|
---|
674 | <DT><B>See Also:</B><DD><a href="http://dltj.org/2006/12/fedora-batch-processing/">Fedora batch processing</a>,
|
---|
675 | <A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.GREENSTONE">Constant Field Values</A></DL>
|
---|
676 | </DL>
|
---|
677 | <HR>
|
---|
678 |
|
---|
679 | <A NAME="GREENSTONE_"><!-- --></A><H3>
|
---|
680 | GREENSTONE_</H3>
|
---|
681 | <PRE>
|
---|
682 | static final java.lang.String <B>GREENSTONE_</B></PRE>
|
---|
683 | <DL>
|
---|
684 | <DL>
|
---|
685 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.GREENSTONE_">Constant Field Values</A></DL>
|
---|
686 | </DL>
|
---|
687 | <HR>
|
---|
688 |
|
---|
689 | <A NAME="COLLECTION"><!-- --></A><H3>
|
---|
690 | COLLECTION</H3>
|
---|
691 | <PRE>
|
---|
692 | static final java.lang.String <B>COLLECTION</B></PRE>
|
---|
693 | <DL>
|
---|
694 | <DL>
|
---|
695 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.COLLECTION">Constant Field Values</A></DL>
|
---|
696 | </DL>
|
---|
697 | <HR>
|
---|
698 |
|
---|
699 | <A NAME="_COLLECTION"><!-- --></A><H3>
|
---|
700 | _COLLECTION</H3>
|
---|
701 | <PRE>
|
---|
702 | static final java.lang.String <B>_COLLECTION</B></PRE>
|
---|
703 | <DL>
|
---|
704 | <DL>
|
---|
705 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL._COLLECTION">Constant Field Values</A></DL>
|
---|
706 | </DL>
|
---|
707 | <HR>
|
---|
708 |
|
---|
709 | <A NAME="WILDCARD"><!-- --></A><H3>
|
---|
710 | WILDCARD</H3>
|
---|
711 | <PRE>
|
---|
712 | static final java.lang.String <B>WILDCARD</B></PRE>
|
---|
713 | <DL>
|
---|
714 | <DL>
|
---|
715 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.WILDCARD">Constant Field Values</A></DL>
|
---|
716 | </DL>
|
---|
717 | <HR>
|
---|
718 |
|
---|
719 | <A NAME="HYPHEN"><!-- --></A><H3>
|
---|
720 | HYPHEN</H3>
|
---|
721 | <PRE>
|
---|
722 | static final java.lang.String <B>HYPHEN</B></PRE>
|
---|
723 | <DL>
|
---|
724 | <DL>
|
---|
725 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.HYPHEN">Constant Field Values</A></DL>
|
---|
726 | </DL>
|
---|
727 | <HR>
|
---|
728 |
|
---|
729 | <A NAME="COLON"><!-- --></A><H3>
|
---|
730 | COLON</H3>
|
---|
731 | <PRE>
|
---|
732 | static final java.lang.String <B>COLON</B></PRE>
|
---|
733 | <DL>
|
---|
734 | <DL>
|
---|
735 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.COLON">Constant Field Values</A></DL>
|
---|
736 | </DL>
|
---|
737 | <HR>
|
---|
738 |
|
---|
739 | <A NAME="PERIOD"><!-- --></A><H3>
|
---|
740 | PERIOD</H3>
|
---|
741 | <PRE>
|
---|
742 | static final java.lang.String <B>PERIOD</B></PRE>
|
---|
743 | <DL>
|
---|
744 | <DL>
|
---|
745 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.PERIOD">Constant Field Values</A></DL>
|
---|
746 | </DL>
|
---|
747 | <HR>
|
---|
748 |
|
---|
749 | <A NAME="UTF8"><!-- --></A><H3>
|
---|
750 | UTF8</H3>
|
---|
751 | <PRE>
|
---|
752 | static final java.lang.String <B>UTF8</B></PRE>
|
---|
753 | <DL>
|
---|
754 | <DL>
|
---|
755 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.UTF8">Constant Field Values</A></DL>
|
---|
756 | </DL>
|
---|
757 | <HR>
|
---|
758 |
|
---|
759 | <A NAME="TITLE"><!-- --></A><H3>
|
---|
760 | TITLE</H3>
|
---|
761 | <PRE>
|
---|
762 | static final java.lang.String <B>TITLE</B></PRE>
|
---|
763 | <DL>
|
---|
764 | <DL>
|
---|
765 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.TITLE">Constant Field Values</A></DL>
|
---|
766 | </DL>
|
---|
767 | <HR>
|
---|
768 |
|
---|
769 | <A NAME="ID"><!-- --></A><H3>
|
---|
770 | ID</H3>
|
---|
771 | <PRE>
|
---|
772 | static final java.lang.String <B>ID</B></PRE>
|
---|
773 | <DL>
|
---|
774 | <DL>
|
---|
775 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.ID">Constant Field Values</A></DL>
|
---|
776 | </DL>
|
---|
777 | <HR>
|
---|
778 |
|
---|
779 | <A NAME="NAME"><!-- --></A><H3>
|
---|
780 | NAME</H3>
|
---|
781 | <PRE>
|
---|
782 | static final java.lang.String <B>NAME</B></PRE>
|
---|
783 | <DL>
|
---|
784 | <DL>
|
---|
785 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.NAME">Constant Field Values</A></DL>
|
---|
786 | </DL>
|
---|
787 | <HR>
|
---|
788 |
|
---|
789 | <A NAME="COLLECTIONNAME"><!-- --></A><H3>
|
---|
790 | COLLECTIONNAME</H3>
|
---|
791 | <PRE>
|
---|
792 | static final java.lang.String <B>COLLECTIONNAME</B></PRE>
|
---|
793 | <DL>
|
---|
794 | <DL>
|
---|
795 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.COLLECTIONNAME">Constant Field Values</A></DL>
|
---|
796 | </DL>
|
---|
797 | <HR>
|
---|
798 |
|
---|
799 | <A NAME="QUALIFIER"><!-- --></A><H3>
|
---|
800 | QUALIFIER</H3>
|
---|
801 | <PRE>
|
---|
802 | static final java.lang.String <B>QUALIFIER</B></PRE>
|
---|
803 | <DL>
|
---|
804 | <DL>
|
---|
805 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.QUALIFIER">Constant Field Values</A></DL>
|
---|
806 | </DL>
|
---|
807 | <HR>
|
---|
808 |
|
---|
809 | <A NAME="ENGLISH"><!-- --></A><H3>
|
---|
810 | ENGLISH</H3>
|
---|
811 | <PRE>
|
---|
812 | static final java.lang.String <B>ENGLISH</B></PRE>
|
---|
813 | <DL>
|
---|
814 | <DL>
|
---|
815 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.ENGLISH">Constant Field Values</A></DL>
|
---|
816 | </DL>
|
---|
817 | <HR>
|
---|
818 |
|
---|
819 | <A NAME="METADATA"><!-- --></A><H3>
|
---|
820 | METADATA</H3>
|
---|
821 | <PRE>
|
---|
822 | static final java.lang.String <B>METADATA</B></PRE>
|
---|
823 | <DL>
|
---|
824 | <DL>
|
---|
825 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.METADATA">Constant Field Values</A></DL>
|
---|
826 | </DL>
|
---|
827 | <HR>
|
---|
828 |
|
---|
829 | <A NAME="SECTION_ELEMENT"><!-- --></A><H3>
|
---|
830 | SECTION_ELEMENT</H3>
|
---|
831 | <PRE>
|
---|
832 | static final java.lang.String <B>SECTION_ELEMENT</B></PRE>
|
---|
833 | <DL>
|
---|
834 | <DL>
|
---|
835 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.SECTION_ELEMENT">Constant Field Values</A></DL>
|
---|
836 | </DL>
|
---|
837 | <HR>
|
---|
838 |
|
---|
839 | <A NAME="EX"><!-- --></A><H3>
|
---|
840 | EX</H3>
|
---|
841 | <PRE>
|
---|
842 | static final java.lang.String <B>EX</B></PRE>
|
---|
843 | <DL>
|
---|
844 | <DD>EX marks the XML metadata file that contains Greenstone extracted
|
---|
845 | metadata
|
---|
846 | <P>
|
---|
847 | <DL>
|
---|
848 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.EX">Constant Field Values</A></DL>
|
---|
849 | </DL>
|
---|
850 | <HR>
|
---|
851 |
|
---|
852 | <A NAME="DC"><!-- --></A><H3>
|
---|
853 | DC</H3>
|
---|
854 | <PRE>
|
---|
855 | static final java.lang.String <B>DC</B></PRE>
|
---|
856 | <DL>
|
---|
857 | <DD>Fedora's Dublin Core metadata
|
---|
858 | <P>
|
---|
859 | <DL>
|
---|
860 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.DC">Constant Field Values</A></DL>
|
---|
861 | </DL>
|
---|
862 | <HR>
|
---|
863 |
|
---|
864 | <A NAME="DLS"><!-- --></A><H3>
|
---|
865 | DLS</H3>
|
---|
866 | <PRE>
|
---|
867 | static final java.lang.String <B>DLS</B></PRE>
|
---|
868 | <DL>
|
---|
869 | <DD>DLS metadata of Greenstone documents - this metadata set is optionally
|
---|
870 | provided for top level documents. Not all Greenstone top-level documents
|
---|
871 | in the Fedora repository may have associated DLS metadata, however.
|
---|
872 | <P>
|
---|
873 | <DL>
|
---|
874 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.DLS">Constant Field Values</A></DL>
|
---|
875 | </DL>
|
---|
876 | <HR>
|
---|
877 |
|
---|
878 | <A NAME="TOC"><!-- --></A><H3>
|
---|
879 | TOC</H3>
|
---|
880 | <PRE>
|
---|
881 | static final java.lang.String <B>TOC</B></PRE>
|
---|
882 | <DL>
|
---|
883 | <DD>Table of contents for a Greenstone-Fedora document which outlines the
|
---|
884 | structure of the document.
|
---|
885 | <P>
|
---|
886 | <DL>
|
---|
887 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.TOC">Constant Field Values</A></DL>
|
---|
888 | </DL>
|
---|
889 | <HR>
|
---|
890 |
|
---|
891 | <A NAME="SECTION"><!-- --></A><H3>
|
---|
892 | SECTION</H3>
|
---|
893 | <PRE>
|
---|
894 | static final java.lang.String <B>SECTION</B></PRE>
|
---|
895 | <DL>
|
---|
896 | <DD>The SECTION prefix in the name of a section's datastream;
|
---|
897 | eg. SECTION1.2.2
|
---|
898 | <P>
|
---|
899 | <DL>
|
---|
900 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraGS3DL.SECTION">Constant Field Values</A></DL>
|
---|
901 | </DL>
|
---|
902 |
|
---|
903 | <!-- ============ METHOD DETAIL ========== -->
|
---|
904 |
|
---|
905 | <A NAME="method_detail"><!-- --></A>
|
---|
906 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
907 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
908 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
909 | <B>Method Detail</B></FONT></TH>
|
---|
910 | </TR>
|
---|
911 | </TABLE>
|
---|
912 |
|
---|
913 | <A NAME="getLanguage()"><!-- --></A><H3>
|
---|
914 | getLanguage</H3>
|
---|
915 | <PRE>
|
---|
916 | java.lang.String <B>getLanguage</B>()</PRE>
|
---|
917 | <DL>
|
---|
918 | <DD><DL>
|
---|
919 |
|
---|
920 | <DT><B>Returns:</B><DD>the default language used to query for titles (and anything else
|
---|
921 | where there are multiple language options). Upon initialisation, this
|
---|
922 | defaults to English.</DL>
|
---|
923 | </DD>
|
---|
924 | </DL>
|
---|
925 | <HR>
|
---|
926 |
|
---|
927 | <A NAME="setLanguage(java.lang.String)"><!-- --></A><H3>
|
---|
928 | setLanguage</H3>
|
---|
929 | <PRE>
|
---|
930 | void <B>setLanguage</B>(java.lang.String lang)</PRE>
|
---|
931 | <DL>
|
---|
932 | <DD>Sets the the default language used to query for titles (and anything else
|
---|
933 | where there are multiple language options). If the default language for any
|
---|
934 | query is not available, then English ("en") is used. If that's not available
|
---|
935 | then the first other available language is used.
|
---|
936 | <P>
|
---|
937 | <DD><DL>
|
---|
938 | <DT><B>Parameters:</B><DD><CODE>lang</CODE> - - the two-letter language code to set the default language to.</DL>
|
---|
939 | </DD>
|
---|
940 | </DL>
|
---|
941 | <HR>
|
---|
942 |
|
---|
943 | <A NAME="getMaxResults()"><!-- --></A><H3>
|
---|
944 | getMaxResults</H3>
|
---|
945 | <PRE>
|
---|
946 | int <B>getMaxResults</B>()</PRE>
|
---|
947 | <DL>
|
---|
948 | <DD>The default maximum number of search results returned for a search. Upon
|
---|
949 | initialisation, this defaults to Java's Integer.MAX_VALUE.
|
---|
950 | <P>
|
---|
951 | <DD><DL>
|
---|
952 | </DL>
|
---|
953 | </DD>
|
---|
954 | </DL>
|
---|
955 | <HR>
|
---|
956 |
|
---|
957 | <A NAME="setMaxResults(int)"><!-- --></A><H3>
|
---|
958 | setMaxResults</H3>
|
---|
959 | <PRE>
|
---|
960 | void <B>setMaxResults</B>(int maxresults)</PRE>
|
---|
961 | <DL>
|
---|
962 | <DD>Set the default maximum number of search results returned for a search.
|
---|
963 | <P>
|
---|
964 | <DD><DL>
|
---|
965 | <DT><B>Parameters:</B><DD><CODE>maxresults</CODE> - - the new default maximum number of search results to
|
---|
966 | be returned.</DL>
|
---|
967 | </DD>
|
---|
968 | </DL>
|
---|
969 | <HR>
|
---|
970 |
|
---|
971 | <A NAME="getBaseURL()"><!-- --></A><H3>
|
---|
972 | getBaseURL</H3>
|
---|
973 | <PRE>
|
---|
974 | java.lang.String <B>getBaseURL</B>()</PRE>
|
---|
975 | <DL>
|
---|
976 | <DD><DL>
|
---|
977 |
|
---|
978 | <DT><B>Returns:</B><DD>fedora's baseURL</DL>
|
---|
979 | </DD>
|
---|
980 | </DL>
|
---|
981 | <HR>
|
---|
982 |
|
---|
983 | <A NAME="getPortAddressURL()"><!-- --></A><H3>
|
---|
984 | getPortAddressURL</H3>
|
---|
985 | <PRE>
|
---|
986 | java.lang.String <B>getPortAddressURL</B>()</PRE>
|
---|
987 | <DL>
|
---|
988 | <DD><DL>
|
---|
989 |
|
---|
990 | <DT><B>Returns:</B><DD>the portAddressURL of the Fedora APIA web service
|
---|
991 | (should be the endpoint location in the APIA's WSDL file).
|
---|
992 | Else set this in the .properties file to something else.</DL>
|
---|
993 | </DD>
|
---|
994 | </DL>
|
---|
995 | <HR>
|
---|
996 |
|
---|
997 | <A NAME="getAssocFileBaseURL()"><!-- --></A><H3>
|
---|
998 | getAssocFileBaseURL</H3>
|
---|
999 | <PRE>
|
---|
1000 | java.lang.String <B>getAssocFileBaseURL</B>()</PRE>
|
---|
1001 | <DL>
|
---|
1002 | <DD><DL>
|
---|
1003 |
|
---|
1004 | <DT><B>Returns:</B><DD>the baseURL for gsdlAssocFiles</DL>
|
---|
1005 | </DD>
|
---|
1006 | </DL>
|
---|
1007 | <HR>
|
---|
1008 |
|
---|
1009 | <A NAME="getCollections()"><!-- --></A><H3>
|
---|
1010 | getCollections</H3>
|
---|
1011 | <PRE>
|
---|
1012 | java.lang.String[] <B>getCollections</B>()
|
---|
1013 | throws java.rmi.RemoteException</PRE>
|
---|
1014 | <DL>
|
---|
1015 | <DD>Gets all greenstone collections. Searches for greenstone:*-collection.
|
---|
1016 | <P>
|
---|
1017 | <DD><DL>
|
---|
1018 |
|
---|
1019 | <DT><B>Returns:</B><DD>an array of Strings containing the pids of all collections
|
---|
1020 | matching the format greenstone:*-collection.
|
---|
1021 | <DT><B>Throws:</B>
|
---|
1022 | <DD><CODE>java.rmi.RemoteException</CODE></DL>
|
---|
1023 | </DD>
|
---|
1024 | </DL>
|
---|
1025 | <HR>
|
---|
1026 |
|
---|
1027 | <A NAME="getCollectionNames(java.lang.String[])"><!-- --></A><H3>
|
---|
1028 | getCollectionNames</H3>
|
---|
1029 | <PRE>
|
---|
1030 | java.lang.String[] <B>getCollectionNames</B>(java.lang.String[] collPIDs)</PRE>
|
---|
1031 | <DL>
|
---|
1032 | <DD><DL>
|
---|
1033 | <DT><B>Parameters:</B><DD><CODE>collPIDs</CODE> - - an array of Strings denoting the pids for greenstone
|
---|
1034 | collections stored in the fedora repositoryl. These should be of the
|
---|
1035 | format "greenstone:<collectionName>-collection".
|
---|
1036 | <DT><B>Returns:</B><DD>the <name>s (in greenstone:<name>-collection) for the collections
|
---|
1037 | indicated by collPIDs.</DL>
|
---|
1038 | </DD>
|
---|
1039 | </DL>
|
---|
1040 | <HR>
|
---|
1041 |
|
---|
1042 | <A NAME="getCollectionPIDs(java.lang.String[])"><!-- --></A><H3>
|
---|
1043 | getCollectionPIDs</H3>
|
---|
1044 | <PRE>
|
---|
1045 | java.lang.String[] <B>getCollectionPIDs</B>(java.lang.String[] collNames)</PRE>
|
---|
1046 | <DL>
|
---|
1047 | <DD><DL>
|
---|
1048 | <DT><B>Parameters:</B><DD><CODE>collNames</CODE> - - a list of names of greenstone collections
|
---|
1049 | stored in the fedora repository.
|
---|
1050 | <DT><B>Returns:</B><DD>"greenstone:<name>-collection" for all <name>s in the
|
---|
1051 | parameter collNames.</DL>
|
---|
1052 | </DD>
|
---|
1053 | </DL>
|
---|
1054 | <HR>
|
---|
1055 |
|
---|
1056 | <A NAME="getCollectionPID(java.lang.String)"><!-- --></A><H3>
|
---|
1057 | getCollectionPID</H3>
|
---|
1058 | <PRE>
|
---|
1059 | java.lang.String <B>getCollectionPID</B>(java.lang.String collName)</PRE>
|
---|
1060 | <DL>
|
---|
1061 | <DD><DL>
|
---|
1062 | <DT><B>Parameters:</B><DD><CODE>collName</CODE> - - the name of a greenstone collection stored
|
---|
1063 | stored in the fedora repository.
|
---|
1064 | <DT><B>Returns:</B><DD>greenstone:<name>-collection for the <name> denoted by
|
---|
1065 | parameter collName.</DL>
|
---|
1066 | </DD>
|
---|
1067 | </DL>
|
---|
1068 | <HR>
|
---|
1069 |
|
---|
1070 | <A NAME="getCollectionTitle(java.lang.String)"><!-- --></A><H3>
|
---|
1071 | getCollectionTitle</H3>
|
---|
1072 | <PRE>
|
---|
1073 | java.lang.String <B>getCollectionTitle</B>(java.lang.String collPID)
|
---|
1074 | throws java.rmi.RemoteException,
|
---|
1075 | java.io.UnsupportedEncodingException,
|
---|
1076 | org.xml.sax.SAXException,
|
---|
1077 | java.io.IOException</PRE>
|
---|
1078 | <DL>
|
---|
1079 | <DD>Gets the title of the collection denoted by the given collection's pid by
|
---|
1080 | retrieving the title metadata for it from the collection's EX datastream.
|
---|
1081 | <P>
|
---|
1082 | <DD><DL>
|
---|
1083 | <DT><B>Parameters:</B><DD><CODE>collPID</CODE> - is the pid of a greenstone collection in the fedora
|
---|
1084 | repository.
|
---|
1085 | <DT><B>Returns:</B><DD>the title (in the default language, else English, else the
|
---|
1086 | first title found) for the particular collection denoted by its PID.
|
---|
1087 | <DT><B>Throws:</B>
|
---|
1088 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1089 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1090 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1091 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1092 | </DD>
|
---|
1093 | </DL>
|
---|
1094 | <HR>
|
---|
1095 |
|
---|
1096 | <A NAME="getCollectionTitles(java.lang.String[])"><!-- --></A><H3>
|
---|
1097 | getCollectionTitles</H3>
|
---|
1098 | <PRE>
|
---|
1099 | java.lang.String[] <B>getCollectionTitles</B>(java.lang.String[] collPIDs)
|
---|
1100 | throws java.rmi.RemoteException,
|
---|
1101 | java.io.UnsupportedEncodingException,
|
---|
1102 | org.xml.sax.SAXException,
|
---|
1103 | java.io.IOException</PRE>
|
---|
1104 | <DL>
|
---|
1105 | <DD><DL>
|
---|
1106 | <DT><B>Parameters:</B><DD><CODE>collPIDs</CODE> - - a list of pids identifying greenstone collections
|
---|
1107 | stored in the fedora repository.
|
---|
1108 | <DT><B>Returns:</B><DD>the collection titles for all the collections indicated by
|
---|
1109 | collPIDs.
|
---|
1110 | <DT><B>Throws:</B>
|
---|
1111 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1112 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1113 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1114 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1115 | </DD>
|
---|
1116 | </DL>
|
---|
1117 | <HR>
|
---|
1118 |
|
---|
1119 | <A NAME="getDocTitles(java.lang.String[])"><!-- --></A><H3>
|
---|
1120 | getDocTitles</H3>
|
---|
1121 | <PRE>
|
---|
1122 | java.lang.String[] <B>getDocTitles</B>(java.lang.String[] docPIDs)
|
---|
1123 | throws java.rmi.RemoteException,
|
---|
1124 | java.io.UnsupportedEncodingException,
|
---|
1125 | org.xml.sax.SAXException,
|
---|
1126 | java.io.IOException</PRE>
|
---|
1127 | <DL>
|
---|
1128 | <DD><DL>
|
---|
1129 | <DT><B>Parameters:</B><DD><CODE>docPIDs</CODE> - - a list of pids identifying documents stored in the
|
---|
1130 | fedora repository.
|
---|
1131 | <DT><B>Returns:</B><DD>the title metadata for the given doc objects of a collection.
|
---|
1132 | These titles are returned in the same order as the given docIDs.
|
---|
1133 | <DT><B>Throws:</B>
|
---|
1134 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1135 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1136 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1137 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1138 | </DD>
|
---|
1139 | </DL>
|
---|
1140 | <HR>
|
---|
1141 |
|
---|
1142 | <A NAME="getDocTitle(java.lang.String)"><!-- --></A><H3>
|
---|
1143 | getDocTitle</H3>
|
---|
1144 | <PRE>
|
---|
1145 | java.lang.String <B>getDocTitle</B>(java.lang.String docPID)
|
---|
1146 | throws java.rmi.RemoteException,
|
---|
1147 | java.io.UnsupportedEncodingException,
|
---|
1148 | org.xml.sax.SAXException,
|
---|
1149 | java.io.IOException</PRE>
|
---|
1150 | <DL>
|
---|
1151 | <DD>Gets the title metadata for a particular doc object in a collection
|
---|
1152 | denoted by docPID. The docPID already contains the collection name.
|
---|
1153 | <P>
|
---|
1154 | <DD><DL>
|
---|
1155 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is the pid of the document in the fedora repository
|
---|
1156 | (docPID is of the form greenstone:<colName>-<doc-identifier>
|
---|
1157 | <DT><B>Returns:</B><DD>the title for the fedora document item denoted by docPID
|
---|
1158 | <DT><B>Throws:</B>
|
---|
1159 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1160 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1161 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1162 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1163 | </DD>
|
---|
1164 | </DL>
|
---|
1165 | <HR>
|
---|
1166 |
|
---|
1167 | <A NAME="getSectionTitles(java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
1168 | getSectionTitles</H3>
|
---|
1169 | <PRE>
|
---|
1170 | java.lang.String[] <B>getSectionTitles</B>(java.lang.String[] docPIDs,
|
---|
1171 | java.lang.String[] sectionIDs)
|
---|
1172 | throws java.rmi.RemoteException,
|
---|
1173 | java.io.UnsupportedEncodingException,
|
---|
1174 | org.xml.sax.SAXException,
|
---|
1175 | java.io.IOException</PRE>
|
---|
1176 | <DL>
|
---|
1177 | <DD><DL>
|
---|
1178 | <DT><B>Parameters:</B><DD><CODE>docPIDs</CODE> - - a list of pids identifying documents stored in the
|
---|
1179 | fedora repository.<DD><CODE>sectionIDs</CODE> - - a list of sectionIDs identifying individual sections
|
---|
1180 | of documents stored in the fedora repository whose titles are requested.
|
---|
1181 | <DT><B>Returns:</B><DD>the title metadata for the given document sections.
|
---|
1182 | These titles are returned in the same order as the given docPIDs
|
---|
1183 | and associated sectionIDs.
|
---|
1184 | <DT><B>Throws:</B>
|
---|
1185 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1186 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1187 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1188 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1189 | </DD>
|
---|
1190 | </DL>
|
---|
1191 | <HR>
|
---|
1192 |
|
---|
1193 | <A NAME="getSectionTitle(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1194 | getSectionTitle</H3>
|
---|
1195 | <PRE>
|
---|
1196 | java.lang.String <B>getSectionTitle</B>(java.lang.String docPID,
|
---|
1197 | java.lang.String sectionID)
|
---|
1198 | throws java.io.UnsupportedEncodingException,
|
---|
1199 | java.rmi.RemoteException,
|
---|
1200 | org.xml.sax.SAXException,
|
---|
1201 | java.io.IOException</PRE>
|
---|
1202 | <DL>
|
---|
1203 | <DD><DL>
|
---|
1204 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - a pid identifying a document in the fedora repository.<DD><CODE>sectionID</CODE> - - the sectionID of the section of the
|
---|
1205 | document whose title is requested.
|
---|
1206 | <DT><B>Returns:</B><DD>the title metadata for the given document section.
|
---|
1207 | (The docPID already contain the collection name anyway.)
|
---|
1208 | <DT><B>Throws:</B>
|
---|
1209 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1210 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1211 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1212 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1213 | </DD>
|
---|
1214 | </DL>
|
---|
1215 | <HR>
|
---|
1216 |
|
---|
1217 | <A NAME="getCollectionDocs(java.lang.String)"><!-- --></A><H3>
|
---|
1218 | getCollectionDocs</H3>
|
---|
1219 | <PRE>
|
---|
1220 | java.lang.String[] <B>getCollectionDocs</B>(java.lang.String colPID)
|
---|
1221 | throws java.rmi.RemoteException</PRE>
|
---|
1222 | <DL>
|
---|
1223 | <DD><DL>
|
---|
1224 | <DT><B>Parameters:</B><DD><CODE>colPID</CODE> - is the pid of the greenstone collection stored in
|
---|
1225 | the fedora repository.
|
---|
1226 | <DT><B>Returns:</B><DD>a list of the fedora pids of all (document) objects in the
|
---|
1227 | given greenstone collection stored in fedora's repository. All
|
---|
1228 | pids that do not map to a collection are assumed to be documents.
|
---|
1229 | <DT><B>Throws:</B>
|
---|
1230 | <DD><CODE>java.rmi.RemoteException</CODE></DL>
|
---|
1231 | </DD>
|
---|
1232 | </DL>
|
---|
1233 | <HR>
|
---|
1234 |
|
---|
1235 | <A NAME="getSectionNames(java.lang.String)"><!-- --></A><H3>
|
---|
1236 | getSectionNames</H3>
|
---|
1237 | <PRE>
|
---|
1238 | java.lang.String[] <B>getSectionNames</B>(java.lang.String docPID)
|
---|
1239 | throws java.rmi.RemoteException</PRE>
|
---|
1240 | <DL>
|
---|
1241 | <DD>Given the pid of a document fedora data object, this method will return
|
---|
1242 | all itemIDs that are part of that data object and are Sections.
|
---|
1243 | <P>
|
---|
1244 | <DD><DL>
|
---|
1245 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.
|
---|
1246 | <DT><B>Returns:</B><DD>an array of itemIDs of the Sections of the document,
|
---|
1247 | indicated by docPID, in ascending order. These are of the form: "SECTION1.*"
|
---|
1248 | <DT><B>Throws:</B>
|
---|
1249 | <DD><CODE>java.rmi.RemoteException</CODE></DL>
|
---|
1250 | </DD>
|
---|
1251 | </DL>
|
---|
1252 | <HR>
|
---|
1253 |
|
---|
1254 | <A NAME="getSectionNumbers(java.lang.String)"><!-- --></A><H3>
|
---|
1255 | getSectionNumbers</H3>
|
---|
1256 | <PRE>
|
---|
1257 | java.lang.String[] <B>getSectionNumbers</B>(java.lang.String docPID)
|
---|
1258 | throws java.rmi.RemoteException</PRE>
|
---|
1259 | <DL>
|
---|
1260 | <DD>Given the pid of a document fedora data object, this method will return all
|
---|
1261 | itemIDs that are part of that data object and are Sections, but just the
|
---|
1262 | Section numbers are returned.
|
---|
1263 | <P>
|
---|
1264 | <DD><DL>
|
---|
1265 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.
|
---|
1266 | <DT><B>Returns:</B><DD>an array of itemIDs of the Section numbers of the document
|
---|
1267 | indicated by docPID, in ascending order. Return values are of form: "1.*".
|
---|
1268 | <DT><B>Throws:</B>
|
---|
1269 | <DD><CODE>java.rmi.RemoteException</CODE></DL>
|
---|
1270 | </DD>
|
---|
1271 | </DL>
|
---|
1272 | <HR>
|
---|
1273 |
|
---|
1274 | <A NAME="getTitles(java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
1275 | getTitles</H3>
|
---|
1276 | <PRE>
|
---|
1277 | java.lang.String[] <B>getTitles</B>(java.lang.String docPID,
|
---|
1278 | java.lang.String[] sectionIDs)
|
---|
1279 | throws java.rmi.RemoteException,
|
---|
1280 | java.io.UnsupportedEncodingException,
|
---|
1281 | org.xml.sax.SAXException,
|
---|
1282 | java.io.IOException</PRE>
|
---|
1283 | <DL>
|
---|
1284 | <DD><DL>
|
---|
1285 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionIDs</CODE> - is a list of identifiers identifying sections in the
|
---|
1286 | document denoted by docPID, whose titles need to be returned. Each
|
---|
1287 | sectionID may sectionID may be either a section name (e.g. SECTION1.5.1)
|
---|
1288 | or a section number (eg. 1.5.1).
|
---|
1289 | <DT><B>Returns:</B><DD>the titles for the document sections denoted by the parameters.
|
---|
1290 | <DT><B>Throws:</B>
|
---|
1291 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1292 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1293 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1294 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1295 | </DD>
|
---|
1296 | </DL>
|
---|
1297 | <HR>
|
---|
1298 |
|
---|
1299 | <A NAME="getTitle(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1300 | getTitle</H3>
|
---|
1301 | <PRE>
|
---|
1302 | java.lang.String <B>getTitle</B>(java.lang.String docPID,
|
---|
1303 | java.lang.String sectionID)
|
---|
1304 | throws java.rmi.RemoteException,
|
---|
1305 | java.io.UnsupportedEncodingException,
|
---|
1306 | org.xml.sax.SAXException,
|
---|
1307 | java.io.IOException</PRE>
|
---|
1308 | <DL>
|
---|
1309 | <DD><DL>
|
---|
1310 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifies the particular section in the
|
---|
1311 | document denoted by docPID, whose title needs to be returned. The
|
---|
1312 | sectionID may sectionID may be either a section name (e.g. SECTION1.5.1)
|
---|
1313 | or a section number (eg. 1.5.1).
|
---|
1314 | <DT><B>Returns:</B><DD>the title for the document section denoted by the parameters.
|
---|
1315 | <DT><B>Throws:</B>
|
---|
1316 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1317 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1318 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1319 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1320 | </DD>
|
---|
1321 | </DL>
|
---|
1322 | <HR>
|
---|
1323 |
|
---|
1324 | <A NAME="getDocName(java.lang.String)"><!-- --></A><H3>
|
---|
1325 | getDocName</H3>
|
---|
1326 | <PRE>
|
---|
1327 | java.lang.String <B>getDocName</B>(java.lang.String docPID)</PRE>
|
---|
1328 | <DL>
|
---|
1329 | <DD><DL>
|
---|
1330 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is the pid of a greenstone document in the fedora
|
---|
1331 | repository.
|
---|
1332 | <DT><B>Returns:</B><DD>the <docName> in the parameter docPID (which is of the form:
|
---|
1333 | greenstone:<colname>-<docName>)</DL>
|
---|
1334 | </DD>
|
---|
1335 | </DL>
|
---|
1336 | <HR>
|
---|
1337 |
|
---|
1338 | <A NAME="getCollectionName(java.lang.String)"><!-- --></A><H3>
|
---|
1339 | getCollectionName</H3>
|
---|
1340 | <PRE>
|
---|
1341 | java.lang.String <B>getCollectionName</B>(java.lang.String collPID)</PRE>
|
---|
1342 | <DL>
|
---|
1343 | <DD><DL>
|
---|
1344 | <DT><B>Parameters:</B><DD><CODE>collPID</CODE> - is the pid of a greenstone collection in the fedora
|
---|
1345 | repository.
|
---|
1346 | <DT><B>Returns:</B><DD>the <name> in the parameter collPID
|
---|
1347 | (greenstone:<name>-collection)</DL>
|
---|
1348 | </DD>
|
---|
1349 | </DL>
|
---|
1350 | <HR>
|
---|
1351 |
|
---|
1352 | <A NAME="getDC(java.lang.String)"><!-- --></A><H3>
|
---|
1353 | getDC</H3>
|
---|
1354 | <PRE>
|
---|
1355 | java.lang.String <B>getDC</B>(java.lang.String pid)
|
---|
1356 | throws java.rmi.RemoteException,
|
---|
1357 | java.io.UnsupportedEncodingException</PRE>
|
---|
1358 | <DL>
|
---|
1359 | <DD>All objects (incl "greenstone:*" objects) in fedora - be they collections,
|
---|
1360 | top-level documents or document sections) have an EX datastream. This method
|
---|
1361 | returns the content (XML) of the DC datastream as it is stored in fedora's
|
---|
1362 | repository.
|
---|
1363 | <P>
|
---|
1364 | <DD><DL>
|
---|
1365 | <DT><B>Parameters:</B><DD><CODE>pid</CODE> - - the fedora persistent identifier for an item in the fedora
|
---|
1366 | repository.
|
---|
1367 | <DT><B>Returns:</B><DD>a String version of the XML in the DC datastream for the fedora object
|
---|
1368 | denoted by pid.
|
---|
1369 | <DT><B>Throws:</B>
|
---|
1370 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1371 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
|
---|
1372 | </DD>
|
---|
1373 | </DL>
|
---|
1374 | <HR>
|
---|
1375 |
|
---|
1376 | <A NAME="getEX(java.lang.String)"><!-- --></A><H3>
|
---|
1377 | getEX</H3>
|
---|
1378 | <PRE>
|
---|
1379 | java.lang.String <B>getEX</B>(java.lang.String pid)
|
---|
1380 | throws java.rmi.RemoteException,
|
---|
1381 | java.io.UnsupportedEncodingException</PRE>
|
---|
1382 | <DL>
|
---|
1383 | <DD>All "greenstone:*" objects in fedora (be they collections, top-level
|
---|
1384 | documents or document sections) have an EX datastream. This method
|
---|
1385 | returns the content (XML) of the EX datastream as is.
|
---|
1386 | <P>
|
---|
1387 | <DD><DL>
|
---|
1388 | <DT><B>Parameters:</B><DD><CODE>pid</CODE> - - the fedora persistent identifier for an item in the fedora
|
---|
1389 | repository.
|
---|
1390 | <DT><B>Returns:</B><DD>a String version of the XML in the DC datastream for the fedora
|
---|
1391 | object denoted by pid.
|
---|
1392 | <DT><B>Throws:</B>
|
---|
1393 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1394 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
|
---|
1395 | </DD>
|
---|
1396 | </DL>
|
---|
1397 | <HR>
|
---|
1398 |
|
---|
1399 | <A NAME="getDLS(java.lang.String)"><!-- --></A><H3>
|
---|
1400 | getDLS</H3>
|
---|
1401 | <PRE>
|
---|
1402 | java.lang.String <B>getDLS</B>(java.lang.String pid)
|
---|
1403 | throws java.rmi.RemoteException,
|
---|
1404 | java.io.UnsupportedEncodingException</PRE>
|
---|
1405 | <DL>
|
---|
1406 | <DD>Some "greenstone:*" top-level documents in the fedora repository (but not
|
---|
1407 | greenstone collections or document sections) have a DLS metadata datastream.
|
---|
1408 | This method returns the content (XML) of the DLS datastream as is.
|
---|
1409 | <P>
|
---|
1410 | <DD><DL>
|
---|
1411 | <DT><B>Parameters:</B><DD><CODE>pid</CODE> - - the fedora persistent identifier for an item in the fedora
|
---|
1412 | repository.
|
---|
1413 | <DT><B>Returns:</B><DD>a String version of the XML in the DLS datastream for the fedora
|
---|
1414 | object denoted by pid.
|
---|
1415 | <DT><B>Throws:</B>
|
---|
1416 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1417 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
|
---|
1418 | </DD>
|
---|
1419 | </DL>
|
---|
1420 | <HR>
|
---|
1421 |
|
---|
1422 | <A NAME="getTOC(java.lang.String)"><!-- --></A><H3>
|
---|
1423 | getTOC</H3>
|
---|
1424 | <PRE>
|
---|
1425 | java.lang.String <B>getTOC</B>(java.lang.String pid)
|
---|
1426 | throws java.rmi.RemoteException,
|
---|
1427 | java.io.UnsupportedEncodingException</PRE>
|
---|
1428 | <DL>
|
---|
1429 | <DD>All "greenstone:*" objects in fedora (be they collections or documents)
|
---|
1430 | have a TOC datastream. This method returns the content (XML) of the TOC
|
---|
1431 | datastream as is. (Calls default fedora-system 3 dissemination <pid>/TOC.)
|
---|
1432 | <P>
|
---|
1433 | <DD><DL>
|
---|
1434 | <DT><B>Parameters:</B><DD><CODE>pid</CODE> - - the fedora persistent identifier for an item in the fedora
|
---|
1435 | repository.
|
---|
1436 | <DT><B>Returns:</B><DD>a String version of the XML in the DC datastream for the fedora
|
---|
1437 | object denoted by pid.
|
---|
1438 | <DT><B>Throws:</B>
|
---|
1439 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1440 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
|
---|
1441 | </DD>
|
---|
1442 | </DL>
|
---|
1443 | <HR>
|
---|
1444 |
|
---|
1445 | <A NAME="getSection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1446 | getSection</H3>
|
---|
1447 | <PRE>
|
---|
1448 | java.lang.String <B>getSection</B>(java.lang.String docPID,
|
---|
1449 | java.lang.String sectionID)
|
---|
1450 | throws java.rmi.RemoteException,
|
---|
1451 | java.io.UnsupportedEncodingException</PRE>
|
---|
1452 | <DL>
|
---|
1453 | <DD><DL>
|
---|
1454 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifies the particular section in the
|
---|
1455 | document denoted by docPID, may be a section name or number.
|
---|
1456 | <DT><B>Returns:</B><DD>the section's XML (as a String) as it is stored in fedora.
|
---|
1457 | Works out if sectionID is a sectionName or sectionNumber.
|
---|
1458 | <DT><B>Throws:</B>
|
---|
1459 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1460 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
|
---|
1461 | </DD>
|
---|
1462 | </DL>
|
---|
1463 | <HR>
|
---|
1464 |
|
---|
1465 | <A NAME="getSectionDCMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1466 | getSectionDCMetadata</H3>
|
---|
1467 | <PRE>
|
---|
1468 | java.lang.String <B>getSectionDCMetadata</B>(java.lang.String docPID,
|
---|
1469 | java.lang.String sectionID)
|
---|
1470 | throws java.rmi.RemoteException,
|
---|
1471 | java.io.UnsupportedEncodingException</PRE>
|
---|
1472 | <DL>
|
---|
1473 | <DD><DL>
|
---|
1474 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifies the particular section in the
|
---|
1475 | document denoted by docPID, may be a section name or number.
|
---|
1476 | <DT><B>Returns:</B><DD>the required section's DC metadata XML datastream.
|
---|
1477 | <DT><B>Throws:</B>
|
---|
1478 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1479 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
|
---|
1480 | </DD>
|
---|
1481 | </DL>
|
---|
1482 | <HR>
|
---|
1483 |
|
---|
1484 | <A NAME="getSectionEXMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1485 | getSectionEXMetadata</H3>
|
---|
1486 | <PRE>
|
---|
1487 | java.lang.String <B>getSectionEXMetadata</B>(java.lang.String docPID,
|
---|
1488 | java.lang.String sectionID)
|
---|
1489 | throws java.rmi.RemoteException,
|
---|
1490 | java.io.UnsupportedEncodingException</PRE>
|
---|
1491 | <DL>
|
---|
1492 | <DD><DL>
|
---|
1493 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifies the particular section in the
|
---|
1494 | document denoted by docPID, may be a section name or number.
|
---|
1495 | <DT><B>Returns:</B><DD>the required section's EX metadata XML datastream.
|
---|
1496 | <DT><B>Throws:</B>
|
---|
1497 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1498 | <DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
|
---|
1499 | </DD>
|
---|
1500 | </DL>
|
---|
1501 | <HR>
|
---|
1502 |
|
---|
1503 | <A NAME="getChildrenOfSectionXML(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1504 | getChildrenOfSectionXML</H3>
|
---|
1505 | <PRE>
|
---|
1506 | org.w3c.dom.Element <B>getChildrenOfSectionXML</B>(java.lang.String docPID,
|
---|
1507 | java.lang.String sectionID)
|
---|
1508 | throws java.rmi.RemoteException,
|
---|
1509 | java.io.UnsupportedEncodingException,
|
---|
1510 | org.xml.sax.SAXException,
|
---|
1511 | java.io.IOException</PRE>
|
---|
1512 | <DL>
|
---|
1513 | <DD><DL>
|
---|
1514 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifies the particular section in the
|
---|
1515 | document denoted by docPID, may be a section name or number.
|
---|
1516 | <DT><B>Returns:</B><DD>the XML content of the TOC of just that portion of the TOC which
|
---|
1517 | contains the section denoted by sectionID and its direct child subsections.
|
---|
1518 | The children are returned in the order they are encountered, which
|
---|
1519 | happens to be in the required order of ascending sectionID.
|
---|
1520 | <DT><B>Throws:</B>
|
---|
1521 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1522 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1523 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1524 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1525 | </DD>
|
---|
1526 | </DL>
|
---|
1527 | <HR>
|
---|
1528 |
|
---|
1529 | <A NAME="getChildrenOfSection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1530 | getChildrenOfSection</H3>
|
---|
1531 | <PRE>
|
---|
1532 | java.lang.String <B>getChildrenOfSection</B>(java.lang.String docPID,
|
---|
1533 | java.lang.String sectionID)
|
---|
1534 | throws java.rmi.RemoteException,
|
---|
1535 | java.io.UnsupportedEncodingException,
|
---|
1536 | org.xml.sax.SAXException,
|
---|
1537 | java.io.IOException,
|
---|
1538 | javax.xml.transform.TransformerException</PRE>
|
---|
1539 | <DL>
|
---|
1540 | <DD><DL>
|
---|
1541 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifies the particular section in the
|
---|
1542 | document denoted by docPID, may be a section name or number.
|
---|
1543 | <DT><B>Returns:</B><DD>a string representing the XML content of the TOC of just
|
---|
1544 | that portion of the TOC which contains the section denoted by sectionID
|
---|
1545 | and its direct child subsections.
|
---|
1546 | The children are returned in the order they are encountered, which
|
---|
1547 | happens to be in the required order of ascending sectionID.
|
---|
1548 | <DT><B>Throws:</B>
|
---|
1549 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1550 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1551 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1552 | <DD><CODE>java.io.IOException</CODE>
|
---|
1553 | <DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
|
---|
1554 | </DD>
|
---|
1555 | </DL>
|
---|
1556 | <HR>
|
---|
1557 |
|
---|
1558 | <A NAME="getSubsectionXML(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1559 | getSubsectionXML</H3>
|
---|
1560 | <PRE>
|
---|
1561 | org.w3c.dom.Element <B>getSubsectionXML</B>(java.lang.String docPID,
|
---|
1562 | java.lang.String sectionID)
|
---|
1563 | throws java.rmi.RemoteException,
|
---|
1564 | java.io.UnsupportedEncodingException,
|
---|
1565 | org.xml.sax.SAXException,
|
---|
1566 | java.io.IOException</PRE>
|
---|
1567 | <DL>
|
---|
1568 | <DD><DL>
|
---|
1569 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifies the particular section in the
|
---|
1570 | document denoted by docPID, may be a section name or number.
|
---|
1571 | <DT><B>Returns:</B><DD>the part of the TOC XML file (which outlines doc structure)
|
---|
1572 | relating to the given section. This includes the section denoted by
|
---|
1573 | sectionID as well as all descendent subsections thereof.
|
---|
1574 | <DT><B>Throws:</B>
|
---|
1575 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1576 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1577 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1578 | <DD><CODE>java.io.IOException</CODE></DL>
|
---|
1579 | </DD>
|
---|
1580 | </DL>
|
---|
1581 | <HR>
|
---|
1582 |
|
---|
1583 | <A NAME="getSubsection(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1584 | getSubsection</H3>
|
---|
1585 | <PRE>
|
---|
1586 | java.lang.String <B>getSubsection</B>(java.lang.String docPID,
|
---|
1587 | java.lang.String sectionID)
|
---|
1588 | throws java.rmi.RemoteException,
|
---|
1589 | java.io.UnsupportedEncodingException,
|
---|
1590 | org.xml.sax.SAXException,
|
---|
1591 | java.io.IOException,
|
---|
1592 | javax.xml.transform.TransformerException</PRE>
|
---|
1593 | <DL>
|
---|
1594 | <DD><DL>
|
---|
1595 | <DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifies the particular section in the
|
---|
1596 | document denoted by docPID, may be a section name or number.
|
---|
1597 | <DT><B>Returns:</B><DD>a String representation of the part of the TOC XML file
|
---|
1598 | (which outlines doc structure) relating to the given section. This
|
---|
1599 | includes the section denoted by sectionID as well as all descendent
|
---|
1600 | subsections thereof.
|
---|
1601 | <DT><B>Throws:</B>
|
---|
1602 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1603 | <DD><CODE>java.io.UnsupportedEncodingException</CODE>
|
---|
1604 | <DD><CODE>org.xml.sax.SAXException</CODE>
|
---|
1605 | <DD><CODE>java.io.IOException</CODE>
|
---|
1606 | <DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
|
---|
1607 | </DD>
|
---|
1608 | </DL>
|
---|
1609 | <HR>
|
---|
1610 |
|
---|
1611 | <A NAME="browseTitlesByLetter(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1612 | browseTitlesByLetter</H3>
|
---|
1613 | <PRE>
|
---|
1614 | java.lang.String[] <B>browseTitlesByLetter</B>(java.lang.String collName,
|
---|
1615 | java.lang.String letter)
|
---|
1616 | throws java.rmi.RemoteException,
|
---|
1617 | <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></PRE>
|
---|
1618 | <DL>
|
---|
1619 | <DD>Allows browsing document titles of a greenstone collection stored in
|
---|
1620 | the fedora repository by letter.
|
---|
1621 | <P>
|
---|
1622 | <DD><DL>
|
---|
1623 | <DT><B>Parameters:</B><DD><CODE>letter</CODE> - is the starting letter to browse by.
|
---|
1624 | <DT><B>Returns:</B><DD>the browse results for documents that start with any letter from
|
---|
1625 | A to Z. Returns the document pids whose titles start with the given letter.
|
---|
1626 | <DT><B>Throws:</B>
|
---|
1627 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1628 | <DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></CODE></DL>
|
---|
1629 | </DD>
|
---|
1630 | </DL>
|
---|
1631 | <HR>
|
---|
1632 |
|
---|
1633 | <A NAME="searchDocumentTitles(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
|
---|
1634 | searchDocumentTitles</H3>
|
---|
1635 | <PRE>
|
---|
1636 | java.lang.String[] <B>searchDocumentTitles</B>(java.lang.String collName,
|
---|
1637 | java.lang.String titleContents,
|
---|
1638 | boolean startsWith)
|
---|
1639 | throws java.rmi.RemoteException,
|
---|
1640 | <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></PRE>
|
---|
1641 | <DL>
|
---|
1642 | <DD>Allows querying document titles of a greenstone collection stored in
|
---|
1643 | the fedora repository for a term that may occur anywhere in their titles.
|
---|
1644 | <P>
|
---|
1645 | <DD><DL>
|
---|
1646 | <DT><B>Parameters:</B><DD><CODE>titleContents</CODE> - is the word or phrase to search the collection's
|
---|
1647 | document titles for.<DD><CODE>startsWith</CODE> - - if true, searches for titles that start with
|
---|
1648 | titleContents. Else it searches for titles that contain titleContents.
|
---|
1649 | <DT><B>Returns:</B><DD>the document pids whose titles contain the parameter term.
|
---|
1650 | <DT><B>Throws:</B>
|
---|
1651 | <DD><CODE>java.rmi.RemoteException</CODE>
|
---|
1652 | <DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></CODE></DL>
|
---|
1653 | </DD>
|
---|
1654 | </DL>
|
---|
1655 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
1656 | <HR>
|
---|
1657 |
|
---|
1658 |
|
---|
1659 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
1660 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
1661 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
1662 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
1663 | <TR>
|
---|
1664 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
1665 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
1666 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
1667 | <TR ALIGN="center" VALIGN="top">
|
---|
1668 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/greenstone/fedora/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
1669 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
1670 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
1671 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
1672 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
1673 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
1674 | </TR>
|
---|
1675 | </TABLE>
|
---|
1676 | </TD>
|
---|
1677 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
1678 | </EM>
|
---|
1679 | </TD>
|
---|
1680 | </TR>
|
---|
1681 |
|
---|
1682 | <TR>
|
---|
1683 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1684 | <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Connection.html" title="class in org.greenstone.fedora.services"><B>PREV CLASS</B></A>
|
---|
1685 | <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.html" title="class in org.greenstone.fedora.services"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
1686 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1687 | <A HREF="../../../../index.html?org/greenstone/fedora/services/FedoraGS3DL.html" target="_top"><B>FRAMES</B></A>
|
---|
1688 | <A HREF="FedoraGS3DL.html" target="_top"><B>NO FRAMES</B></A>
|
---|
1689 | <SCRIPT type="text/javascript">
|
---|
1690 | <!--
|
---|
1691 | if(window==top) {
|
---|
1692 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
1693 | }
|
---|
1694 | //-->
|
---|
1695 | </SCRIPT>
|
---|
1696 | <NOSCRIPT>
|
---|
1697 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
1698 | </NOSCRIPT>
|
---|
1699 |
|
---|
1700 |
|
---|
1701 | </FONT></TD>
|
---|
1702 | </TR>
|
---|
1703 | <TR>
|
---|
1704 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1705 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
1706 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1707 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
1708 | </TR>
|
---|
1709 | </TABLE>
|
---|
1710 | <A NAME="skip-navbar_bottom"></A>
|
---|
1711 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
1712 |
|
---|
1713 | <HR>
|
---|
1714 |
|
---|
1715 | </BODY>
|
---|
1716 | </HTML>
|
---|