Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: other-projects/trunk/gs3-webservices-democlient/docs/GS3Fedora/org/greenstone/fedora/services/FedoraConnection.html@ 15490

Last change on this file since 15490 was 15490, checked in by ak19, 16 years ago
Updated docs significantly
File size: 119.7 KB

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.5.0_10) on Thu May 15 13:35:51 NZST 2008 -->
6	<TITLE>
7	FedoraConnection
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.greenstone.fedora.services.FedoraConnection class">
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="FedoraConnection";
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/FedoraCommons.html" title="class in org.greenstone.fedora.services"><B>PREV CLASS</B></A>
54	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Connection.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/FedoraConnection.html" target="_top"><B>FRAMES</B></A>
57	<A HREF="FedoraConnection.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> \| <A HREF="#constructor_summary">CONSTR</A> \| <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> \| <A HREF="#constructor_detail">CONSTR</A> \| <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	Class FedoraConnection</H2>
89	<PRE>
90	java.lang.Object
91	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.fedora.services.FedoraConnection</B>
92	</PRE>
93	<DL>
94	<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></DD>
95	</DL>
96	<DL>
97	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Connection.html" title="class in org.greenstone.fedora.services">FedoraGS3Connection</A></DD>
98	</DL>
99	<HR>
100	<DL>
101	<DT><PRE>public class <B>FedoraConnection</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></DL>
102	</PRE>
103
104	<P>
105	Class that establishes a connection with Fedora's web services (via
106	Java stub classes for the same) and then provides methods to retrieve
107	Greenstone-specific data, such as the TOC, EX, DC,and Section
108	datastreams of the Greenstone documents stored in Fedora's repository.
109	These datastreams are returned as Strings without any changes being
110	made to them.
111	<P>
112
113	<P>
114	<DL>
115	<DT><B>Author:</B></DT>
116	<DD>ak19</DD>
117	</DL>
118	<HR>
119
120	<P>
121	<!-- =========== FIELD SUMMARY =========== -->
122
123	<A NAME="field_summary"><!-- --></A>
124	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
125	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
126	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
127	<B>Field Summary</B></FONT></TH>
128	</TR>
129	<TR BGCOLOR="white" CLASS="TableRowColor">
130	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131	<CODE>protected static fedora.server.access.FedoraAPIA</CODE></FONT></TD>
132	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#APIA">APIA</A></B></CODE>
133
134	<BR>
135	The object used to access the Fedora API-A web service methods</TD>
136	</TR>
137	<TR BGCOLOR="white" CLASS="TableRowColor">
138	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139	<CODE>protected  java.lang.String</CODE></FONT></TD>
140	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#baseURL">baseURL</A></B></CODE>
141
142	<BR>
143	The location of the fedora server, usually of the form
144	http://localhost:8080/fedora</TD>
145	</TR>
146	<TR BGCOLOR="white" CLASS="TableRowColor">
147	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148	<CODE>protected  javax.xml.parsers.DocumentBuilder</CODE></FONT></TD>
149	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#builder">builder</A></B></CODE>
150
151	<BR>
152	DocumentBuilder used to create and parse XML documents</TD>
153	</TR>
154	<TR BGCOLOR="white" CLASS="TableRowColor">
155	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156	<CODE>protected static java.lang.String</CODE></FONT></TD>
157	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#defaultPortAddressSuffix">defaultPortAddressSuffix</A></B></CODE>
158
159	<BR>
160	The part of the portAddress that comes after the baseURL.</TD>
161	</TR>
162	<TR BGCOLOR="white" CLASS="TableRowColor">
163	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164	<CODE>protected  java.lang.String</CODE></FONT></TD>
165	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#fedoraVersion">fedoraVersion</A></B></CODE>
166
167	<BR>
168	Version of the running fedora server</TD>
169	</TR>
170	<TR BGCOLOR="white" CLASS="TableRowColor">
171	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172	<CODE>protected static java.lang.String</CODE></FONT></TD>
173	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#GET">GET</A></B></CODE>
174
175	<BR>
176	</TD>
177	</TR>
178	<TR BGCOLOR="white" CLASS="TableRowColor">
179	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180	<CODE>protected static java.lang.String</CODE></FONT></TD>
181	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#INTERNAL_NODE">INTERNAL_NODE</A></B></CODE>
182
183	<BR>
184	</TD>
185	</TR>
186	<TR BGCOLOR="white" CLASS="TableRowColor">
187	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188	<CODE>protected  java.lang.String</CODE></FONT></TD>
189	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#lang">lang</A></B></CODE>
190
191	<BR>
192	The preferred language of the displat content</TD>
193	</TR>
194	<TR BGCOLOR="white" CLASS="TableRowColor">
195	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196	<CODE>protected  int</CODE></FONT></TD>
197	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#maxresults">maxresults</A></B></CODE>
198
199	<BR>
200	The maximum number of collections to retrieve</TD>
201	</TR>
202	<TR BGCOLOR="white" CLASS="TableRowColor">
203	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204	<CODE>protected  java.lang.String</CODE></FONT></TD>
205	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#portAddressSuffix">portAddressSuffix</A></B></CODE>
206
207	<BR>
208	The user-specified portAddressSuffix of the Fedora Access web services
209	(endpoint URL in the WSDL), usually of the form
210	http://localhost:8080/fedora/services/access
211	Users can tell FedoraGS3 to try accessing that first by setting
212	the "port.address.suffix" property in the properties file.</TD>
213	</TR>
214	<TR BGCOLOR="white" CLASS="TableRowColor">
215	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216	<CODE>protected static java.lang.String</CODE></FONT></TD>
217	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#SUPPORTED_VERSION">SUPPORTED_VERSION</A></B></CODE>
218
219	<BR>
220	The version of fedora that is supported by class FedoraConnection</TD>
221	</TR>
222	<TR BGCOLOR="white" CLASS="TableRowColor">
223	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224	<CODE>protected static java.lang.String</CODE></FONT></TD>
225	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#TYPE">TYPE</A></B></CODE>
226
227	<BR>
228	</TD>
229	</TR>
230	</TABLE>
231	<A NAME="fields_inherited_from_class_org.greenstone.fedora.services.FedoraGS3DL"><!-- --></A>
232	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
233	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
234	<TH ALIGN="left"><B>Fields inherited from interface org.greenstone.fedora.services.<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></B></TH>
235	</TR>
236	<TR BGCOLOR="white" CLASS="TableRowColor">
237	<TD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#_COLLECTION">_COLLECTION</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#COLLECTION">COLLECTION</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#COLLECTIONNAME">COLLECTIONNAME</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#COLON">COLON</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#DC">DC</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#DLS">DLS</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#ENGLISH">ENGLISH</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#EX">EX</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#FEDORA_GS3">FEDORA_GS3</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#GREENSTONE">GREENSTONE</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#GREENSTONE_">GREENSTONE_</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#HYPHEN">HYPHEN</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#ID">ID</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#METADATA">METADATA</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#NAME">NAME</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#PERIOD">PERIOD</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#QUALIFIER">QUALIFIER</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#SECTION">SECTION</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#SECTION_ELEMENT">SECTION_ELEMENT</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#TITLE">TITLE</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#TOC">TOC</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#UTF8">UTF8</A>, <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#WILDCARD">WILDCARD</A></CODE></TD>
238	</TR>
239	</TABLE>
240
241	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
242
243	<A NAME="constructor_summary"><!-- --></A>
244	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
245	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
246	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
247	<B>Constructor Summary</B></FONT></TH>
248	</TR>
249	<TR BGCOLOR="white" CLASS="TableRowColor">
250	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#FedoraConnection()">FedoraConnection</A></B>()</CODE>
251
252	<BR>
253	Default constructor which takes input from the user to get host, port,
254	fedora username and password.</TD>
255	</TR>
256	<TR BGCOLOR="white" CLASS="TableRowColor">
257	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#FedoraConnection(java.io.File)">FedoraConnection</A></B>(java.io.File propertyFile)</CODE>
258
259	<BR>
260	Single argument constructor that takes the name of the properties file
261	defining the values of the initialisation parameters required to
262	instantiate a FedoraConnection.</TD>
263	</TR>
264	<TR BGCOLOR="white" CLASS="TableRowColor">
265	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#FedoraConnection(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String)">FedoraConnection</A></B>(java.lang.String protocol,
266	java.lang.String host,
267	int port,
268	java.lang.String fedoraServerUsername,
269	java.lang.String fedoraServerPassword)</CODE>
270
271	<BR>
272	Code for this constructor is from DemoSOAPClient.java.</TD>
273	</TR>
274	</TABLE>
275
276	<!-- ========== METHOD SUMMARY =========== -->
277
278	<A NAME="method_summary"><!-- --></A>
279	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
280	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
281	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
282	<B>Method Summary</B></FONT></TH>
283	</TR>
284	<TR BGCOLOR="white" CLASS="TableRowColor">
285	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286	<CODE> java.lang.String[]</CODE></FONT></TD>
287	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#browseTitlesByLetter(java.lang.String, java.lang.String)">browseTitlesByLetter</A></B>(java.lang.String collName,
288	java.lang.String letter)</CODE>
289
290	<BR>
291	Implements browsing document titles of a greenstone collection stored in
292	the fedora repository by letter.</TD>
293	</TR>
294	<TR BGCOLOR="white" CLASS="TableRowColor">
295	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
296	<CODE>protected  java.lang.String</CODE></FONT></TD>
297	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#convertToMetaNumber(java.lang.String)">convertToMetaNumber</A></B>(java.lang.String number)</CODE>
298
299	<BR>
300	Given a number of the form x(.y.z), this method returns this number
301	as is, except when x = 1, in which case, it would return .y.z
302	That is, given number=3.2.1, this method would return 3.2.1
303	But, given number=1.2.3, this method would return .2.3.</TD>
304	</TR>
305	<TR BGCOLOR="white" CLASS="TableRowColor">
306	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
307	<CODE>protected  void</CODE></FONT></TD>
308	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#createAPIA(fedora.server.access.FedoraAPIAServiceLocator, java.lang.String, java.lang.String, boolean)">createAPIA</A></B>(fedora.server.access.FedoraAPIAServiceLocator serviceLocator,
309	java.lang.String portSuffix,
310	java.lang.String messageInsert,
311	boolean isUserSpecifiedPortAddressSuffix)</CODE>
312
313	<BR>
314	Tries to create the FedoraAPIA instance using the serviceLocator
315	and the given portSuffix.</TD>
316	</TR>
317	<TR BGCOLOR="white" CLASS="TableRowColor">
318	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319	<CODE>protected  fedora.server.types.gen.FieldSearchResult</CODE></FONT></TD>
320	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#findObjectsWithTitlesContaining(java.lang.String, java.lang.String)">findObjectsWithTitlesContaining</A></B>(java.lang.String collName,
321	java.lang.String titleWord)</CODE>
322
323	<BR>
324	</TD>
325	</TR>
326	<TR BGCOLOR="white" CLASS="TableRowColor">
327	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
328	<CODE> java.lang.String</CODE></FONT></TD>
329	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getAssocFileBaseURL()">getAssocFileBaseURL</A></B>()</CODE>
330
331	<BR>
332	</TD>
333	</TR>
334	<TR BGCOLOR="white" CLASS="TableRowColor">
335	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
336	<CODE> java.lang.String</CODE></FONT></TD>
337	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getBaseURL()">getBaseURL</A></B>()</CODE>
338
339	<BR>
340	</TD>
341	</TR>
342	<TR BGCOLOR="white" CLASS="TableRowColor">
343	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
344	<CODE> java.lang.String</CODE></FONT></TD>
345	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getChildrenOfSection(java.lang.String, java.lang.String)">getChildrenOfSection</A></B>(java.lang.String docPID,
346	java.lang.String sectionID)</CODE>
347
348	<BR>
349	</TD>
350	</TR>
351	<TR BGCOLOR="white" CLASS="TableRowColor">
352	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353	<CODE> org.w3c.dom.Element</CODE></FONT></TD>
354	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getChildrenOfSectionXML(java.lang.String, java.lang.String)">getChildrenOfSectionXML</A></B>(java.lang.String docPID,
355	java.lang.String sectionID)</CODE>
356
357	<BR>
358	</TD>
359	</TR>
360	<TR BGCOLOR="white" CLASS="TableRowColor">
361	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
362	<CODE> java.lang.String[]</CODE></FONT></TD>
363	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getCollectionDocs(java.lang.String)">getCollectionDocs</A></B>(java.lang.String colPID)</CODE>
364
365	<BR>
366	Searches the fedora repository for all greenstone:<colPID>* and
367	returns the PIDs of the data objects found, with the exception of
368	greenstone:<colPID>-collection, which is not a document but a
369	collection PID.</TD>
370	</TR>
371	<TR BGCOLOR="white" CLASS="TableRowColor">
372	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
373	<CODE> java.lang.String</CODE></FONT></TD>
374	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getCollectionName(java.lang.String)">getCollectionName</A></B>(java.lang.String collPID)</CODE>
375
376	<BR>
377	</TD>
378	</TR>
379	<TR BGCOLOR="white" CLASS="TableRowColor">
380	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
381	<CODE> java.lang.String[]</CODE></FONT></TD>
382	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getCollectionNames(java.lang.String[])">getCollectionNames</A></B>(java.lang.String[] collPIDs)</CODE>
383
384	<BR>
385	</TD>
386	</TR>
387	<TR BGCOLOR="white" CLASS="TableRowColor">
388	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
389	<CODE> java.lang.String</CODE></FONT></TD>
390	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getCollectionPID(java.lang.String)">getCollectionPID</A></B>(java.lang.String collName)</CODE>
391
392	<BR>
393	</TD>
394	</TR>
395	<TR BGCOLOR="white" CLASS="TableRowColor">
396	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
397	<CODE> java.lang.String[]</CODE></FONT></TD>
398	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getCollectionPIDs(java.lang.String[])">getCollectionPIDs</A></B>(java.lang.String[] collNames)</CODE>
399
400	<BR>
401	</TD>
402	</TR>
403	<TR BGCOLOR="white" CLASS="TableRowColor">
404	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
405	<CODE> java.lang.String[]</CODE></FONT></TD>
406	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getCollections()">getCollections</A></B>()</CODE>
407
408	<BR>
409	Gets all greenstone collections.</TD>
410	</TR>
411	<TR BGCOLOR="white" CLASS="TableRowColor">
412	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
413	<CODE> java.lang.String</CODE></FONT></TD>
414	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getCollectionTitle(java.lang.String)">getCollectionTitle</A></B>(java.lang.String collPID)</CODE>
415
416	<BR>
417	Gets the title of the collection denoted by the given collection's pid by
418	retrieving the title metadata for it from the collection's EX datastream.</TD>
419	</TR>
420	<TR BGCOLOR="white" CLASS="TableRowColor">
421	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
422	<CODE> java.lang.String[]</CODE></FONT></TD>
423	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getCollectionTitles(java.lang.String[])">getCollectionTitles</A></B>(java.lang.String[] collPIDs)</CODE>
424
425	<BR>
426	</TD>
427	</TR>
428	<TR BGCOLOR="white" CLASS="TableRowColor">
429	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
430	<CODE> java.lang.String</CODE></FONT></TD>
431	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getDC(java.lang.String)">getDC</A></B>(java.lang.String pid)</CODE>
432
433	<BR>
434	All objects (incl "greenstone:*" objects) in fedora - be they collections,
435	top-level documents or document sections - have a DC datastream.</TD>
436	</TR>
437	<TR BGCOLOR="white" CLASS="TableRowColor">
438	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
439	<CODE> java.lang.String</CODE></FONT></TD>
440	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getDLS(java.lang.String)">getDLS</A></B>(java.lang.String pid)</CODE>
441
442	<BR>
443	Some "greenstone:*" top-level documents in the fedora repository (but not
444	greenstone collections or document sections) have a DLS metadata datastream.</TD>
445	</TR>
446	<TR BGCOLOR="white" CLASS="TableRowColor">
447	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
448	<CODE> java.lang.String</CODE></FONT></TD>
449	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getDocName(java.lang.String)">getDocName</A></B>(java.lang.String docPID)</CODE>
450
451	<BR>
452	</TD>
453	</TR>
454	<TR BGCOLOR="white" CLASS="TableRowColor">
455	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
456	<CODE> java.lang.String</CODE></FONT></TD>
457	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getDocTitle(java.lang.String)">getDocTitle</A></B>(java.lang.String docPID)</CODE>
458
459	<BR>
460	Gets the title metadata for a particular doc object in a collection
461	denoted by docPID.</TD>
462	</TR>
463	<TR BGCOLOR="white" CLASS="TableRowColor">
464	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
465	<CODE> java.lang.String[]</CODE></FONT></TD>
466	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getDocTitles(java.lang.String[])">getDocTitles</A></B>(java.lang.String[] docPIDs)</CODE>
467
468	<BR>
469	</TD>
470	</TR>
471	<TR BGCOLOR="white" CLASS="TableRowColor">
472	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
473	<CODE> java.lang.String</CODE></FONT></TD>
474	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getEX(java.lang.String)">getEX</A></B>(java.lang.String pid)</CODE>
475
476	<BR>
477	All "greenstone:*" objects in fedora (be they collections be they
478	collections, top-level documents or document sections) have an EX
479	datastream.</TD>
480	</TR>
481	<TR BGCOLOR="white" CLASS="TableRowColor">
482	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
483	<CODE> java.lang.String</CODE></FONT></TD>
484	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getFedoraVersion()">getFedoraVersion</A></B>()</CODE>
485
486	<BR>
487	The version of the running Fedora server, which may or may not
488	match the supported version.</TD>
489	</TR>
490	<TR BGCOLOR="white" CLASS="TableRowColor">
491	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
492	<CODE>protected  java.lang.String</CODE></FONT></TD>
493	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getItem(java.lang.String, java.lang.String)">getItem</A></B>(java.lang.String docPID,
494	java.lang.String itemID)</CODE>
495
496	<BR>
497	Return a datastream of a document, given the document's id
498	and the item id of the datastream which is to be retrieved.</TD>
499	</TR>
500	<TR BGCOLOR="white" CLASS="TableRowColor">
501	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
502	<CODE> java.lang.String</CODE></FONT></TD>
503	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getLanguage()">getLanguage</A></B>()</CODE>
504
505	<BR>
506	</TD>
507	</TR>
508	<TR BGCOLOR="white" CLASS="TableRowColor">
509	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
510	<CODE> int</CODE></FONT></TD>
511	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getMaxResults()">getMaxResults</A></B>()</CODE>
512
513	<BR>
514	The default maximum number of search results returned for a search.</TD>
515	</TR>
516	<TR BGCOLOR="white" CLASS="TableRowColor">
517	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
518	<CODE> java.lang.String</CODE></FONT></TD>
519	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getPortAddressURL()">getPortAddressURL</A></B>()</CODE>
520
521	<BR>
522	</TD>
523	</TR>
524	<TR BGCOLOR="white" CLASS="TableRowColor">
525	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
526	<CODE> java.lang.String</CODE></FONT></TD>
527	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSection(java.lang.String, java.lang.String)">getSection</A></B>(java.lang.String docPID,
528	java.lang.String sectionID)</CODE>
529
530	<BR>
531	</TD>
532	</TR>
533	<TR BGCOLOR="white" CLASS="TableRowColor">
534	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
535	<CODE> java.lang.String</CODE></FONT></TD>
536	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSectionDCMetadata(java.lang.String, java.lang.String)">getSectionDCMetadata</A></B>(java.lang.String docPID,
537	java.lang.String sectionID)</CODE>
538
539	<BR>
540	</TD>
541	</TR>
542	<TR BGCOLOR="white" CLASS="TableRowColor">
543	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
544	<CODE> java.lang.String</CODE></FONT></TD>
545	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSectionEXMetadata(java.lang.String, java.lang.String)">getSectionEXMetadata</A></B>(java.lang.String docPID,
546	java.lang.String sectionID)</CODE>
547
548	<BR>
549	Returns the section EX metadata XML datastream for SectionID which may be
550	a section name or number.</TD>
551	</TR>
552	<TR BGCOLOR="white" CLASS="TableRowColor">
553	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
554	<CODE> java.lang.String[]</CODE></FONT></TD>
555	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSectionNames(java.lang.String)">getSectionNames</A></B>(java.lang.String docPID)</CODE>
556
557	<BR>
558	Given the pid of a document fedora data object, this method will return
559	all itemIDs that are part of that data object and are Sections.</TD>
560	</TR>
561	<TR BGCOLOR="white" CLASS="TableRowColor">
562	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
563	<CODE> java.lang.String[]</CODE></FONT></TD>
564	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSectionNumbers(java.lang.String)">getSectionNumbers</A></B>(java.lang.String docPID)</CODE>
565
566	<BR>
567	Given the pid of a document fedora data object, this method will return all
568	itemIDs that are part of that data object and are Sections, but just the
569	Section numbers are returned.</TD>
570	</TR>
571	<TR BGCOLOR="white" CLASS="TableRowColor">
572	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
573	<CODE> java.lang.String</CODE></FONT></TD>
574	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSectionTitle(java.lang.String, java.lang.String)">getSectionTitle</A></B>(java.lang.String docPID,
575	java.lang.String sectionID)</CODE>
576
577	<BR>
578	</TD>
579	</TR>
580	<TR BGCOLOR="white" CLASS="TableRowColor">
581	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
582	<CODE> java.lang.String[]</CODE></FONT></TD>
583	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSectionTitles(java.lang.String[], java.lang.String[])">getSectionTitles</A></B>(java.lang.String[] docPIDs,
584	java.lang.String[] sectionIDs)</CODE>
585
586	<BR>
587	</TD>
588	</TR>
589	<TR BGCOLOR="white" CLASS="TableRowColor">
590	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
591	<CODE> java.lang.String</CODE></FONT></TD>
592	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSubsection(java.lang.String, java.lang.String)">getSubsection</A></B>(java.lang.String docPID,
593	java.lang.String sectionID)</CODE>
594
595	<BR>
596	</TD>
597	</TR>
598	<TR BGCOLOR="white" CLASS="TableRowColor">
599	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
600	<CODE> org.w3c.dom.Element</CODE></FONT></TD>
601	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSubsectionXML(java.lang.String, java.lang.String)">getSubsectionXML</A></B>(java.lang.String docPID,
602	java.lang.String sectionID)</CODE>
603
604	<BR>
605	</TD>
606	</TR>
607	<TR BGCOLOR="white" CLASS="TableRowColor">
608	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
609	<CODE>protected  org.w3c.dom.Element</CODE></FONT></TD>
610	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSubstructure(org.w3c.dom.Element, boolean)">getSubstructure</A></B>(org.w3c.dom.Element e,
611	boolean descendents)</CODE>
612
613	<BR>
614	Convert the given Element to a String representing the same XML.</TD>
615	</TR>
616	<TR BGCOLOR="white" CLASS="TableRowColor">
617	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
618	<CODE>static java.lang.String</CODE></FONT></TD>
619	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getSupportedVersion()">getSupportedVersion</A></B>()</CODE>
620
621	<BR>
622	Static method that returns the version of Fedora supported by this
623	class FedoraConnection.</TD>
624	</TR>
625	<TR BGCOLOR="white" CLASS="TableRowColor">
626	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
627	<CODE>protected  java.lang.String</CODE></FONT></TD>
628	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getTitle(java.lang.String)">getTitle</A></B>(java.lang.String exStream)</CODE>
629
630	<BR>
631	Given a string representation of a document's or document section's
632	EX datastream -- which is a greenstone extracted metadata XML file --
633	of the form:
634	<ex>
635	<ex:metadata name="Title">sometitle</ex:metadata>
636	<ex:metadata name="...">....</ex:metadata>
637	...</TD>
638	</TR>
639	<TR BGCOLOR="white" CLASS="TableRowColor">
640	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
641	<CODE> java.lang.String</CODE></FONT></TD>
642	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getTitle(java.lang.String, java.lang.String)">getTitle</A></B>(java.lang.String docPID,
643	java.lang.String sectionID)</CODE>
644
645	<BR>
646	</TD>
647	</TR>
648	<TR BGCOLOR="white" CLASS="TableRowColor">
649	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
650	<CODE> java.lang.String[]</CODE></FONT></TD>
651	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getTitles(java.lang.String, java.lang.String[])">getTitles</A></B>(java.lang.String docPID,
652	java.lang.String[] sectionIDs)</CODE>
653
654	<BR>
655	</TD>
656	</TR>
657	<TR BGCOLOR="white" CLASS="TableRowColor">
658	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
659	<CODE> java.lang.String</CODE></FONT></TD>
660	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#getTOC(java.lang.String)">getTOC</A></B>(java.lang.String pid)</CODE>
661
662	<BR>
663	All "greenstone:*" objects in fedora (be they collections or documents)
664	have a TOC datastream.</TD>
665	</TR>
666	<TR BGCOLOR="white" CLASS="TableRowColor">
667	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
668	<CODE>protected  void</CODE></FONT></TD>
669	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#init(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">init</A></B>(java.lang.String protocol,
670	java.lang.String host,
671	java.lang.String port,
672	java.lang.String fedoraServerUsername,
673	java.lang.String fedoraServerPassword)</CODE>
674
675	<BR>
676	Init method that is called by the constructor to set some
677	important member variables including instantiating the APIA object
678	used to invoke the Fedora APIA web service operations.</TD>
679	</TR>
680	<TR BGCOLOR="white" CLASS="TableRowColor">
681	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
682	<CODE>static void</CODE></FONT></TD>
683	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
684
685	<BR>
686	</TD>
687	</TR>
688	<TR BGCOLOR="white" CLASS="TableRowColor">
689	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
690	<CODE>protected  java.lang.String</CODE></FONT></TD>
691	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#removePrefix(java.lang.String, java.lang.String)">removePrefix</A></B>(java.lang.String str,
692	java.lang.String prefix)</CODE>
693
694	<BR>
695	Given something like str="SECTION1.2.1" and prefix="SECTION" this method
696	returns "1.2.1".</TD>
697	</TR>
698	<TR BGCOLOR="white" CLASS="TableRowColor">
699	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
700	<CODE> java.lang.String[]</CODE></FONT></TD>
701	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#searchDocumentTitles(java.lang.String, java.lang.String, boolean)">searchDocumentTitles</A></B>(java.lang.String collName,
702	java.lang.String titleContents,
703	boolean startsWith)</CODE>
704
705	<BR>
706	Implements querying document DC titles of a greenstone collection stored in
707	the fedora repository for a term that may occur anywhere in their titles.</TD>
708	</TR>
709	<TR BGCOLOR="white" CLASS="TableRowColor">
710	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
711	<CODE>protected  void</CODE></FONT></TD>
712	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#setInitialisationProperties(java.util.Properties)">setInitialisationProperties</A></B>(java.util.Properties properties)</CODE>
713
714	<BR>
715	Method that loops to display the dialog that retrieves the
716	fedora server initialisation properties from the user.</TD>
717	</TR>
718	<TR BGCOLOR="white" CLASS="TableRowColor">
719	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
720	<CODE> void</CODE></FONT></TD>
721	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#setLanguage(java.lang.String)">setLanguage</A></B>(java.lang.String lang)</CODE>
722
723	<BR>
724	Sets the the default language used to query for titles (and anything else
725	where there are multiple language options).</TD>
726	</TR>
727	<TR BGCOLOR="white" CLASS="TableRowColor">
728	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
729	<CODE> void</CODE></FONT></TD>
730	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#setMaxResults(int)">setMaxResults</A></B>(int maxresults)</CODE>
731
732	<BR>
733	Set the default maximum number of search results returned for a search.</TD>
734	</TR>
735	<TR BGCOLOR="white" CLASS="TableRowColor">
736	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
737	<CODE>protected static java.util.Properties</CODE></FONT></TD>
738	<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html#showAuthenticationPopup(java.util.Properties)">showAuthenticationPopup</A></B>(java.util.Properties properties)</CODE>
739
740	<BR>
741	Static method that displays a popup to allow the user to provide Fedora
742	authentication (username, pwd) and connection (protocol+host, port) details.</TD>
743	</TR>
744	</TABLE>
745	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
746	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
747	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
748	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
749	</TR>
750	<TR BGCOLOR="white" CLASS="TableRowColor">
751	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
752	</TR>
753	</TABLE>
754
755	<P>
756
757	<!-- ============ FIELD DETAIL =========== -->
758
759	<A NAME="field_detail"><!-- --></A>
760	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
761	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
762	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
763	<B>Field Detail</B></FONT></TH>
764	</TR>
765	</TABLE>
766
767	<A NAME="SUPPORTED_VERSION"><!-- --></A><H3>
768	SUPPORTED_VERSION</H3>
769	<PRE>
770	protected static final java.lang.String <B>SUPPORTED_VERSION</B></PRE>
771	<DL>
772	<DD>The version of fedora that is supported by class FedoraConnection
773	<P>
774	<DL>
775	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraConnection.SUPPORTED_VERSION">Constant Field Values</A></DL>
776	</DL>
777	<HR>
778
779	<A NAME="TYPE"><!-- --></A><H3>
780	TYPE</H3>
781	<PRE>
782	protected static final java.lang.String <B>TYPE</B></PRE>
783	<DL>
784	<DL>
785	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraConnection.TYPE">Constant Field Values</A></DL>
786	</DL>
787	<HR>
788
789	<A NAME="INTERNAL_NODE"><!-- --></A><H3>
790	INTERNAL_NODE</H3>
791	<PRE>
792	protected static final java.lang.String <B>INTERNAL_NODE</B></PRE>
793	<DL>
794	<DL>
795	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraConnection.INTERNAL_NODE">Constant Field Values</A></DL>
796	</DL>
797	<HR>
798
799	<A NAME="GET"><!-- --></A><H3>
800	GET</H3>
801	<PRE>
802	protected static final java.lang.String <B>GET</B></PRE>
803	<DL>
804	<DL>
805	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraConnection.GET">Constant Field Values</A></DL>
806	</DL>
807	<HR>
808
809	<A NAME="APIA"><!-- --></A><H3>
810	APIA</H3>
811	<PRE>
812	protected static fedora.server.access.FedoraAPIA <B>APIA</B></PRE>
813	<DL>
814	<DD>The object used to access the Fedora API-A web service methods
815	<P>
816	<DL>
817	</DL>
818	</DL>
819	<HR>
820
821	<A NAME="fedoraVersion"><!-- --></A><H3>
822	fedoraVersion</H3>
823	<PRE>
824	protected java.lang.String <B>fedoraVersion</B></PRE>
825	<DL>
826	<DD>Version of the running fedora server
827	<P>
828	<DL>
829	</DL>
830	</DL>
831	<HR>
832
833	<A NAME="baseURL"><!-- --></A><H3>
834	baseURL</H3>
835	<PRE>
836	protected java.lang.String <B>baseURL</B></PRE>
837	<DL>
838	<DD>The location of the fedora server, usually of the form
839	http://localhost:8080/fedora
840	<P>
841	<DL>
842	</DL>
843	</DL>
844	<HR>
845
846	<A NAME="portAddressSuffix"><!-- --></A><H3>
847	portAddressSuffix</H3>
848	<PRE>
849	protected java.lang.String <B>portAddressSuffix</B></PRE>
850	<DL>
851	<DD>The user-specified portAddressSuffix of the Fedora Access web services
852	(endpoint URL in the WSDL), usually of the form
853	http://localhost:8080/fedora/services/access
854	Users can tell FedoraGS3 to try accessing that first by setting
855	the "port.address.suffix" property in the properties file.
856	FedoraGS3 itself will not write the portAddressSuffix currently used in
857	the file for next time, but leave whatever value was entered in the
858	properties file. The portAddress--not just suffix--currently in use (once
859	the FedoraAPIA handle has been instantiated) can be obtained through
860	getPortAddressURL() method.
861	<P>
862	<DL>
863	</DL>
864	</DL>
865	<HR>
866
867	<A NAME="defaultPortAddressSuffix"><!-- --></A><H3>
868	defaultPortAddressSuffix</H3>
869	<PRE>
870	protected static final java.lang.String <B>defaultPortAddressSuffix</B></PRE>
871	<DL>
872	<DD>The part of the portAddress that comes after the baseURL. It is usually:
873	"/services/access"
874	<P>
875	<DL>
876	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.services.FedoraConnection.defaultPortAddressSuffix">Constant Field Values</A></DL>
877	</DL>
878	<HR>
879
880	<A NAME="lang"><!-- --></A><H3>
881	lang</H3>
882	<PRE>
883	protected java.lang.String <B>lang</B></PRE>
884	<DL>
885	<DD>The preferred language of the displat content
886	<P>
887	<DL>
888	</DL>
889	</DL>
890	<HR>
891
892	<A NAME="maxresults"><!-- --></A><H3>
893	maxresults</H3>
894	<PRE>
895	protected int <B>maxresults</B></PRE>
896	<DL>
897	<DD>The maximum number of collections to retrieve
898	<P>
899	<DL>
900	</DL>
901	</DL>
902	<HR>
903
904	<A NAME="builder"><!-- --></A><H3>
905	builder</H3>
906	<PRE>
907	protected javax.xml.parsers.DocumentBuilder <B>builder</B></PRE>
908	<DL>
909	<DD>DocumentBuilder used to create and parse XML documents
910	<P>
911	<DL>
912	</DL>
913	</DL>
914
915	<!-- ========= CONSTRUCTOR DETAIL ======== -->
916
917	<A NAME="constructor_detail"><!-- --></A>
918	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
919	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
920	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
921	<B>Constructor Detail</B></FONT></TH>
922	</TR>
923	</TABLE>
924
925	<A NAME="FedoraConnection(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String)"><!-- --></A><H3>
926	FedoraConnection</H3>
927	<PRE>
928	public <B>FedoraConnection</B>(java.lang.String protocol,
929	java.lang.String host,
930	int port,
931	java.lang.String fedoraServerUsername,
932	java.lang.String fedoraServerPassword)
933	throws javax.xml.parsers.ParserConfigurationException,
934	java.net.MalformedURLException,
935	javax.net.ssl.SSLHandshakeException,
936	java.rmi.RemoteException,
937	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.AuthenticationFailedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.AuthenticationFailedException</A>,
938	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.NotAFedoraServerException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.NotAFedoraServerException</A>,
939	java.net.ConnectException,
940	java.lang.Exception</PRE>
941	<DL>
942	<DD>Code for this constructor is from DemoSOAPClient.java.
943	Instantiates the APIA handle using the protocol, host, port, fedora
944	server repository username and password.
945	<P>
946	<DL>
947	<DT><B>Parameters:</B><DD><CODE>host</CODE> - - the fedora server host (may be prefixed with http:// or
948	https:// if parameter protocol is empty). If there's no protocol, and
949	no protocol prefixed to the host, then the protocol defaults to http.<DD><CODE>protocol</CODE> - - either http or https (or empty "")<DD><CODE>port</CODE> - - the port on which fedora is running.<DD><CODE>fedoraServerUsername</CODE> - - the administrator username required to
950	access the fedora server's repository. ("fedoraAdmin" unless changed).<DD><CODE>fedoraServerPassword</CODE> - - the fedora server repository's
951	administrator password. If none was set on fedora installation, this
952	can be empty ("").
953	<DT><B>Throws:</B>
954	<DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
955	<DD><CODE>java.net.MalformedURLException</CODE>
956	<DD><CODE>javax.net.ssl.SSLHandshakeException</CODE>
957	<DD><CODE>java.rmi.RemoteException</CODE>
958	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.AuthenticationFailedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.AuthenticationFailedException</A></CODE>
959	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.NotAFedoraServerException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.NotAFedoraServerException</A></CODE>
960	<DD><CODE>java.net.ConnectException</CODE>
961	<DD><CODE>java.lang.Exception</CODE></DL>
962	</DL>
963	<HR>
964
965	<A NAME="FedoraConnection()"><!-- --></A><H3>
966	FedoraConnection</H3>
967	<PRE>
968	public <B>FedoraConnection</B>()
969	throws javax.xml.parsers.ParserConfigurationException,
970	java.net.MalformedURLException,
971	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A>,
972	java.net.ConnectException,
973	java.rmi.RemoteException,
974	javax.net.ssl.SSLHandshakeException,
975	java.lang.Exception</PRE>
976	<DL>
977	<DD>Default constructor which takes input from the user to get host, port,
978	fedora username and password.
979	It keeps looping to display authentication popup, until valid values are
980	entered:
981	(a) if password is wrong, a RemoteException is thrown and popup reappears;
982	This popup keeps appearing until the password and username are correct (as
983	long as there's indeed a fedora server listening at the given host and port).
984	(b) SSLHandshakeException occurs: this happens EITHER when the user prefixed
985	the 'https' protocol to the host string when it should have been 'http';
986	OR the ssl connection failed for some other reason.
987	Allowing for the 1st case, the authentication popup is displayed just once
988	more. On the second (consec) attempt, the SSLHandshakeException is rethrown.
989	NOTE: if a fedora server at the protocol (https or http) isn't accessible,
990	it takes a long time for the SSLHandshakeException to be thrown.
991	(c) if the connection is refused, then a ConnectException is thrown.
992	In that case, it's
993	EITHER because the host and port values that were entered are wrong (and
994	the authentication popup dialog is redisplayed just once more allowing
995	the user to correct host/port values)
996	OR the entered host and part were right but the fedora server at this
997	host and port is not running.
998	On the second consecutive attempt where a ConnectionException is thrown,
999	it's no longer processed but rethrown, as there's no use in redisplaying
1000	the authentication popup when the problem is not an authentication issue.
1001	(d) Another IOException (other than the SSLHandshakeException of (b))
1002	occurs when there is indeed a server listening at the host and port
1003	entered, but it's not a Fedora server, because it is unable to process
1004	Fedora requests. If the expected message is found in the exception, than
1005	the authentication popup is displayed. However, other causes for an
1006	IOException are not handled. In such cases, the IOException is rethrown.
1007	(Note that IOException is not in the throws clause - other causes for
1008	it being unknown, it can be be considered as the more generic Exception.
1009	<P>
1010	<DL>
1011
1012	<DT><B>Throws:</B>
1013	<DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
1014	<DD><CODE>java.net.MalformedURLException</CODE>
1015	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A></CODE>
1016	<DD><CODE>java.net.ConnectException</CODE>
1017	<DD><CODE>java.rmi.RemoteException</CODE>
1018	<DD><CODE>javax.net.ssl.SSLHandshakeException</CODE>
1019	<DD><CODE>java.lang.Exception</CODE></DL>
1020	</DL>
1021	<HR>
1022
1023	<A NAME="FedoraConnection(java.io.File)"><!-- --></A><H3>
1024	FedoraConnection</H3>
1025	<PRE>
1026	public <B>FedoraConnection</B>(java.io.File propertyFile)
1027	throws javax.xml.parsers.ParserConfigurationException,
1028	java.net.MalformedURLException,
1029	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A>,
1030	java.net.ConnectException,
1031	java.rmi.RemoteException,
1032	javax.net.ssl.SSLHandshakeException,
1033	java.lang.Exception</PRE>
1034	<DL>
1035	<DD>Single argument constructor that takes the name of the properties file
1036	defining the values of the initialisation parameters required to
1037	instantiate a FedoraConnection. These are fedora server username, password,
1038	host and port. If these values are not present in the file, they are set
1039	to "" before showing the initialisation input dialog.
1040	<P>
1041	<DL>
1042	<DT><B>Parameters:</B><DD><CODE>propertyFile</CODE> - is the name of the properties file specifying the
1043	values for Fedora server username, password, host and port.
1044	<DT><B>Throws:</B>
1045	<DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
1046	<DD><CODE>java.net.MalformedURLException</CODE>
1047	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A></CODE>
1048	<DD><CODE>java.net.ConnectException</CODE>
1049	<DD><CODE>java.rmi.RemoteException</CODE>
1050	<DD><CODE>javax.net.ssl.SSLHandshakeException</CODE>
1051	<DD><CODE>java.lang.Exception</CODE></DL>
1052	</DL>
1053
1054	<!-- ============ METHOD DETAIL ========== -->
1055
1056	<A NAME="method_detail"><!-- --></A>
1057	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
1058	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1059	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
1060	<B>Method Detail</B></FONT></TH>
1061	</TR>
1062	</TABLE>
1063
1064	<A NAME="getSupportedVersion()"><!-- --></A><H3>
1065	getSupportedVersion</H3>
1066	<PRE>
1067	public static java.lang.String <B>getSupportedVersion</B>()</PRE>
1068	<DL>
1069	<DD>Static method that returns the version of Fedora supported by this
1070	class FedoraConnection.
1071	<P>
1072	<DD><DL>
1073	</DL>
1074	</DD>
1075	<DD><DL>
1076	</DL>
1077	</DD>
1078	</DL>
1079	<HR>
1080
1081	<A NAME="getFedoraVersion()"><!-- --></A><H3>
1082	getFedoraVersion</H3>
1083	<PRE>
1084	public java.lang.String <B>getFedoraVersion</B>()</PRE>
1085	<DL>
1086	<DD>The version of the running Fedora server, which may or may not
1087	match the supported version.
1088	<P>
1089	<DD><DL>
1090	</DL>
1091	</DD>
1092	<DD><DL>
1093	</DL>
1094	</DD>
1095	</DL>
1096	<HR>
1097
1098	<A NAME="getLanguage()"><!-- --></A><H3>
1099	getLanguage</H3>
1100	<PRE>
1101	public java.lang.String <B>getLanguage</B>()</PRE>
1102	<DL>
1103	<DD><DL>
1104	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getLanguage()">getLanguage</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1105	</DD>
1106	<DD><DL>
1107
1108	<DT><B>Returns:</B><DD>the default language used to query for titles (and anything else
1109	where there are multiple language options). Upon initialisation, this
1110	defaults to English.</DL>
1111	</DD>
1112	</DL>
1113	<HR>
1114
1115	<A NAME="setLanguage(java.lang.String)"><!-- --></A><H3>
1116	setLanguage</H3>
1117	<PRE>
1118	public void <B>setLanguage</B>(java.lang.String lang)</PRE>
1119	<DL>
1120	<DD>Sets the the default language used to query for titles (and anything else
1121	where there are multiple language options). If the default language for any
1122	query is not available, then English ("en") is used. If that's not available
1123	then the first other available language is used.
1124	<P>
1125	<DD><DL>
1126	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#setLanguage(java.lang.String)">setLanguage</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1127	</DD>
1128	<DD><DL>
1129	<DT><B>Parameters:</B><DD><CODE>lang</CODE> - - the two-letter language code to set the default language to.</DL>
1130	</DD>
1131	</DL>
1132	<HR>
1133
1134	<A NAME="getMaxResults()"><!-- --></A><H3>
1135	getMaxResults</H3>
1136	<PRE>
1137	public int <B>getMaxResults</B>()</PRE>
1138	<DL>
1139	<DD>The default maximum number of search results returned for a search. Upon
1140	initialisation, this defaults to Java's Integer.MAX_VALUE.
1141	<P>
1142	<DD><DL>
1143	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getMaxResults()">getMaxResults</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1144	</DD>
1145	<DD><DL>
1146	</DL>
1147	</DD>
1148	</DL>
1149	<HR>
1150
1151	<A NAME="setMaxResults(int)"><!-- --></A><H3>
1152	setMaxResults</H3>
1153	<PRE>
1154	public void <B>setMaxResults</B>(int maxresults)</PRE>
1155	<DL>
1156	<DD>Set the default maximum number of search results returned for a search.
1157	<P>
1158	<DD><DL>
1159	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#setMaxResults(int)">setMaxResults</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1160	</DD>
1161	<DD><DL>
1162	<DT><B>Parameters:</B><DD><CODE>maxresults</CODE> - - the new default maximum number of search results to
1163	be returned.</DL>
1164	</DD>
1165	</DL>
1166	<HR>
1167
1168	<A NAME="setInitialisationProperties(java.util.Properties)"><!-- --></A><H3>
1169	setInitialisationProperties</H3>
1170	<PRE>
1171	protected void <B>setInitialisationProperties</B>(java.util.Properties properties)
1172	throws javax.xml.parsers.ParserConfigurationException,
1173	java.net.MalformedURLException,
1174	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A>,
1175	java.net.ConnectException,
1176	java.rmi.RemoteException,
1177	javax.net.ssl.SSLHandshakeException,
1178	java.lang.Exception</PRE>
1179	<DL>
1180	<DD>Method that loops to display the dialog that retrieves the
1181	fedora server initialisation properties from the user. If there
1182	is a property file with values set already, it will display
1183	the previously entered values by loading them from that file.
1184	Otherwise, input fields in the dialog are empty.
1185	<P>
1186	<DD><DL>
1187	</DL>
1188	</DD>
1189	<DD><DL>
1190	<DT><B>Parameters:</B><DD><CODE>properties</CODE> - the Properties Hashmap storing values for
1191	username, password, host and port (and any errormessage).
1192	<DT><B>Throws:</B>
1193	<DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
1194	<DD><CODE>java.net.MalformedURLException</CODE>
1195	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A></CODE>
1196	<DD><CODE>java.net.ConnectException</CODE>
1197	<DD><CODE>java.rmi.RemoteException</CODE>
1198	<DD><CODE>javax.net.ssl.SSLHandshakeException</CODE>
1199	<DD><CODE>java.lang.Exception</CODE></DL>
1200	</DD>
1201	</DL>
1202	<HR>
1203
1204	<A NAME="showAuthenticationPopup(java.util.Properties)"><!-- --></A><H3>
1205	showAuthenticationPopup</H3>
1206	<PRE>
1207	protected static java.util.Properties <B>showAuthenticationPopup</B>(java.util.Properties properties)
1208	throws <A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A></PRE>
1209	<DL>
1210	<DD>Static method that displays a popup to allow the user to provide Fedora
1211	authentication (username, pwd) and connection (protocol+host, port) details.
1212	<P>
1213	<DD><DL>
1214	</DL>
1215	</DD>
1216	<DD><DL>
1217	<DT><B>Parameters:</B><DD><CODE>properties</CODE> - is a Properties HashMap where the property Keys which must
1218	have been put in here in advance (even with "" Values if appropriate) are:
1219	<pre>
1220	- username
1221	- password
1222	- host (may - but need not - be prefixed with either of the protocols
1223	"http://" and "https://"
1224	- port
1225	- errorMessage (displayed near the top of the popup dialog). Can be "".
1226	</pre>
1227	The values stored in the properties HashMap for the above property are
1228	initially displayed in the fields and the user can overwrite them.
1229	This is useful in such cases where invalid values were entered and this
1230	popup must be redisplayed to allow the user to correct their previous input.
1231	<DT><B>Returns:</B><DD>the same HashMap Properties which was passed as parameter.
1232	<DT><B>Throws:</B>
1233	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A></CODE></DL>
1234	</DD>
1235	</DL>
1236	<HR>
1237
1238	<A NAME="init(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
1239	init</H3>
1240	<PRE>
1241	protected void <B>init</B>(java.lang.String protocol,
1242	java.lang.String host,
1243	java.lang.String port,
1244	java.lang.String fedoraServerUsername,
1245	java.lang.String fedoraServerPassword)
1246	throws javax.xml.parsers.ParserConfigurationException,
1247	java.net.MalformedURLException,
1248	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.AuthenticationFailedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.AuthenticationFailedException</A>,
1249	java.rmi.RemoteException,
1250	java.lang.Exception</PRE>
1251	<DL>
1252	<DD>Init method that is called by the constructor to set some
1253	important member variables including instantiating the APIA object
1254	used to invoke the Fedora APIA web service operations.
1255	<P>
1256	<DD><DL>
1257	</DL>
1258	</DD>
1259	<DD><DL>
1260	<DT><B>Parameters:</B><DD><CODE>protocol</CODE> - can be http or https<DD><CODE>host</CODE> - is the name of the Fedora server host<DD><CODE>port</CODE> - is the port number (String form) of the Fedora server<DD><CODE>fedoraServerUsername</CODE> - is the user name to access the Fedora
1261	Server<DD><CODE>fedoraServerPassword</CODE> - is the password needed to access the
1262	Fedora Server
1263	<DT><B>Throws:</B>
1264	<DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
1265	<DD><CODE>java.net.MalformedURLException</CODE>
1266	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.AuthenticationFailedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.AuthenticationFailedException</A></CODE>
1267	<DD><CODE>java.rmi.RemoteException</CODE>
1268	<DD><CODE>java.lang.Exception</CODE></DL>
1269	</DD>
1270	</DL>
1271	<HR>
1272
1273	<A NAME="createAPIA(fedora.server.access.FedoraAPIAServiceLocator, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
1274	createAPIA</H3>
1275	<PRE>
1276	protected void <B>createAPIA</B>(fedora.server.access.FedoraAPIAServiceLocator serviceLocator,
1277	java.lang.String portSuffix,
1278	java.lang.String messageInsert,
1279	boolean isUserSpecifiedPortAddressSuffix)
1280	throws java.lang.Exception</PRE>
1281	<DL>
1282	<DD>Tries to create the FedoraAPIA instance using the serviceLocator
1283	and the given portSuffix. The APIA instance is obtained for the
1284	baseURL+portSuffix. Any exceptions are (processed and) rethrown
1285	or, if the flag isUserSpecifiedPortAddressSuffix is true, then the
1286	Remote Exception from AXIS that it can't find the target service to
1287	invoke is ignored so that the caller can retry with the default port-
1288	address suffix first before giving up.
1289	<P>
1290	<DD><DL>
1291	</DL>
1292	</DD>
1293	<DD><DL>
1294
1295	<DT><B>Throws:</B>
1296	<DD><CODE>java.lang.Exception</CODE></DL>
1297	</DD>
1298	</DL>
1299	<HR>
1300
1301	<A NAME="getCollections()"><!-- --></A><H3>
1302	getCollections</H3>
1303	<PRE>
1304	public java.lang.String[] <B>getCollections</B>()
1305	throws java.rmi.RemoteException</PRE>
1306	<DL>
1307	<DD>Gets all greenstone collections. Searches for greenstone:*-collection.
1308	Method getCollections() defaults to getting only those objects in fedora's
1309	repository whose pids are of the format greenstone:*-collection.
1310	The use of AutoFinder and findObjects is shown in
1311	fedora-2.2.1-src/src/java/fedora/client/search/ResultFrame.java
1312	The Fedora-APIA's method definition of findObjects is:
1313	<pre>
1314	fedora-types:FieldSearchResult findObjects(
1315	fedora-types:ArrayOfString resultFields,
1316	xsd:nonNegativeInteger maxResults,
1317	fedora-types:FieldSearchQuery query )
1318	</pre>
1319	<P>
1320	<DD><DL>
1321	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollections()">getCollections</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1322	</DD>
1323	<DD><DL>
1324
1325	<DT><B>Returns:</B><DD>an array of Strings containing the pids of all collections
1326	matching the format greenstone:*-collection.
1327	<DT><B>Throws:</B>
1328	<DD><CODE>java.rmi.RemoteException</CODE><DT><B>See Also:</B><DD><a href="http://localhost:8080/fedora/search">The local fedora search page for how the search works</a>,
1329	<a href="http://www.fedora.info/definitions/1/0/api/Fedora-API-A.html">Fedora access API, API-A for method findObjects</a>,
1330	<a href="http://www.fedora.info/definitions/1/0/types/#complexType_FieldSearchQuery_Link031D7D80">XML type definition of FieldSearchQuery</a>,
1331	<a href="http://www.fedora.info/download/2.2.1/javadocs/fedora/server/types/gen/FieldSearchQuery.html>Type definition of 2.2.1 FieldSearchQuery</a>,
1332	<a href="http://www.fedora.info/download/2.1.1/userdocs/server/serverdocs/fedora/server/search/FieldSearchQuery.html">does not apply: type definition of 2.1.1 FieldSearchQuery</a>,
1333	<a href="http://john.drc-dev.ohiolink.edu/browser/drc-core/trunk/src/java/edu/ohiolink/drc/drcdl/BrowseController.java?rev=462">BrowseController.java for an example</a></DL>
1334	</DD>
1335	</DL>
1336	<HR>
1337
1338	<A NAME="getDC(java.lang.String)"><!-- --></A><H3>
1339	getDC</H3>
1340	<PRE>
1341	public java.lang.String <B>getDC</B>(java.lang.String pid)
1342	throws java.rmi.RemoteException,
1343	java.io.UnsupportedEncodingException</PRE>
1344	<DL>
1345	<DD>All objects (incl "greenstone:*" objects) in fedora - be they collections,
1346	top-level documents or document sections - have a DC datastream. This
1347	method returns the content (XML) of the DC datastream as it is stored in
1348	fedora's repository.
1349	(The pid/DC call is one of the default fedora-system 3 disseminations.)
1350	Try an example of the form: http://localhost:8080/fedora/get/<pid>/DC
1351	To obtain the DC/any datastream, we use method getDatastreamDissemination()
1352	of the interface FedoraAPIA. This method returns a MIMETypedStream.
1353	The method signature is:
1354	MIMETypedStream getDatastreamDissemination(String pid, String dsID, String asOfDateTime)
1355	where dsID = itemID (look at datastreams page of running fedora instance)
1356	To access the XML content of the MIMETypedObject returned, we use its method
1357	bytes[] getStream(), but when instantiating a String from this, we have to
1358	use the String() contructor where we can specify the charset encoding (in
1359	this case, it must be UTF-8). Else getStream() returns gobbledygook.
1360	<P>
1361	<DD><DL>
1362	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDC(java.lang.String)">getDC</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1363	</DD>
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
1368	object denoted by pid.
1369	<DT><B>Throws:</B>
1370	<DD><CODE>java.rmi.RemoteException</CODE>
1371	<DD><CODE>java.io.UnsupportedEncodingException</CODE><DT><B>See Also:</B><DD><a href="http://www.fedora.info/download/2.2.1/javadocs/fedora/server/access/FedoraAPIABindingSOAPHTTPSkeleton.html">FedoraAPIABindingSOAPHTTPSkeleton.java, the API-A web service stub class</a>,
1372	<a href="http://drc-dev.ohiolink.edu/browser/fedora-core/tags/upstream/src/test/junit/fedora/test/integration/TestAPIA.java?rev=575">TestAPIA.java, which contains an example of MIMETypedObject.getStream() usage.</a>,
1373	<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html#String(byte[],%20java.lang.String)">constructor String(byte[], java.lang.String)</a>,
1374	<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/nio/charset/Charset.html">Charset.java, for character sets and encoding</a></DL>
1375	</DD>
1376	</DL>
1377	<HR>
1378
1379	<A NAME="getEX(java.lang.String)"><!-- --></A><H3>
1380	getEX</H3>
1381	<PRE>
1382	public java.lang.String <B>getEX</B>(java.lang.String pid)
1383	throws java.rmi.RemoteException,
1384	java.io.UnsupportedEncodingException</PRE>
1385	<DL>
1386	<DD>All "greenstone:*" objects in fedora (be they collections be they
1387	collections, top-level documents or document sections) have an EX
1388	datastream. This method returns the content (XML) of the EX datastream as
1389	is. (It calls the default fedora-system 3 dissemination <pid>/EX.)
1390	<P>
1391	<DD><DL>
1392	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getEX(java.lang.String)">getEX</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1393	</DD>
1394	<DD><DL>
1395	<DT><B>Parameters:</B><DD><CODE>pid</CODE> - - the fedora persistent identifier for an item in the fedora
1396	repository.
1397	Use MIMETypedStream APIA.getDatastreamDissemination(pid, itemID,
1398	asOfDateTime).
1399	Use String(bytes[], charset="UTF-8") to convert MIMETypedStream.getStream().
1400	<DT><B>Returns:</B><DD>a String version of the XML in the EX datastream for the fedora
1401	object denoted by pid.
1402	<DT><B>Throws:</B>
1403	<DD><CODE>java.rmi.RemoteException</CODE>
1404	<DD><CODE>java.io.UnsupportedEncodingException</CODE><DT><B>See Also:</B><DD><CODE>getDC(String pid) throws Exception</CODE></DL>
1405	</DD>
1406	</DL>
1407	<HR>
1408
1409	<A NAME="getDLS(java.lang.String)"><!-- --></A><H3>
1410	getDLS</H3>
1411	<PRE>
1412	public java.lang.String <B>getDLS</B>(java.lang.String pid)
1413	throws java.rmi.RemoteException,
1414	java.io.UnsupportedEncodingException</PRE>
1415	<DL>
1416	<DD>Some "greenstone:*" top-level documents in the fedora repository (but not
1417	greenstone collections or document sections) have a DLS metadata datastream.
1418	This method returns the content (XML) of the DLS datastream as is. (It calls
1419	the default fedora-system 3 dissemination <pid>/DLS.)
1420	<P>
1421	<DD><DL>
1422	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDLS(java.lang.String)">getDLS</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1423	</DD>
1424	<DD><DL>
1425	<DT><B>Parameters:</B><DD><CODE>pid</CODE> - - the fedora persistent identifier for an item in the fedora
1426	repository.
1427	Use MIMETypedStream APIA.getDatastreamDissemination(pid, itemID,
1428	asOfDateTime).
1429	Use String(bytes[], charset="UTF-8") to convert MIMETypedStream.getStream().
1430	<DT><B>Returns:</B><DD>a String version of the XML in the DLS datastream for the fedora
1431	object denoted by pid, or "" if the document given by pid has no DLS datastream.
1432	<DT><B>Throws:</B>
1433	<DD><CODE>java.rmi.RemoteException</CODE>
1434	<DD><CODE>java.io.UnsupportedEncodingException</CODE><DT><B>See Also:</B><DD><CODE>getDC(String pid) throws Exception</CODE></DL>
1435	</DD>
1436	</DL>
1437	<HR>
1438
1439	<A NAME="getTOC(java.lang.String)"><!-- --></A><H3>
1440	getTOC</H3>
1441	<PRE>
1442	public java.lang.String <B>getTOC</B>(java.lang.String pid)
1443	throws java.rmi.RemoteException,
1444	java.io.UnsupportedEncodingException</PRE>
1445	<DL>
1446	<DD>All "greenstone:*" objects in fedora (be they collections or documents)
1447	have a TOC datastream. This method returns the content (XML) of the TOC
1448	datastream as is. (Calls default fedora-system 3 dissemination <pid>/TOC.)
1449	<P>
1450	<DD><DL>
1451	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getTOC(java.lang.String)">getTOC</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1452	</DD>
1453	<DD><DL>
1454	<DT><B>Parameters:</B><DD><CODE>pid</CODE> - - the fedora persistent identifier for an item in the fedora
1455	repository.
1456	Use MIMETypedStream APIA.getDatastreamDissemination(pid, itemID,
1457	asOfDateTime)
1458	Use String(bytes[], charset="UTF-8") to convert MIMETypedStream.getStream()
1459	<DT><B>Returns:</B><DD>a String version of the XML in the TOC datastream for the fedora
1460	object denoted by pid.
1461	<DT><B>Throws:</B>
1462	<DD><CODE>java.rmi.RemoteException</CODE>
1463	<DD><CODE>java.io.UnsupportedEncodingException</CODE><DT><B>See Also:</B><DD><CODE>getDC(String pid) throws Exception</CODE></DL>
1464	</DD>
1465	</DL>
1466	<HR>
1467
1468	<A NAME="getCollectionNames(java.lang.String[])"><!-- --></A><H3>
1469	getCollectionNames</H3>
1470	<PRE>
1471	public java.lang.String[] <B>getCollectionNames</B>(java.lang.String[] collPIDs)</PRE>
1472	<DL>
1473	<DD><DL>
1474	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionNames(java.lang.String[])">getCollectionNames</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1475	</DD>
1476	<DD><DL>
1477	<DT><B>Parameters:</B><DD><CODE>collPIDs</CODE> - - an array of Strings denoting the pids for greenstone
1478	collections stored in the fedora repositoryl. These should be of the
1479	format "greenstone:<collectionName>-collection".
1480	<DT><B>Returns:</B><DD>the <name>s (in greenstone:<name>-collection)
1481	for the collections indicated by collPIDs.</DL>
1482	</DD>
1483	</DL>
1484	<HR>
1485
1486	<A NAME="getCollectionPIDs(java.lang.String[])"><!-- --></A><H3>
1487	getCollectionPIDs</H3>
1488	<PRE>
1489	public java.lang.String[] <B>getCollectionPIDs</B>(java.lang.String[] collNames)</PRE>
1490	<DL>
1491	<DD><DL>
1492	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionPIDs(java.lang.String[])">getCollectionPIDs</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1493	</DD>
1494	<DD><DL>
1495	<DT><B>Parameters:</B><DD><CODE>collNames</CODE> - - a list of names of greenstone collections
1496	stored in the fedora repository.
1497	<DT><B>Returns:</B><DD>"greenstone:<name>-collection" for all <name>s
1498	in the parameter collNames.</DL>
1499	</DD>
1500	</DL>
1501	<HR>
1502
1503	<A NAME="getCollectionPID(java.lang.String)"><!-- --></A><H3>
1504	getCollectionPID</H3>
1505	<PRE>
1506	public java.lang.String <B>getCollectionPID</B>(java.lang.String collName)</PRE>
1507	<DL>
1508	<DD><DL>
1509	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionPID(java.lang.String)">getCollectionPID</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1510	</DD>
1511	<DD><DL>
1512	<DT><B>Parameters:</B><DD><CODE>collName</CODE> - - the name of a greenstone collection stored
1513	stored in the fedora repository.
1514	<DT><B>Returns:</B><DD>greenstone:<name>-collection for the<name>
1515	denoted by parameter collName.</DL>
1516	</DD>
1517	</DL>
1518	<HR>
1519
1520	<A NAME="getCollectionTitle(java.lang.String)"><!-- --></A><H3>
1521	getCollectionTitle</H3>
1522	<PRE>
1523	public java.lang.String <B>getCollectionTitle</B>(java.lang.String collPID)
1524	throws java.rmi.RemoteException,
1525	java.io.UnsupportedEncodingException,
1526	org.xml.sax.SAXException,
1527	java.io.IOException</PRE>
1528	<DL>
1529	<DD>Gets the title of the collection denoted by the given collection's pid by
1530	retrieving the title metadata for it from the collection's EX datastream.
1531	<P>
1532	<DD><DL>
1533	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionTitle(java.lang.String)">getCollectionTitle</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1534	</DD>
1535	<DD><DL>
1536	<DT><B>Parameters:</B><DD><CODE>collPID</CODE> - is the pid of a greenstone collection in the fedora
1537	repository.
1538	<DT><B>Returns:</B><DD>the title (in the default language, else English, else the
1539	first title found) for the particular collection denoted by its PID.
1540	<DT><B>Throws:</B>
1541	<DD><CODE>java.rmi.RemoteException</CODE>
1542	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1543	<DD><CODE>org.xml.sax.SAXException</CODE>
1544	<DD><CODE>java.io.IOException</CODE></DL>
1545	</DD>
1546	</DL>
1547	<HR>
1548
1549	<A NAME="getCollectionTitles(java.lang.String[])"><!-- --></A><H3>
1550	getCollectionTitles</H3>
1551	<PRE>
1552	public java.lang.String[] <B>getCollectionTitles</B>(java.lang.String[] collPIDs)
1553	throws java.rmi.RemoteException,
1554	java.io.UnsupportedEncodingException,
1555	org.xml.sax.SAXException,
1556	java.io.IOException</PRE>
1557	<DL>
1558	<DD><DL>
1559	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionTitles(java.lang.String[])">getCollectionTitles</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1560	</DD>
1561	<DD><DL>
1562	<DT><B>Parameters:</B><DD><CODE>collPIDs</CODE> - - a list of pids identifying greenstone collections
1563	stored in the fedora repository.
1564	<DT><B>Returns:</B><DD>the collection titles for all the collections indicated by
1565	collPIDs.
1566	<DT><B>Throws:</B>
1567	<DD><CODE>java.rmi.RemoteException</CODE>
1568	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1569	<DD><CODE>org.xml.sax.SAXException</CODE>
1570	<DD><CODE>java.io.IOException</CODE></DL>
1571	</DD>
1572	</DL>
1573	<HR>
1574
1575	<A NAME="getDocTitles(java.lang.String[])"><!-- --></A><H3>
1576	getDocTitles</H3>
1577	<PRE>
1578	public java.lang.String[] <B>getDocTitles</B>(java.lang.String[] docPIDs)
1579	throws java.rmi.RemoteException,
1580	java.io.UnsupportedEncodingException,
1581	org.xml.sax.SAXException,
1582	java.io.IOException</PRE>
1583	<DL>
1584	<DD><DL>
1585	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDocTitles(java.lang.String[])">getDocTitles</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1586	</DD>
1587	<DD><DL>
1588	<DT><B>Parameters:</B><DD><CODE>docPIDs</CODE> - - a list of pids identifying documents stored in the
1589	fedora repository.
1590	<DT><B>Returns:</B><DD>the title metadata for the given doc objects of a collection.
1591	These titles are returned in the same order as the given docIDs.
1592	(The docPIDs already contain the collection name anyway.)
1593	<DT><B>Throws:</B>
1594	<DD><CODE>java.rmi.RemoteException</CODE>
1595	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1596	<DD><CODE>org.xml.sax.SAXException</CODE>
1597	<DD><CODE>java.io.IOException</CODE></DL>
1598	</DD>
1599	</DL>
1600	<HR>
1601
1602	<A NAME="getDocTitle(java.lang.String)"><!-- --></A><H3>
1603	getDocTitle</H3>
1604	<PRE>
1605	public java.lang.String <B>getDocTitle</B>(java.lang.String docPID)
1606	throws java.rmi.RemoteException,
1607	java.io.UnsupportedEncodingException,
1608	org.xml.sax.SAXException,
1609	java.io.IOException</PRE>
1610	<DL>
1611	<DD>Gets the title metadata for a particular doc object in a collection
1612	denoted by docPID. The docPID already contains the collection name.
1613	<P>
1614	<DD><DL>
1615	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDocTitle(java.lang.String)">getDocTitle</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1616	</DD>
1617	<DD><DL>
1618	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is the pid of the document in the fedora repository
1619	(docPID is of the form greenstone:<colName>-<doc-identifier>
1620	<DT><B>Returns:</B><DD>the title for the fedora document item denoted by docPID
1621	<DT><B>Throws:</B>
1622	<DD><CODE>java.rmi.RemoteException</CODE>
1623	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1624	<DD><CODE>org.xml.sax.SAXException</CODE>
1625	<DD><CODE>java.io.IOException</CODE></DL>
1626	</DD>
1627	</DL>
1628	<HR>
1629
1630	<A NAME="getTitle(java.lang.String)"><!-- --></A><H3>
1631	getTitle</H3>
1632	<PRE>
1633	protected java.lang.String <B>getTitle</B>(java.lang.String exStream)
1634	throws org.xml.sax.SAXException,
1635	java.io.IOException</PRE>
1636	<DL>
1637	<DD>Given a string representation of a document's or document section's
1638	EX datastream -- which is a greenstone extracted metadata XML file --
1639	of the form:
1640	<ex>
1641	<ex:metadata name="Title">sometitle</ex:metadata>
1642	<ex:metadata name="...">....</ex:metadata>
1643	...
1644	</ex>
1645	This method finds the <ex:metadata> where the name="Title" and
1646	returns the value embedded in that element ('sometitle' in
1647	the example above).
1648	<P>
1649	<DD><DL>
1650	</DL>
1651	</DD>
1652	<DD><DL>
1653	<DT><B>Parameters:</B><DD><CODE>exStream</CODE> - the EX datastream in String form of the document or
1654	document section.
1655	<DT><B>Returns:</B><DD>the title metadata of the document/document section whose EX
1656	datastream is passed as parameter
1657	<DT><B>Throws:</B>
1658	<DD><CODE>org.xml.sax.SAXException</CODE>
1659	<DD><CODE>java.io.IOException</CODE></DL>
1660	</DD>
1661	</DL>
1662	<HR>
1663
1664	<A NAME="getSectionTitles(java.lang.String[], java.lang.String[])"><!-- --></A><H3>
1665	getSectionTitles</H3>
1666	<PRE>
1667	public java.lang.String[] <B>getSectionTitles</B>(java.lang.String[] docPIDs,
1668	java.lang.String[] sectionIDs)
1669	throws java.rmi.RemoteException,
1670	java.io.UnsupportedEncodingException,
1671	org.xml.sax.SAXException,
1672	java.io.IOException</PRE>
1673	<DL>
1674	<DD><DL>
1675	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionTitles(java.lang.String[], java.lang.String[])">getSectionTitles</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1676	</DD>
1677	<DD><DL>
1678	<DT><B>Parameters:</B><DD><CODE>docPIDs</CODE> - - a list of pids identifying documents stored in the
1679	fedora repository.<DD><CODE>sectionIDs</CODE> - - a list of sectionIDs identifying individual sections
1680	of documents stored in the fedora repository whose titles are requested.
1681	<DT><B>Returns:</B><DD>the title metadata for the given document sections.
1682	These titles are returned in the same order as the given docPIDs
1683	and associated sectionIDs.
1684	(The docPIDs already contain the collection name anyway.)
1685	<DT><B>Throws:</B>
1686	<DD><CODE>java.rmi.RemoteException</CODE>
1687	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1688	<DD><CODE>org.xml.sax.SAXException</CODE>
1689	<DD><CODE>java.io.IOException</CODE></DL>
1690	</DD>
1691	</DL>
1692	<HR>
1693
1694	<A NAME="getSectionTitle(java.lang.String, java.lang.String)"><!-- --></A><H3>
1695	getSectionTitle</H3>
1696	<PRE>
1697	public java.lang.String <B>getSectionTitle</B>(java.lang.String docPID,
1698	java.lang.String sectionID)
1699	throws java.io.UnsupportedEncodingException,
1700	java.rmi.RemoteException,
1701	org.xml.sax.SAXException,
1702	java.io.IOException</PRE>
1703	<DL>
1704	<DD><DL>
1705	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionTitle(java.lang.String, java.lang.String)">getSectionTitle</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1706	</DD>
1707	<DD><DL>
1708	<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
1709	document whose title is requested.
1710	<DT><B>Returns:</B><DD>the title metadata for the given document section.
1711	(The docPID already contain the collection name anyway.)
1712	<DT><B>Throws:</B>
1713	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1714	<DD><CODE>java.rmi.RemoteException</CODE>
1715	<DD><CODE>org.xml.sax.SAXException</CODE>
1716	<DD><CODE>java.io.IOException</CODE></DL>
1717	</DD>
1718	</DL>
1719	<HR>
1720
1721	<A NAME="getCollectionDocs(java.lang.String)"><!-- --></A><H3>
1722	getCollectionDocs</H3>
1723	<PRE>
1724	public java.lang.String[] <B>getCollectionDocs</B>(java.lang.String colPID)
1725	throws java.rmi.RemoteException</PRE>
1726	<DL>
1727	<DD>Searches the fedora repository for all greenstone:<colPID>* and
1728	returns the PIDs of the data objects found, with the exception of
1729	greenstone:<colPID>-collection, which is not a document but a
1730	collection PID.
1731	That is, pids of objects whose pid is greenstone:<colName>*
1732	(but not greenstone:<colName>-collection itself, because that represents
1733	the collection and not an object of the same collection) are returned.
1734	All pids that do not map to a collection are assumed to be documents!
1735	<P>
1736	<DD><DL>
1737	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionDocs(java.lang.String)">getCollectionDocs</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1738	</DD>
1739	<DD><DL>
1740	<DT><B>Parameters:</B><DD><CODE>colPID</CODE> - is the pid of the greenstone collection stored in
1741	the fedora repository.
1742	<DT><B>Returns:</B><DD>a list of the pids of all the (doc) objects in a collection.
1743	<DT><B>Throws:</B>
1744	<DD><CODE>java.rmi.RemoteException</CODE></DL>
1745	</DD>
1746	</DL>
1747	<HR>
1748
1749	<A NAME="getSectionNames(java.lang.String)"><!-- --></A><H3>
1750	getSectionNames</H3>
1751	<PRE>
1752	public java.lang.String[] <B>getSectionNames</B>(java.lang.String docPID)
1753	throws java.rmi.RemoteException</PRE>
1754	<DL>
1755	<DD>Given the pid of a document fedora data object, this method will return
1756	all itemIDs that are part of that data object and are Sections. For further
1757	information see interface Comparable (implemented by String), SortedSet
1758	and TreeSet.
1759	<P>
1760	<DD><DL>
1761	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionNames(java.lang.String)">getSectionNames</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1762	</DD>
1763	<DD><DL>
1764	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.
1765	<DT><B>Returns:</B><DD>an array of itemIDs of the Sections of the document,
1766	indicated by docPID, in ascending order. These are of the form: "SECTION1.*"
1767	<DT><B>Throws:</B>
1768	<DD><CODE>java.rmi.RemoteException</CODE><DT><B>See Also:</B><DD><a href="http://www.fedora.info/download/2.2.1/javadocs/fedora/server/access/FedoraAPIABindingSOAPHTTPSkeleton.html">FedoraAPIABindingSOAPHTTPSkeleton.java stub class for the API-A web services</a>,
1769	<a href="http://www.fedora.info/download/2.2.1/javadocs/fedora/server/types/gen/DatastreamDef.html">DatastreamDef.java</a>,
1770	<a href="http://dltj.org/2006/12/fedora-batch-processing/">Fedora batch processing</a></DL>
1771	</DD>
1772	</DL>
1773	<HR>
1774
1775	<A NAME="getSectionNumbers(java.lang.String)"><!-- --></A><H3>
1776	getSectionNumbers</H3>
1777	<PRE>
1778	public java.lang.String[] <B>getSectionNumbers</B>(java.lang.String docPID)
1779	throws java.rmi.RemoteException</PRE>
1780	<DL>
1781	<DD>Given the pid of a document fedora data object, this method will return all
1782	itemIDs that are part of that data object and are Sections, but just the
1783	Section numbers are returned. For further information see interface Comparable
1784	(implemented by String), SortedSet and TreeSet.
1785	<P>
1786	<DD><DL>
1787	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionNumbers(java.lang.String)">getSectionNumbers</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1788	</DD>
1789	<DD><DL>
1790	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - is a fedora pid identifying a greenstone document object.
1791	<DT><B>Returns:</B><DD>an array of itemIDs of the Section numbers of the document
1792	indicated by docPID, in ascending order. Return values are of form: "1.*".
1793	<DT><B>Throws:</B>
1794	<DD><CODE>java.rmi.RemoteException</CODE><DT><B>See Also:</B><DD><a href="http://www.fedora.info/download/2.2.1/javadocs/fedora/server/access/FedoraAPIABindingSOAPHTTPSkeleton.html">FedoraAPIABindingSOAPHTTPSkeleton.java stub class for the API-A web services</a>,
1795	<a href="http://www.fedora.info/download/2.2.1/javadocs/fedora/server/types/gen/DatastreamDef.html">DatastreamDef.java</a>,
1796	<a href="http://dltj.org/2006/12/fedora-batch-processing/">Fedora batch processing</a></DL>
1797	</DD>
1798	</DL>
1799	<HR>
1800
1801	<A NAME="getTitles(java.lang.String, java.lang.String[])"><!-- --></A><H3>
1802	getTitles</H3>
1803	<PRE>
1804	public java.lang.String[] <B>getTitles</B>(java.lang.String docPID,
1805	java.lang.String[] sectionIDs)
1806	throws java.rmi.RemoteException,
1807	java.io.UnsupportedEncodingException,
1808	org.xml.sax.SAXException,
1809	java.io.IOException</PRE>
1810	<DL>
1811	<DD><DL>
1812	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getTitles(java.lang.String, java.lang.String[])">getTitles</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1813	</DD>
1814	<DD><DL>
1815	<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
1816	document denoted by docPID, whose titles need to be returned. Each
1817	sectionID may sectionID may be either a section name (e.g. SECTION1.5.1)
1818	or a section number (eg. 1.5.1).
1819	<DT><B>Returns:</B><DD>the titles for the document sections denoted by the parameters.
1820	<DT><B>Throws:</B>
1821	<DD><CODE>java.rmi.RemoteException</CODE>
1822	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1823	<DD><CODE>org.xml.sax.SAXException</CODE>
1824	<DD><CODE>java.io.IOException</CODE></DL>
1825	</DD>
1826	</DL>
1827	<HR>
1828
1829	<A NAME="getTitle(java.lang.String, java.lang.String)"><!-- --></A><H3>
1830	getTitle</H3>
1831	<PRE>
1832	public java.lang.String <B>getTitle</B>(java.lang.String docPID,
1833	java.lang.String sectionID)
1834	throws java.rmi.RemoteException,
1835	java.io.UnsupportedEncodingException,
1836	org.xml.sax.SAXException,
1837	java.io.IOException</PRE>
1838	<DL>
1839	<DD><DL>
1840	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getTitle(java.lang.String, java.lang.String)">getTitle</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1841	</DD>
1842	<DD><DL>
1843	<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 document denoted
1844	by docPID, whose title needs to be returned. The sectionID may be either a
1845	section name (e.g. SECTION1.5.1) or a section number (eg. 1.5.1).
1846	<DT><B>Returns:</B><DD>the title for the document section denoted by the parameters.
1847	<DT><B>Throws:</B>
1848	<DD><CODE>java.rmi.RemoteException</CODE>
1849	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1850	<DD><CODE>org.xml.sax.SAXException</CODE>
1851	<DD><CODE>java.io.IOException</CODE></DL>
1852	</DD>
1853	</DL>
1854	<HR>
1855
1856	<A NAME="getSection(java.lang.String, java.lang.String)"><!-- --></A><H3>
1857	getSection</H3>
1858	<PRE>
1859	public java.lang.String <B>getSection</B>(java.lang.String docPID,
1860	java.lang.String sectionID)
1861	throws java.rmi.RemoteException,
1862	java.io.UnsupportedEncodingException</PRE>
1863	<DL>
1864	<DD><DL>
1865	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSection(java.lang.String, java.lang.String)">getSection</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1866	</DD>
1867	<DD><DL>
1868	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - - identifyies the particular section in the
1869	document denoted by docPID, may be a section name or number.
1870	<DT><B>Returns:</B><DD>the section's XML (as a String) as it is stored in fedora.
1871	Works out if sectionID is a sectionName or sectionNumber.
1872	<DT><B>Throws:</B>
1873	<DD><CODE>java.rmi.RemoteException</CODE>
1874	<DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
1875	</DD>
1876	</DL>
1877	<HR>
1878
1879	<A NAME="getSectionDCMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
1880	getSectionDCMetadata</H3>
1881	<PRE>
1882	public java.lang.String <B>getSectionDCMetadata</B>(java.lang.String docPID,
1883	java.lang.String sectionID)
1884	throws java.rmi.RemoteException,
1885	java.io.UnsupportedEncodingException</PRE>
1886	<DL>
1887	<DD><DL>
1888	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionDCMetadata(java.lang.String, java.lang.String)">getSectionDCMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1889	</DD>
1890	<DD><DL>
1891	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - - identifyies the particular section in the
1892	document denoted by docPID, may be a section name or number.
1893	<DT><B>Returns:</B><DD>the required section's DC metadata XML datastream.
1894	<DT><B>Throws:</B>
1895	<DD><CODE>java.rmi.RemoteException</CODE>
1896	<DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
1897	</DD>
1898	</DL>
1899	<HR>
1900
1901	<A NAME="getSectionEXMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
1902	getSectionEXMetadata</H3>
1903	<PRE>
1904	public java.lang.String <B>getSectionEXMetadata</B>(java.lang.String docPID,
1905	java.lang.String sectionID)
1906	throws java.rmi.RemoteException,
1907	java.io.UnsupportedEncodingException</PRE>
1908	<DL>
1909	<DD>Returns the section EX metadata XML datastream for SectionID which may be
1910	a section name or number. Currently a few EX files are named awkwardly:
1911	the EX file for section 1.* is actually associated with datastream EX.*.
1912	But subsequent EX datastreams are named appropriately: for instance,
1913	EX2.1.1 matches with section 2.1.1
1914	<P>
1915	<DD><DL>
1916	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSectionEXMetadata(java.lang.String, java.lang.String)">getSectionEXMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1917	</DD>
1918	<DD><DL>
1919	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - - identifyies the particular section in the
1920	document denoted by docPID, may be a section name or number.
1921	<DT><B>Returns:</B><DD>the required section's EX metadata XML datastream.
1922	<DT><B>Throws:</B>
1923	<DD><CODE>java.rmi.RemoteException</CODE>
1924	<DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
1925	</DD>
1926	</DL>
1927	<HR>
1928
1929	<A NAME="getChildrenOfSectionXML(java.lang.String, java.lang.String)"><!-- --></A><H3>
1930	getChildrenOfSectionXML</H3>
1931	<PRE>
1932	public org.w3c.dom.Element <B>getChildrenOfSectionXML</B>(java.lang.String docPID,
1933	java.lang.String sectionID)
1934	throws java.rmi.RemoteException,
1935	java.io.UnsupportedEncodingException,
1936	org.xml.sax.SAXException,
1937	java.io.IOException</PRE>
1938	<DL>
1939	<DD><DL>
1940	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getChildrenOfSectionXML(java.lang.String, java.lang.String)">getChildrenOfSectionXML</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1941	</DD>
1942	<DD><DL>
1943	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - - identifyies the particular section in the
1944	document denoted by docPID, may be a section name or number.
1945	<DT><B>Returns:</B><DD>the XML content of the TOC of just that portion of the TOC which
1946	contains the section denoted by sectionID and its direct child subsections.
1947	The children are returned in the order they are encountered, which
1948	happens to be in the required order of ascending sectionID.
1949	<DT><B>Throws:</B>
1950	<DD><CODE>java.rmi.RemoteException</CODE>
1951	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1952	<DD><CODE>org.xml.sax.SAXException</CODE>
1953	<DD><CODE>java.io.IOException</CODE></DL>
1954	</DD>
1955	</DL>
1956	<HR>
1957
1958	<A NAME="getChildrenOfSection(java.lang.String, java.lang.String)"><!-- --></A><H3>
1959	getChildrenOfSection</H3>
1960	<PRE>
1961	public java.lang.String <B>getChildrenOfSection</B>(java.lang.String docPID,
1962	java.lang.String sectionID)
1963	throws java.rmi.RemoteException,
1964	java.io.UnsupportedEncodingException,
1965	org.xml.sax.SAXException,
1966	java.io.IOException,
1967	javax.xml.transform.TransformerException</PRE>
1968	<DL>
1969	<DD><DL>
1970	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getChildrenOfSection(java.lang.String, java.lang.String)">getChildrenOfSection</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
1971	</DD>
1972	<DD><DL>
1973	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - - identifyies the particular section in the
1974	document denoted by docPID, may be a section name or number.
1975	<DT><B>Returns:</B><DD>a string representing the XML content of the TOC of just
1976	that portion of the TOC which contains the section denoted by sectionID
1977	and its direct child subsections.
1978	The children are returned in the order they are encountered, which
1979	happens to be in the required order of ascending sectionID.
1980	<DT><B>Throws:</B>
1981	<DD><CODE>java.rmi.RemoteException</CODE>
1982	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
1983	<DD><CODE>org.xml.sax.SAXException</CODE>
1984	<DD><CODE>java.io.IOException</CODE>
1985	<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
1986	</DD>
1987	</DL>
1988	<HR>
1989
1990	<A NAME="getSubsectionXML(java.lang.String, java.lang.String)"><!-- --></A><H3>
1991	getSubsectionXML</H3>
1992	<PRE>
1993	public org.w3c.dom.Element <B>getSubsectionXML</B>(java.lang.String docPID,
1994	java.lang.String sectionID)
1995	throws java.rmi.RemoteException,
1996	java.io.UnsupportedEncodingException,
1997	org.xml.sax.SAXException,
1998	java.io.IOException</PRE>
1999	<DL>
2000	<DD><DL>
2001	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSubsectionXML(java.lang.String, java.lang.String)">getSubsectionXML</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2002	</DD>
2003	<DD><DL>
2004	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - - identifyies the particular section in the
2005	document denoted by docPID, may be a section name or number.
2006	<DT><B>Returns:</B><DD>the part of the TOC XML file (which outlines doc structure)
2007	relating to the given section. This includes the section denoted by
2008	sectionID as well as all descendent subsections thereof.
2009	<DT><B>Throws:</B>
2010	<DD><CODE>java.rmi.RemoteException</CODE>
2011	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
2012	<DD><CODE>org.xml.sax.SAXException</CODE>
2013	<DD><CODE>java.io.IOException</CODE></DL>
2014	</DD>
2015	</DL>
2016	<HR>
2017
2018	<A NAME="getSubsection(java.lang.String, java.lang.String)"><!-- --></A><H3>
2019	getSubsection</H3>
2020	<PRE>
2021	public java.lang.String <B>getSubsection</B>(java.lang.String docPID,
2022	java.lang.String sectionID)
2023	throws java.rmi.RemoteException,
2024	java.io.UnsupportedEncodingException,
2025	org.xml.sax.SAXException,
2026	java.io.IOException,
2027	javax.xml.transform.TransformerException</PRE>
2028	<DL>
2029	<DD><DL>
2030	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getSubsection(java.lang.String, java.lang.String)">getSubsection</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2031	</DD>
2032	<DD><DL>
2033	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - a fedora pid identifying a greenstone document object.<DD><CODE>sectionID</CODE> - identifyies the particular section in the
2034	document denoted by docPID, may be a section name or number.
2035	<DT><B>Returns:</B><DD>a String representation of the part of the TOC XML file
2036	(which outlines doc structure) relating to the given section. This
2037	includes the section denoted by sectionID as well as all descendent
2038	subsections thereof.
2039	<DT><B>Throws:</B>
2040	<DD><CODE>java.rmi.RemoteException</CODE>
2041	<DD><CODE>java.io.UnsupportedEncodingException</CODE>
2042	<DD><CODE>org.xml.sax.SAXException</CODE>
2043	<DD><CODE>java.io.IOException</CODE>
2044	<DD><CODE>javax.xml.transform.TransformerException</CODE></DL>
2045	</DD>
2046	</DL>
2047	<HR>
2048
2049	<A NAME="browseTitlesByLetter(java.lang.String, java.lang.String)"><!-- --></A><H3>
2050	browseTitlesByLetter</H3>
2051	<PRE>
2052	public java.lang.String[] <B>browseTitlesByLetter</B>(java.lang.String collName,
2053	java.lang.String letter)
2054	throws java.rmi.RemoteException,
2055	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></PRE>
2056	<DL>
2057	<DD>Implements browsing document titles of a greenstone collection stored in
2058	the fedora repository by letter.
2059	<P>
2060	<DD><DL>
2061	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#browseTitlesByLetter(java.lang.String, java.lang.String)">browseTitlesByLetter</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2062	</DD>
2063	<DD><DL>
2064	<DT><B>Parameters:</B><DD><CODE>letter</CODE> - - the starting letter to browse by.
2065	<DT><B>Returns:</B><DD>the document pids whose titles start with the given letter.
2066	<DT><B>Throws:</B>
2067	<DD><CODE>java.rmi.RemoteException</CODE>
2068	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></CODE></DL>
2069	</DD>
2070	</DL>
2071	<HR>
2072
2073	<A NAME="searchDocumentTitles(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
2074	searchDocumentTitles</H3>
2075	<PRE>
2076	public java.lang.String[] <B>searchDocumentTitles</B>(java.lang.String collName,
2077	java.lang.String titleContents,
2078	boolean startsWith)
2079	throws java.rmi.RemoteException,
2080	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></PRE>
2081	<DL>
2082	<DD>Implements querying document DC titles of a greenstone collection stored in
2083	the fedora repository for a term that may occur anywhere in their titles.
2084	<P>
2085	<DD><DL>
2086	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#searchDocumentTitles(java.lang.String, java.lang.String, boolean)">searchDocumentTitles</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2087	</DD>
2088	<DD><DL>
2089	<DT><B>Parameters:</B><DD><CODE>titleContents</CODE> - - the word or phrase to search the collection's
2090	document titles for. Only one word, and this method finds Greenstone
2091	DOCUMENT titles CONTAINING that word (if any).<DD><CODE>startsWith</CODE> - - if true, searches for titles that start with
2092	titleContents. Else it searches for titles that contain titleContents.
2093	<DT><B>Returns:</B><DD>the document pids whose DC titles contain the parameter term.
2094	<DT><B>Throws:</B>
2095	<DD><CODE>java.rmi.RemoteException</CODE>
2096	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></CODE></DL>
2097	</DD>
2098	</DL>
2099	<HR>
2100
2101	<A NAME="findObjectsWithTitlesContaining(java.lang.String, java.lang.String)"><!-- --></A><H3>
2102	findObjectsWithTitlesContaining</H3>
2103	<PRE>
2104	protected fedora.server.types.gen.FieldSearchResult <B>findObjectsWithTitlesContaining</B>(java.lang.String collName,
2105	java.lang.String titleWord)
2106	throws java.rmi.RemoteException,
2107	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></PRE>
2108	<DL>
2109	<DD><DL>
2110	</DL>
2111	</DD>
2112	<DD><DL>
2113	<DT><B>Parameters:</B><DD><CODE>collName</CODE> - - the collection of documents we'll be searching in.<DD><CODE>titleWord</CODE> - - the word we'll be searching the document titles for.
2114	(Fedora's search returns all objects whose title contains that word).
2115
2116	Two kinds of search are provided by Fedora as stated in FedoraAccess.java
2117	(see link):
2118	<pre>
2119	"There are two search methods: a search on all fields or a search on
2120	specific fields. To search all fields the setTerms function of the
2121	FieldSearchQuery must be used, with the paramater being the desired string.
2122
2123	To search by specific fields, you must create an array of Condition
2124	objects. Each condition consists of three parts:
2125	the field to be searched (.setProperty()),
2126	the operation to be used (.setOperator(ComparisonOperator. <operator>)),
2127	and the search string (.setValue())"
2128	</pre>
2129	We want to use the second search method above when browsing and searching,
2130	and search for: pid~greenstone:<collName>* title~<letter>*
2131	or pid~greenstone:<collName>* title~<first word of search phrase>
2132	See also fedora-2.2.1-src/src/java/fedora/client/search/Search.java.
2133
2134	The fedora/tomcat/webapps/fedora/WEB-INF/web.xml is where the REST-based
2135	web services are defined. (The web.xml defines the "Servlets for REST-based
2136	interfaces to the Fedora Repository Server").
2137	Do a search on the word "search":
2138	fedora.server.access.FieldSearchServlet is the class we need to look at
2139	It accesses a different Condition.java class: fedora.server.search.Condition.java
2140	The above is what is used by the REST-based interface in FieldSearchServlet.java
2141	While fedora-2.2.1-src/build/wsdl/fedora/server/types/gen/Condition.java
2142	is what's used in the fedora client application that makes use of
2143	the SOAP-based interface.
2144	<DT><B>Throws:</B>
2145	<DD><CODE>java.rmi.RemoteException</CODE>
2146	<DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></CODE><DT><B>See Also:</B><DD><a href="http://drc-dev.ohiolink.edu/browser/elated-core/tags/upstream/src/org/acs/elated/fed/FedoraAccess.java?rev=76&format=txt">FedoraAccess.java</a>,
2147	<a href="http://drc-dev.ohiolink.edu/browser/elated-core/trunk/WEB-INF/src/org/acs/elated/fed/MaAPI.java?rev=275">MaAPI</a>,
2148	<a href="http://www.fedora.info/download/2.2.1/javadocs/fedora/server/types/gen/Condition.html">Fedora server type Condition.java</a>,
2149	<a href="http://source.uhi.ac.uk/fisheye/browse/svn/ctrep/trunk/fedora-ws-clients/testapp/testsrc/fedora/webservices/client/api/a/test/Search.java?r1=133&r2=165">Fedora client test Search.java</a></DL>
2150	</DD>
2151	</DL>
2152	<HR>
2153
2154	<A NAME="getDocName(java.lang.String)"><!-- --></A><H3>
2155	getDocName</H3>
2156	<PRE>
2157	public java.lang.String <B>getDocName</B>(java.lang.String docPID)</PRE>
2158	<DL>
2159	<DD><DL>
2160	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getDocName(java.lang.String)">getDocName</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2161	</DD>
2162	<DD><DL>
2163	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - pid of a greenstone document in the fedora repository.
2164	<DT><B>Returns:</B><DD>the <docName> in the parameter docPID (which is of the form:
2165	greenstone:<colname>-<docName>)</DL>
2166	</DD>
2167	</DL>
2168	<HR>
2169
2170	<A NAME="getCollectionName(java.lang.String)"><!-- --></A><H3>
2171	getCollectionName</H3>
2172	<PRE>
2173	public java.lang.String <B>getCollectionName</B>(java.lang.String collPID)</PRE>
2174	<DL>
2175	<DD><DL>
2176	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getCollectionName(java.lang.String)">getCollectionName</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2177	</DD>
2178	<DD><DL>
2179	<DT><B>Parameters:</B><DD><CODE>collPID</CODE> - - pid of a greenstone collection in the fedora repository.
2180	<DT><B>Returns:</B><DD>the <name> in the parameter collPID
2181	(greenstone:<name>-collection)
2182	If collPID is a docPID, this method does the same: return the <name>
2183	in the docPID (greenstone:<name>-docID).</DL>
2184	</DD>
2185	</DL>
2186	<HR>
2187
2188	<A NAME="getSubstructure(org.w3c.dom.Element, boolean)"><!-- --></A><H3>
2189	getSubstructure</H3>
2190	<PRE>
2191	protected org.w3c.dom.Element <B>getSubstructure</B>(org.w3c.dom.Element e,
2192	boolean descendents)</PRE>
2193	<DL>
2194	<DD>Convert the given Element to a String representing the same XML.
2195	<P>
2196	<DD><DL>
2197	</DL>
2198	</DD>
2199	<DD><DL>
2200	<DT><B>Parameters:</B><DD><CODE>e</CODE> - - the element to start copying from.<DD><CODE>descendents</CODE> - - if true, e is copied with all its descendetns into the
2201	element that's returned. If false, only e and its direct children are copied
2202	<DT><B>Returns:</B><DD>an element containing a copy element e with either only its child
2203	elements or with all its descendents (depending on whether parameter
2204	descendents is true or false).<DT><B>See Also:</B><DD><a href="http://forum.java.sun.com/thread.jspa?threadID=678472&tstart=30">Sun java thread on transforming a DOM XML to a String</a></DL>
2205	</DD>
2206	</DL>
2207	<HR>
2208
2209	<A NAME="getItem(java.lang.String, java.lang.String)"><!-- --></A><H3>
2210	getItem</H3>
2211	<PRE>
2212	protected java.lang.String <B>getItem</B>(java.lang.String docPID,
2213	java.lang.String itemID)
2214	throws java.rmi.RemoteException,
2215	java.io.UnsupportedEncodingException</PRE>
2216	<DL>
2217	<DD>Return a datastream of a document, given the document's id
2218	and the item id of the datastream which is to be retrieved.
2219	<P>
2220	<DD><DL>
2221	</DL>
2222	</DD>
2223	<DD><DL>
2224	<DT><B>Parameters:</B><DD><CODE>docPID</CODE> - - pid of a greenstone document in the fedora repository.<DD><CODE>itemID</CODE> - - the itemID of a datastream of the fedora object
2225	identified by docPID.
2226	<DT><B>Returns:</B><DD>the XML (in String form) of the item denoted by itemID
2227	that's part of the fedora data object denoted by docPID.
2228	itemID may be something like EX.2.1/EX2.3.3 or SECTION1.4.3
2229	Can't retrieve images denoted by itemID using this method, only items
2230	that are of XML format.
2231	<DT><B>Throws:</B>
2232	<DD><CODE>java.rmi.RemoteException</CODE>
2233	<DD><CODE>java.io.UnsupportedEncodingException</CODE></DL>
2234	</DD>
2235	</DL>
2236	<HR>
2237
2238	<A NAME="removePrefix(java.lang.String, java.lang.String)"><!-- --></A><H3>
2239	removePrefix</H3>
2240	<PRE>
2241	protected java.lang.String <B>removePrefix</B>(java.lang.String str,
2242	java.lang.String prefix)</PRE>
2243	<DL>
2244	<DD>Given something like str="SECTION1.2.1" and prefix="SECTION" this method
2245	returns "1.2.1".
2246	The exception is that for cases like EX.2.1, which ought to have been EX1.2.1,
2247	this method would return "1.2.1". Similarly, DC.2.1 would return "1.2.1".
2248	However, the string str is returned unchanged if the prefix does not occur
2249	at the start of str.
2250	<P>
2251	<DD><DL>
2252	</DL>
2253	</DD>
2254	<DD><DL>
2255	<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - - the prefix which ought to be removed from the itemID.<DD><CODE>str</CODE> - - the value of the itemID.
2256	<DT><B>Returns:</B><DD>the String parameter str without the prefix.
2257	It can be used to return the number of an itemID of a greenstone document
2258	stored in the fedora repository without the given prefix.</DL>
2259	</DD>
2260	</DL>
2261	<HR>
2262
2263	<A NAME="convertToMetaNumber(java.lang.String)"><!-- --></A><H3>
2264	convertToMetaNumber</H3>
2265	<PRE>
2266	protected java.lang.String <B>convertToMetaNumber</B>(java.lang.String number)</PRE>
2267	<DL>
2268	<DD>Given a number of the form x(.y.z), this method returns this number
2269	as is, except when x = 1, in which case, it would return .y.z
2270	That is, given number=3.2.1, this method would return 3.2.1
2271	But, given number=1.2.3, this method would return .2.3.
2272	When number=1, it is NOT a special case: "" is returned as explained.
2273	<P>
2274	<DD><DL>
2275	</DL>
2276	</DD>
2277	<DD><DL>
2278	<DT><B>Parameters:</B><DD><CODE>number</CODE> - - a proper (fedora-greenstone document) section number
2279	<DT><B>Returns:</B><DD>the same number as it ought to be for the associated EX, DC datastreama.</DL>
2280	</DD>
2281	</DL>
2282	<HR>
2283
2284	<A NAME="getBaseURL()"><!-- --></A><H3>
2285	getBaseURL</H3>
2286	<PRE>
2287	public java.lang.String <B>getBaseURL</B>()</PRE>
2288	<DL>
2289	<DD><DL>
2290	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getBaseURL()">getBaseURL</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2291	</DD>
2292	<DD><DL>
2293
2294	<DT><B>Returns:</B><DD>fedora's baseURL. It's of the form
2295	"http://localhost:8080/fedora"</DL>
2296	</DD>
2297	</DL>
2298	<HR>
2299
2300	<A NAME="getPortAddressURL()"><!-- --></A><H3>
2301	getPortAddressURL</H3>
2302	<PRE>
2303	public java.lang.String <B>getPortAddressURL</B>()</PRE>
2304	<DL>
2305	<DD><DL>
2306	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getPortAddressURL()">getPortAddressURL</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2307	</DD>
2308	<DD><DL>
2309
2310	<DT><B>Returns:</B><DD>the portAddressURL (in use) of the Fedora APIA
2311	web service (should be the endpoint location in the APIA's
2312	WSDL file).
2313	It's usually of the form baseURL+"/services/access"</DL>
2314	</DD>
2315	</DL>
2316	<HR>
2317
2318	<A NAME="getAssocFileBaseURL()"><!-- --></A><H3>
2319	getAssocFileBaseURL</H3>
2320	<PRE>
2321	public java.lang.String <B>getAssocFileBaseURL</B>()</PRE>
2322	<DL>
2323	<DD><DL>
2324	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html#getAssocFileBaseURL()">getAssocFileBaseURL</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></CODE></DL>
2325	</DD>
2326	<DD><DL>
2327
2328	<DT><B>Returns:</B><DD>the baseURL for gsdlAssocFiles</DL>
2329	</DD>
2330	</DL>
2331	<HR>
2332
2333	<A NAME="main(java.lang.String[])"><!-- --></A><H3>
2334	main</H3>
2335	<PRE>
2336	public static void <B>main</B>(java.lang.String[] args)</PRE>
2337	<DL>
2338	<DD><DL>
2339	</DL>
2340	</DD>
2341	<DD><DL>
2342	</DL>
2343	</DD>
2344	</DL>
2345	<!-- ========= END OF CLASS DATA ========= -->
2346	<HR>
2347
2348
2349	<!-- ======= START OF BOTTOM NAVBAR ====== -->
2350	<A NAME="navbar_bottom"><!-- --></A>
2351	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
2352	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
2353	<TR>
2354	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
2355	<A NAME="navbar_bottom_firstrow"><!-- --></A>
2356	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
2357	<TR ALIGN="center" VALIGN="top">
2358	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/greenstone/fedora/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
2359	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
2360	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
2361	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
2362	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
2363	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
2364	</TR>
2365	</TABLE>
2366	</TD>
2367	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
2368	</EM>
2369	</TD>
2370	</TR>
2371
2372	<TR>
2373	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
2374	<A HREF="../../../../org/greenstone/fedora/services/FedoraCommons.html" title="class in org.greenstone.fedora.services"><B>PREV CLASS</B></A>
2375	<A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Connection.html" title="class in org.greenstone.fedora.services"><B>NEXT CLASS</B></A></FONT></TD>
2376	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
2377	<A HREF="../../../../index.html?org/greenstone/fedora/services/FedoraConnection.html" target="_top"><B>FRAMES</B></A>
2378	<A HREF="FedoraConnection.html" target="_top"><B>NO FRAMES</B></A>
2379	<SCRIPT type="text/javascript">
2380	<!--
2381	if(window==top) {
2382	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
2383	}
2384	//-->
2385	</SCRIPT>
2386	<NOSCRIPT>
2387	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
2388	</NOSCRIPT>
2389
2390
2391	</FONT></TD>
2392	</TR>
2393	<TR>
2394	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2395	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
2396	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
2397	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
2398	</TR>
2399	</TABLE>
2400	<A NAME="skip-navbar_bottom"></A>
2401	<!-- ======== END OF BOTTOM NAVBAR ======= -->
2402
2403	<HR>
2404
2405	</BODY>
2406	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: