source: other-projects/trunk/gs3-webservices-democlient/docs/GS3DemoClient/org/greenstone/gs3client/GS3JavaClient.html@ 15222

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

Greenstone3 web services demo-clientadded to GS3's other-projects
File size: 62.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 Sun Apr 27 20:47:17 NZST 2008 -->
6<TITLE>
7GS3JavaClient
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.GS3JavaClient class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="GS3JavaClient";
18}
19</SCRIPT>
20<NOSCRIPT>
21</NOSCRIPT>
22
23</HEAD>
24
25<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28<!-- ========= START OF TOP NAVBAR ======= -->
29<A NAME="navbar_top"><!-- --></A>
30<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32<TR>
33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34<A NAME="navbar_top_firstrow"><!-- --></A>
35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45</TABLE>
46</TD>
47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48</EM>
49</TD>
50</TR>
51
52<TR>
53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54&nbsp;<A HREF="../../../org/greenstone/gs3client/GraphPaperLayout.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../org/greenstone/gs3client/GS3JavaClient.PasswordAuthenticator.html" title="class in org.greenstone.gs3client"><B>NEXT CLASS</B></A></FONT></TD>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../index.html?org/greenstone/gs3client/GS3JavaClient.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="GS3JavaClient.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59&nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
63 }
64 //-->
65</SCRIPT>
66<NOSCRIPT>
67 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
68</NOSCRIPT>
69
70
71</FONT></TD>
72</TR>
73<TR>
74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
78</TR>
79</TABLE>
80<A NAME="skip-navbar_top"></A>
81<!-- ========= END OF TOP NAVBAR ========= -->
82
83<HR>
84<!-- ======== START OF CLASS DATA ======== -->
85<H2>
86<FONT SIZE="-1">
87org.greenstone.gs3client</FONT>
88<BR>
89Class GS3JavaClient</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.awt.Component
93 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.awt.Container
94 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.awt.Window
95 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.awt.Frame
96 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">javax.swing.JFrame
97 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.GS3JavaClient</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD>java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants</DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>GS3JavaClient</B><DT>extends javax.swing.JFrame<DT>implements java.awt.event.ActionListener</DL>
105</PRE>
106
107<P>
108The main Javaclient class. Creates the main window containing:
109 - the radio button group for making either Greenstone 3 or Fedora the active DL.
110 - the comboboxes for selecting the collection and the service therein
111 - three panes - for executing queries, viewing search results and browsing.
112<P>
113
114<P>
115<DL>
116<DT><B>Author:</B></DT>
117 <DD>ak19</DD>
118<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.greenstone.gs3client.GS3JavaClient">Serialized Form</A></DL>
119<HR>
120
121<P>
122<!-- ======== NESTED CLASS SUMMARY ======== -->
123
124<A NAME="nested_class_summary"><!-- --></A>
125<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
128<B>Nested Class Summary</B></FONT></TH>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132<CODE>(package private) static&nbsp;class</CODE></FONT></TD>
133<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.PasswordAuthenticator.html" title="class in org.greenstone.gs3client">GS3JavaClient.PasswordAuthenticator</A></B></CODE>
134
135<BR>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inner class that handles authentication for any sites (urls, etc.)
137 that require it.</TD>
138</TR>
139</TABLE>
140&nbsp;<A NAME="nested_classes_inherited_from_class_javax.swing.JFrame"><!-- --></A>
141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
142<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
143<TH ALIGN="left"><B>Nested classes/interfaces inherited from class javax.swing.JFrame</B></TH>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD><CODE>javax.swing.JFrame.AccessibleJFrame</CODE></TD>
147</TR>
148</TABLE>
149&nbsp;
150<A NAME="nested_classes_inherited_from_class_java.awt.Frame"><!-- --></A>
151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
152<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
153<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.awt.Frame</B></TH>
154</TR>
155<TR BGCOLOR="white" CLASS="TableRowColor">
156<TD><CODE>java.awt.Frame.AccessibleAWTFrame</CODE></TD>
157</TR>
158</TABLE>
159&nbsp;
160<A NAME="nested_classes_inherited_from_class_java.awt.Window"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
163<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.awt.Window</B></TH>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD><CODE>java.awt.Window.AccessibleAWTWindow</CODE></TD>
167</TR>
168</TABLE>
169&nbsp;
170<A NAME="nested_classes_inherited_from_class_java.awt.Container"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
173<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.awt.Container</B></TH>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD><CODE>java.awt.Container.AccessibleAWTContainer</CODE></TD>
177</TR>
178</TABLE>
179&nbsp;
180<A NAME="nested_classes_inherited_from_class_java.awt.Component"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
183<TH ALIGN="left"><B>Nested classes/interfaces inherited from class java.awt.Component</B></TH>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD><CODE>java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy</CODE></TD>
187</TR>
188</TABLE>
189&nbsp;
190<!-- =========== FIELD SUMMARY =========== -->
191
192<A NAME="field_summary"><!-- --></A>
193<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
194<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
195<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
196<B>Field Summary</B></FONT></TH>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
200<CODE>protected &nbsp;int</CODE></FONT></TD>
201<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#activity">activity</A></B></CODE>
202
203<BR>
204&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;To keep track of whether we are searching or browsing.</TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
208<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/BrowseDisplay.html" title="class in org.greenstone.gs3client">BrowseDisplay</A></CODE></FONT></TD>
209<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#browsePanel">browsePanel</A></B></CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/data/BrowseResponseData.html" title="class in org.greenstone.gs3client.data">BrowseResponseData</A></CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#browseResponseObject">browseResponseObject</A></B></CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Object that stores the data of a browse response XML message
221 (response for classification hierarchies)</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>static&nbsp;int</CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#BROWSING">BROWSING</A></B></CODE>
227
228<BR>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The value of the BROWSING activity</TD>
230</TR>
231<TR BGCOLOR="white" CLASS="TableRowColor">
232<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233<CODE>protected &nbsp;javax.swing.JComboBox</CODE></FONT></TD>
234<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#collBox">collBox</A></B></CODE>
235
236<BR>
237&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241<CODE>protected &nbsp;javax.swing.JTextField</CODE></FONT></TD>
242<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#collectionNameField">collectionNameField</A></B></CODE>
243
244<BR>
245&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
246</TR>
247<TR BGCOLOR="white" CLASS="TableRowColor">
248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
249<CODE>protected &nbsp;javax.swing.JButton</CODE></FONT></TD>
250<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#collInfoButton">collInfoButton</A></B></CODE>
251
252<BR>
253&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
254</TR>
255<TR BGCOLOR="white" CLASS="TableRowColor">
256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
257<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
258<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#colName">colName</A></B></CODE>
259
260<BR>
261&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The currently selected collection</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#dlAPIA">dlAPIA</A></B></CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reference to a digital library instance (Greenstone 3 or Fedora) that
270 allows this client to execute services offered by the digital library</TD>
271</TR>
272<TR BGCOLOR="white" CLASS="TableRowColor">
273<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
274<CODE>protected &nbsp;javax.swing.JComboBox</CODE></FONT></TD>
275<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#dlChooser">dlChooser</A></B></CODE>
276
277<BR>
278&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
279</TR>
280<TR BGCOLOR="white" CLASS="TableRowColor">
281<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282<CODE>protected static&nbsp;java.lang.String[]</CODE></FONT></TD>
283<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#dlOptions">dlOptions</A></B></CODE>
284
285<BR>
286&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
287</TR>
288<TR BGCOLOR="white" CLASS="TableRowColor">
289<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
290<CODE>protected static&nbsp;boolean</CODE></FONT></TD>
291<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#executableServicesOnly">executableServicesOnly</A></B></CODE>
292
293<BR>
294&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;we want to display a drop-down box for the services available,
295 but only Services that can be executed (searching and browsing)</TD>
296</TR>
297<TR BGCOLOR="white" CLASS="TableRowColor">
298<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
299<CODE>protected static&nbsp;int</CODE></FONT></TD>
300<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#FEDORA">FEDORA</A></B></CODE>
301
302<BR>
303&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
304</TR>
305<TR BGCOLOR="white" CLASS="TableRowColor">
306<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
307<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices">FedoraServicesAPIA</A></CODE></FONT></TD>
308<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#fedoraDL">fedoraDL</A></B></CODE>
309
310<BR>
311&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reference to the object that interacts with the FedoraGS3.jar component</TD>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
315<CODE>protected static&nbsp;int</CODE></FONT></TD>
316<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#GREENSTONE">GREENSTONE</A></B></CODE>
317
318<BR>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
320</TR>
321<TR BGCOLOR="white" CLASS="TableRowColor">
322<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
323<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices">GS3ServicesAPIA</A></CODE></FONT></TD>
324<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#greenstoneDL">greenstoneDL</A></B></CODE>
325
326<BR>
327&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reference to the object that interacts with Greenstone3's web services</TD>
328</TR>
329<TR BGCOLOR="white" CLASS="TableRowColor">
330<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
331<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
332<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#lang">lang</A></B></CODE>
333
334<BR>
335&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Preferred language of display items in responses.</TD>
336</TR>
337<TR BGCOLOR="white" CLASS="TableRowColor">
338<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339<CODE>(package private) static&nbsp;org.apache.log4j.Logger</CODE></FONT></TD>
340<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#LOG">LOG</A></B></CODE>
341
342<BR>
343&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Logger for this class</TD>
344</TR>
345<TR BGCOLOR="white" CLASS="TableRowColor">
346<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347<CODE>protected &nbsp;javax.swing.JTextField</CODE></FONT></TD>
348<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#nonProxyHostNamesField">nonProxyHostNamesField</A></B></CODE>
349
350<BR>
351&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
352</TR>
353<TR BGCOLOR="white" CLASS="TableRowColor">
354<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
355<CODE>protected &nbsp;javax.swing.JTextField</CODE></FONT></TD>
356<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#proxyhostField">proxyhostField</A></B></CODE>
357
358<BR>
359&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
360</TR>
361<TR BGCOLOR="white" CLASS="TableRowColor">
362<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
363<CODE>protected &nbsp;javax.swing.JTextField</CODE></FONT></TD>
364<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#proxyportField">proxyportField</A></B></CODE>
365
366<BR>
367&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
368</TR>
369<TR BGCOLOR="white" CLASS="TableRowColor">
370<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
371<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/QueryForm.html" title="class in org.greenstone.gs3client">QueryForm</A></CODE></FONT></TD>
372<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#queryPanel">queryPanel</A></B></CODE>
373
374<BR>
375&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
376</TR>
377<TR BGCOLOR="white" CLASS="TableRowColor">
378<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
379<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/data/QueryResponseData.html" title="class in org.greenstone.gs3client.data">QueryResponseData</A></CODE></FONT></TD>
380<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#queryResponseObj">queryResponseObj</A></B></CODE>
381
382<BR>
383&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Object that stores the data of a query response XML message</TD>
384</TR>
385<TR BGCOLOR="white" CLASS="TableRowColor">
386<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
387<CODE>protected &nbsp;javax.swing.JButton</CODE></FONT></TD>
388<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#searchButton">searchButton</A></B></CODE>
389
390<BR>
391&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
392</TR>
393<TR BGCOLOR="white" CLASS="TableRowColor">
394<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
395<CODE>static&nbsp;int</CODE></FONT></TD>
396<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#SEARCHING">SEARCHING</A></B></CODE>
397
398<BR>
399&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The value of the SEARCHING activity</TD>
400</TR>
401<TR BGCOLOR="white" CLASS="TableRowColor">
402<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
403<CODE>protected &nbsp;javax.swing.JPanel</CODE></FONT></TD>
404<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#searchPanel">searchPanel</A></B></CODE>
405
406<BR>
407&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
408</TR>
409<TR BGCOLOR="white" CLASS="TableRowColor">
410<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
411<CODE>protected &nbsp;<A HREF="../../../org/greenstone/gs3client/SearchResultsDisplay.html" title="class in org.greenstone.gs3client">SearchResultsDisplay</A></CODE></FONT></TD>
412<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#searchResultsDisplay">searchResultsDisplay</A></B></CODE>
413
414<BR>
415&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
416</TR>
417<TR BGCOLOR="white" CLASS="TableRowColor">
418<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419<CODE>protected &nbsp;javax.swing.JTextArea</CODE></FONT></TD>
420<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#searchSummary">searchSummary</A></B></CODE>
421
422<BR>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
424</TR>
425<TR BGCOLOR="white" CLASS="TableRowColor">
426<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
427<CODE>protected static&nbsp;int</CODE></FONT></TD>
428<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#SELECT">SELECT</A></B></CODE>
429
430<BR>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
432</TR>
433<TR BGCOLOR="white" CLASS="TableRowColor">
434<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435<CODE>protected &nbsp;javax.swing.JComboBox</CODE></FONT></TD>
436<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#serviceBox">serviceBox</A></B></CODE>
437
438<BR>
439&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
440</TR>
441<TR BGCOLOR="white" CLASS="TableRowColor">
442<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
443<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
444<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#serviceName">serviceName</A></B></CODE>
445
446<BR>
447&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The currently selected service</TD>
448</TR>
449<TR BGCOLOR="white" CLASS="TableRowColor">
450<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
451<CODE>protected &nbsp;javax.swing.JButton</CODE></FONT></TD>
452<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#setProxySettings">setProxySettings</A></B></CODE>
453
454<BR>
455&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
456</TR>
457<TR BGCOLOR="white" CLASS="TableRowColor">
458<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
459<CODE>protected &nbsp;javax.swing.JTabbedPane</CODE></FONT></TD>
460<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#tabbedPane">tabbedPane</A></B></CODE>
461
462<BR>
463&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
464</TR>
465</TABLE>
466&nbsp;<A NAME="fields_inherited_from_class_javax.swing.JFrame"><!-- --></A>
467<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
468<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
469<TH ALIGN="left"><B>Fields inherited from class javax.swing.JFrame</B></TH>
470</TR>
471<TR BGCOLOR="white" CLASS="TableRowColor">
472<TD><CODE>accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled</CODE></TD>
473</TR>
474</TABLE>
475&nbsp;<A NAME="fields_inherited_from_class_java.awt.Frame"><!-- --></A>
476<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
477<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
478<TH ALIGN="left"><B>Fields inherited from class java.awt.Frame</B></TH>
479</TR>
480<TR BGCOLOR="white" CLASS="TableRowColor">
481<TD><CODE>CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR</CODE></TD>
482</TR>
483</TABLE>
484&nbsp;<A NAME="fields_inherited_from_class_java.awt.Component"><!-- --></A>
485<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
486<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
487<TH ALIGN="left"><B>Fields inherited from class java.awt.Component</B></TH>
488</TR>
489<TR BGCOLOR="white" CLASS="TableRowColor">
490<TD><CODE>BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT</CODE></TD>
491</TR>
492</TABLE>
493&nbsp;<A NAME="fields_inherited_from_class_javax.swing.WindowConstants"><!-- --></A>
494<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
495<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
496<TH ALIGN="left"><B>Fields inherited from interface javax.swing.WindowConstants</B></TH>
497</TR>
498<TR BGCOLOR="white" CLASS="TableRowColor">
499<TD><CODE>DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE</CODE></TD>
500</TR>
501</TABLE>
502&nbsp;<A NAME="fields_inherited_from_class_java.awt.image.ImageObserver"><!-- --></A>
503<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
504<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
505<TH ALIGN="left"><B>Fields inherited from interface java.awt.image.ImageObserver</B></TH>
506</TR>
507<TR BGCOLOR="white" CLASS="TableRowColor">
508<TD><CODE>ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH</CODE></TD>
509</TR>
510</TABLE>
511&nbsp;
512<!-- ======== CONSTRUCTOR SUMMARY ======== -->
513
514<A NAME="constructor_summary"><!-- --></A>
515<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
516<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
517<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
518<B>Constructor Summary</B></FONT></TH>
519</TR>
520<TR BGCOLOR="white" CLASS="TableRowColor">
521<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#GS3JavaClient()">GS3JavaClient</A></B>()</CODE>
522
523<BR>
524&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor that creates and initialises this main
525 window and its internal GUI components</TD>
526</TR>
527</TABLE>
528&nbsp;
529<!-- ========== METHOD SUMMARY =========== -->
530
531<A NAME="method_summary"><!-- --></A>
532<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
533<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
534<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
535<B>Method Summary</B></FONT></TH>
536</TR>
537<TR BGCOLOR="white" CLASS="TableRowColor">
538<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
539<CODE>&nbsp;void</CODE></FONT></TD>
540<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#actionPerformed(java.awt.event.ActionEvent)">actionPerformed</A></B>(java.awt.event.ActionEvent&nbsp;e)</CODE>
541
542<BR>
543&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Event handler for actionEvents such as a change in the active digital
544 library, a collection being selected in the dropdown box or the collection
545 -Info button being pressed, or a service being selected in the service
546 dropdown box (browsing or searching).</TD>
547</TR>
548<TR BGCOLOR="white" CLASS="TableRowColor">
549<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
550<CODE>protected &nbsp;void</CODE></FONT></TD>
551<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#changeDL(org.greenstone.gs3client.dlservices.DigitalLibraryServicesAPIA)">changeDL</A></B>(<A HREF="../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A>&nbsp;dl)</CODE>
552
553<BR>
554&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method that is called when the user chooses to change the active
555 digital library (between Greenstone3 and Fedora).</TD>
556</TR>
557<TR BGCOLOR="white" CLASS="TableRowColor">
558<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
559<CODE>&nbsp;void</CODE></FONT></TD>
560<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#changeUIColour(int)">changeUIColour</A></B>(int&nbsp;DL)</CODE>
561
562<BR>
563&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Changes the background colours of the client's user interface
564 based on what the active digital library is.</TD>
565</TR>
566<TR BGCOLOR="white" CLASS="TableRowColor">
567<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
568<CODE>protected &nbsp;boolean</CODE></FONT></TD>
569<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#createFedoraDLConnection()">createFedoraDLConnection</A></B>()</CODE>
570
571<BR>
572&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempts to establish a connection to FedoraGS3.jar and instantiate
573 a FedoraServicesAPIA object and store it in the member variable fedoraDL.</TD>
574</TR>
575<TR BGCOLOR="white" CLASS="TableRowColor">
576<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
577<CODE>protected &nbsp;boolean</CODE></FONT></TD>
578<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#createGreenstoneDLConnection()">createGreenstoneDLConnection</A></B>()</CODE>
579
580<BR>
581&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attempts to establish a connection to GS3 Web services and instantiate
582 a GS3ServicesAPIA object and store it in the member variable greenstoneDL.</TD>
583</TR>
584<TR BGCOLOR="white" CLASS="TableRowColor">
585<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
586<CODE>&nbsp;void</CODE></FONT></TD>
587<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#doBrowse(org.greenstone.gs3client.BrowseDisplay.ClassifierData)">doBrowse</A></B>(<A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html" title="class in org.greenstone.gs3client">BrowseDisplay.ClassifierData</A>&nbsp;classifier)</CODE>
588
589<BR>
590&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given a ClassifierData object indicating what browsing category
591 was chosen, this method will retrieve all its descendants in the
592 hierarchy.</TD>
593</TR>
594<TR BGCOLOR="white" CLASS="TableRowColor">
595<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
596<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
597<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#getBaseURL()">getBaseURL</A></B>()</CODE>
598
599<BR>
600&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
601</TR>
602<TR BGCOLOR="white" CLASS="TableRowColor">
603<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
604<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
605<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#getFilePath(org.greenstone.gs3client.data.DocumentNodeData)">getFilePath</A></B>(<A HREF="../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</CODE>
606
607<BR>
608&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
609</TR>
610<TR BGCOLOR="white" CLASS="TableRowColor">
611<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
612<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
613<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#getLanguage()">getLanguage</A></B>()</CODE>
614
615<BR>
616&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
617</TR>
618<TR BGCOLOR="white" CLASS="TableRowColor">
619<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
620<CODE>protected &nbsp;org.w3c.dom.Element</CODE></FONT></TD>
621<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#getResponseAsDOM(java.lang.String, java.lang.String)">getResponseAsDOM</A></B>(java.lang.String&nbsp;debugPrefix,
622 java.lang.String&nbsp;response)</CODE>
623
624<BR>
625&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given an XML response string, returns the root document (element)
626 representing its DOM form.</TD>
627</TR>
628<TR BGCOLOR="white" CLASS="TableRowColor">
629<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
630<CODE>static&nbsp;void</CODE></FONT></TD>
631<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
632
633<BR>
634&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The main method of the GS3 java-client application.</TD>
635</TR>
636<TR BGCOLOR="white" CLASS="TableRowColor">
637<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
638<CODE>&nbsp;void</CODE></FONT></TD>
639<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#performSearch(java.util.HashMap)">performSearch</A></B>(java.util.HashMap&nbsp;nameValParamsMap)</CODE>
640
641<BR>
642&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the instance of the QueryForm class when the user has
643 pressed the queryPanel's search button to execute a query.</TD>
644</TR>
645<TR BGCOLOR="white" CLASS="TableRowColor">
646<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
647<CODE>&nbsp;void</CODE></FONT></TD>
648<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#retrieveAllMetadataFor(org.greenstone.gs3client.data.DocumentNodeData)">retrieveAllMetadataFor</A></B>(<A HREF="../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</CODE>
649
650<BR>
651&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs a docMetadataRetrieve message request for the docNode
652 iff the metadata for that docNode is not already set.</TD>
653</TR>
654<TR BGCOLOR="white" CLASS="TableRowColor">
655<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
656<CODE>&nbsp;void</CODE></FONT></TD>
657<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#retrieveContentFor(org.greenstone.gs3client.data.DocumentNodeData)">retrieveContentFor</A></B>(<A HREF="../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</CODE>
658
659<BR>
660&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs a docMetadataRetrieve message request for the docNode
661 iff the nodeContent for that docNode is not already set.</TD>
662</TR>
663<TR BGCOLOR="white" CLASS="TableRowColor">
664<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
665<CODE>&nbsp;void</CODE></FONT></TD>
666<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#retrieveTitledStructureFor(org.greenstone.gs3client.data.ClassifierNodeData)">retrieveTitledStructureFor</A></B>(<A HREF="../../../org/greenstone/gs3client/data/ClassifierNodeData.html" title="class in org.greenstone.gs3client.data">ClassifierNodeData</A>&nbsp;classNode)</CODE>
667
668<BR>
669&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given a ClassifierNodeData object for browsing, this method will
670 set the classNode's children (previously retrieved) and retrieve
671 all the children's metadata including the title.</TD>
672</TR>
673<TR BGCOLOR="white" CLASS="TableRowColor">
674<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
675<CODE>&nbsp;void</CODE></FONT></TD>
676<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#retrieveTitledStructureFor(org.greenstone.gs3client.data.DocumentNodeData)">retrieveTitledStructureFor</A></B>(<A HREF="../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</CODE>
677
678<BR>
679&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs a structureRetrieve and title metadata retrieve message-
680 request for the docNode, but only iff the structure and title for
681 that docNode is not already set.</TD>
682</TR>
683<TR BGCOLOR="white" CLASS="TableRowColor">
684<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
685<CODE>&nbsp;void</CODE></FONT></TD>
686<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/GS3JavaClient.html#setLanguage(java.lang.String)">setLanguage</A></B>(java.lang.String&nbsp;lang)</CODE>
687
688<BR>
689&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the preferred language of the display items</TD>
690</TR>
691</TABLE>
692&nbsp;<A NAME="methods_inherited_from_class_javax.swing.JFrame"><!-- --></A>
693<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
694<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
695<TH ALIGN="left"><B>Methods inherited from class javax.swing.JFrame</B></TH>
696</TR>
697<TR BGCOLOR="white" CLASS="TableRowColor">
698<TD><CODE>addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update</CODE></TD>
699</TR>
700</TABLE>
701&nbsp;<A NAME="methods_inherited_from_class_java.awt.Frame"><!-- --></A>
702<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
703<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
704<TH ALIGN="left"><B>Methods inherited from class java.awt.Frame</B></TH>
705</TR>
706<TR BGCOLOR="white" CLASS="TableRowColor">
707<TD><CODE>addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated</CODE></TD>
708</TR>
709</TABLE>
710&nbsp;<A NAME="methods_inherited_from_class_java.awt.Window"><!-- --></A>
711<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
712<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
713<TH ALIGN="left"><B>Methods inherited from class java.awt.Window</B></TH>
714</TR>
715<TR BGCOLOR="white" CLASS="TableRowColor">
716<TD><CODE>addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, show, toBack, toFront</CODE></TD>
717</TR>
718</TABLE>
719&nbsp;<A NAME="methods_inherited_from_class_java.awt.Container"><!-- --></A>
720<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
721<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
722<TH ALIGN="left"><B>Methods inherited from class java.awt.Container</B></TH>
723</TR>
724<TR BGCOLOR="white" CLASS="TableRowColor">
725<TD><CODE>add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree</CODE></TD>
726</TR>
727</TABLE>
728&nbsp;<A NAME="methods_inherited_from_class_java.awt.Component"><!-- --></A>
729<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
730<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
731<TH ALIGN="left"><B>Methods inherited from class java.awt.Component</B></TH>
732</TR>
733<TR BGCOLOR="white" CLASS="TableRowColor">
734<TD><CODE>action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle</CODE></TD>
735</TR>
736</TABLE>
737&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
738<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
739<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
740<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
741</TR>
742<TR BGCOLOR="white" CLASS="TableRowColor">
743<TD><CODE>clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
744</TR>
745</TABLE>
746&nbsp;<A NAME="methods_inherited_from_class_java.awt.MenuContainer"><!-- --></A>
747<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
748<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
749<TH ALIGN="left"><B>Methods inherited from interface java.awt.MenuContainer</B></TH>
750</TR>
751<TR BGCOLOR="white" CLASS="TableRowColor">
752<TD><CODE>getFont, postEvent</CODE></TD>
753</TR>
754</TABLE>
755&nbsp;
756<P>
757
758<!-- ============ FIELD DETAIL =========== -->
759
760<A NAME="field_detail"><!-- --></A>
761<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
762<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
763<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
764<B>Field Detail</B></FONT></TH>
765</TR>
766</TABLE>
767
768<A NAME="LOG"><!-- --></A><H3>
769LOG</H3>
770<PRE>
771static org.apache.log4j.Logger <B>LOG</B></PRE>
772<DL>
773<DD>The Logger for this class
774<P>
775<DL>
776</DL>
777</DL>
778<HR>
779
780<A NAME="SEARCHING"><!-- --></A><H3>
781SEARCHING</H3>
782<PRE>
783public static int <B>SEARCHING</B></PRE>
784<DL>
785<DD>The value of the SEARCHING activity
786<P>
787<DL>
788</DL>
789</DL>
790<HR>
791
792<A NAME="BROWSING"><!-- --></A><H3>
793BROWSING</H3>
794<PRE>
795public static int <B>BROWSING</B></PRE>
796<DL>
797<DD>The value of the BROWSING activity
798<P>
799<DL>
800</DL>
801</DL>
802<HR>
803
804<A NAME="executableServicesOnly"><!-- --></A><H3>
805executableServicesOnly</H3>
806<PRE>
807protected static final boolean <B>executableServicesOnly</B></PRE>
808<DL>
809<DD>we want to display a drop-down box for the services available,
810 but only Services that can be executed (searching and browsing)
811<P>
812<DL>
813<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3client.GS3JavaClient.executableServicesOnly">Constant Field Values</A></DL>
814</DL>
815<HR>
816
817<A NAME="activity"><!-- --></A><H3>
818activity</H3>
819<PRE>
820protected int <B>activity</B></PRE>
821<DL>
822<DD>To keep track of whether we are searching or browsing.
823 Value of activity can be SEARCHING OR BROWSING
824<P>
825<DL>
826</DL>
827</DL>
828<HR>
829
830<A NAME="dlAPIA"><!-- --></A><H3>
831dlAPIA</H3>
832<PRE>
833protected <A HREF="../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A> <B>dlAPIA</B></PRE>
834<DL>
835<DD>Reference to a digital library instance (Greenstone 3 or Fedora) that
836 allows this client to execute services offered by the digital library
837<P>
838<DL>
839</DL>
840</DL>
841<HR>
842
843<A NAME="greenstoneDL"><!-- --></A><H3>
844greenstoneDL</H3>
845<PRE>
846protected <A HREF="../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices">GS3ServicesAPIA</A> <B>greenstoneDL</B></PRE>
847<DL>
848<DD>Reference to the object that interacts with Greenstone3's web services
849<P>
850<DL>
851</DL>
852</DL>
853<HR>
854
855<A NAME="fedoraDL"><!-- --></A><H3>
856fedoraDL</H3>
857<PRE>
858protected <A HREF="../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices">FedoraServicesAPIA</A> <B>fedoraDL</B></PRE>
859<DL>
860<DD>Reference to the object that interacts with the FedoraGS3.jar component
861<P>
862<DL>
863</DL>
864</DL>
865<HR>
866
867<A NAME="queryResponseObj"><!-- --></A><H3>
868queryResponseObj</H3>
869<PRE>
870protected <A HREF="../../../org/greenstone/gs3client/data/QueryResponseData.html" title="class in org.greenstone.gs3client.data">QueryResponseData</A> <B>queryResponseObj</B></PRE>
871<DL>
872<DD>Object that stores the data of a query response XML message
873<P>
874<DL>
875</DL>
876</DL>
877<HR>
878
879<A NAME="browseResponseObject"><!-- --></A><H3>
880browseResponseObject</H3>
881<PRE>
882protected <A HREF="../../../org/greenstone/gs3client/data/BrowseResponseData.html" title="class in org.greenstone.gs3client.data">BrowseResponseData</A> <B>browseResponseObject</B></PRE>
883<DL>
884<DD>Object that stores the data of a browse response XML message
885 (response for classification hierarchies)
886<P>
887<DL>
888</DL>
889</DL>
890<HR>
891
892<A NAME="lang"><!-- --></A><H3>
893lang</H3>
894<PRE>
895protected java.lang.String <B>lang</B></PRE>
896<DL>
897<DD>Preferred language of display items in responses.
898 "" or "en" for English
899<P>
900<DL>
901</DL>
902</DL>
903<HR>
904
905<A NAME="colName"><!-- --></A><H3>
906colName</H3>
907<PRE>
908protected java.lang.String <B>colName</B></PRE>
909<DL>
910<DD>The currently selected collection
911<P>
912<DL>
913</DL>
914</DL>
915<HR>
916
917<A NAME="serviceName"><!-- --></A><H3>
918serviceName</H3>
919<PRE>
920protected java.lang.String <B>serviceName</B></PRE>
921<DL>
922<DD>The currently selected service
923<P>
924<DL>
925</DL>
926</DL>
927<HR>
928
929<A NAME="dlChooser"><!-- --></A><H3>
930dlChooser</H3>
931<PRE>
932protected javax.swing.JComboBox <B>dlChooser</B></PRE>
933<DL>
934<DL>
935</DL>
936</DL>
937<HR>
938
939<A NAME="proxyhostField"><!-- --></A><H3>
940proxyhostField</H3>
941<PRE>
942protected javax.swing.JTextField <B>proxyhostField</B></PRE>
943<DL>
944<DL>
945</DL>
946</DL>
947<HR>
948
949<A NAME="proxyportField"><!-- --></A><H3>
950proxyportField</H3>
951<PRE>
952protected javax.swing.JTextField <B>proxyportField</B></PRE>
953<DL>
954<DL>
955</DL>
956</DL>
957<HR>
958
959<A NAME="nonProxyHostNamesField"><!-- --></A><H3>
960nonProxyHostNamesField</H3>
961<PRE>
962protected javax.swing.JTextField <B>nonProxyHostNamesField</B></PRE>
963<DL>
964<DL>
965</DL>
966</DL>
967<HR>
968
969<A NAME="setProxySettings"><!-- --></A><H3>
970setProxySettings</H3>
971<PRE>
972protected javax.swing.JButton <B>setProxySettings</B></PRE>
973<DL>
974<DL>
975</DL>
976</DL>
977<HR>
978
979<A NAME="serviceBox"><!-- --></A><H3>
980serviceBox</H3>
981<PRE>
982protected javax.swing.JComboBox <B>serviceBox</B></PRE>
983<DL>
984<DL>
985</DL>
986</DL>
987<HR>
988
989<A NAME="collBox"><!-- --></A><H3>
990collBox</H3>
991<PRE>
992protected javax.swing.JComboBox <B>collBox</B></PRE>
993<DL>
994<DL>
995</DL>
996</DL>
997<HR>
998
999<A NAME="collInfoButton"><!-- --></A><H3>
1000collInfoButton</H3>
1001<PRE>
1002protected javax.swing.JButton <B>collInfoButton</B></PRE>
1003<DL>
1004<DL>
1005</DL>
1006</DL>
1007<HR>
1008
1009<A NAME="searchButton"><!-- --></A><H3>
1010searchButton</H3>
1011<PRE>
1012protected javax.swing.JButton <B>searchButton</B></PRE>
1013<DL>
1014<DL>
1015</DL>
1016</DL>
1017<HR>
1018
1019<A NAME="tabbedPane"><!-- --></A><H3>
1020tabbedPane</H3>
1021<PRE>
1022protected javax.swing.JTabbedPane <B>tabbedPane</B></PRE>
1023<DL>
1024<DL>
1025</DL>
1026</DL>
1027<HR>
1028
1029<A NAME="SELECT"><!-- --></A><H3>
1030SELECT</H3>
1031<PRE>
1032protected static final int <B>SELECT</B></PRE>
1033<DL>
1034<DL>
1035<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3client.GS3JavaClient.SELECT">Constant Field Values</A></DL>
1036</DL>
1037<HR>
1038
1039<A NAME="GREENSTONE"><!-- --></A><H3>
1040GREENSTONE</H3>
1041<PRE>
1042protected static final int <B>GREENSTONE</B></PRE>
1043<DL>
1044<DL>
1045<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3client.GS3JavaClient.GREENSTONE">Constant Field Values</A></DL>
1046</DL>
1047<HR>
1048
1049<A NAME="FEDORA"><!-- --></A><H3>
1050FEDORA</H3>
1051<PRE>
1052protected static final int <B>FEDORA</B></PRE>
1053<DL>
1054<DL>
1055<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3client.GS3JavaClient.FEDORA">Constant Field Values</A></DL>
1056</DL>
1057<HR>
1058
1059<A NAME="dlOptions"><!-- --></A><H3>
1060dlOptions</H3>
1061<PRE>
1062protected static final java.lang.String[] <B>dlOptions</B></PRE>
1063<DL>
1064<DL>
1065</DL>
1066</DL>
1067<HR>
1068
1069<A NAME="queryPanel"><!-- --></A><H3>
1070queryPanel</H3>
1071<PRE>
1072protected <A HREF="../../../org/greenstone/gs3client/QueryForm.html" title="class in org.greenstone.gs3client">QueryForm</A> <B>queryPanel</B></PRE>
1073<DL>
1074<DL>
1075</DL>
1076</DL>
1077<HR>
1078
1079<A NAME="collectionNameField"><!-- --></A><H3>
1080collectionNameField</H3>
1081<PRE>
1082protected javax.swing.JTextField <B>collectionNameField</B></PRE>
1083<DL>
1084<DL>
1085</DL>
1086</DL>
1087<HR>
1088
1089<A NAME="searchResultsDisplay"><!-- --></A><H3>
1090searchResultsDisplay</H3>
1091<PRE>
1092protected <A HREF="../../../org/greenstone/gs3client/SearchResultsDisplay.html" title="class in org.greenstone.gs3client">SearchResultsDisplay</A> <B>searchResultsDisplay</B></PRE>
1093<DL>
1094<DL>
1095</DL>
1096</DL>
1097<HR>
1098
1099<A NAME="searchPanel"><!-- --></A><H3>
1100searchPanel</H3>
1101<PRE>
1102protected javax.swing.JPanel <B>searchPanel</B></PRE>
1103<DL>
1104<DL>
1105</DL>
1106</DL>
1107<HR>
1108
1109<A NAME="searchSummary"><!-- --></A><H3>
1110searchSummary</H3>
1111<PRE>
1112protected javax.swing.JTextArea <B>searchSummary</B></PRE>
1113<DL>
1114<DL>
1115</DL>
1116</DL>
1117<HR>
1118
1119<A NAME="browsePanel"><!-- --></A><H3>
1120browsePanel</H3>
1121<PRE>
1122protected <A HREF="../../../org/greenstone/gs3client/BrowseDisplay.html" title="class in org.greenstone.gs3client">BrowseDisplay</A> <B>browsePanel</B></PRE>
1123<DL>
1124<DL>
1125</DL>
1126</DL>
1127
1128<!-- ========= CONSTRUCTOR DETAIL ======== -->
1129
1130<A NAME="constructor_detail"><!-- --></A>
1131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
1132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1133<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
1134<B>Constructor Detail</B></FONT></TH>
1135</TR>
1136</TABLE>
1137
1138<A NAME="GS3JavaClient()"><!-- --></A><H3>
1139GS3JavaClient</H3>
1140<PRE>
1141public <B>GS3JavaClient</B>()</PRE>
1142<DL>
1143<DD>Default constructor that creates and initialises this main
1144 window and its internal GUI components
1145<P>
1146</DL>
1147
1148<!-- ============ METHOD DETAIL ========== -->
1149
1150<A NAME="method_detail"><!-- --></A>
1151<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
1152<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1153<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
1154<B>Method Detail</B></FONT></TH>
1155</TR>
1156</TABLE>
1157
1158<A NAME="getLanguage()"><!-- --></A><H3>
1159getLanguage</H3>
1160<PRE>
1161public java.lang.String <B>getLanguage</B>()</PRE>
1162<DL>
1163<DD><DL>
1164</DL>
1165</DD>
1166<DD><DL>
1167
1168<DT><B>Returns:</B><DD>the language of the display items</DL>
1169</DD>
1170</DL>
1171<HR>
1172
1173<A NAME="setLanguage(java.lang.String)"><!-- --></A><H3>
1174setLanguage</H3>
1175<PRE>
1176public void <B>setLanguage</B>(java.lang.String&nbsp;lang)</PRE>
1177<DL>
1178<DD>Set the preferred language of the display items
1179<P>
1180<DD><DL>
1181</DL>
1182</DD>
1183<DD><DL>
1184<DT><B>Parameters:</B><DD><CODE>lang</CODE> - - the preferred language for display values</DL>
1185</DD>
1186</DL>
1187<HR>
1188
1189<A NAME="createGreenstoneDLConnection()"><!-- --></A><H3>
1190createGreenstoneDLConnection</H3>
1191<PRE>
1192protected boolean <B>createGreenstoneDLConnection</B>()</PRE>
1193<DL>
1194<DD>Attempts to establish a connection to GS3 Web services and instantiate
1195 a GS3ServicesAPIA object and store it in the member variable greenstoneDL.
1196 If it was unsuccessful, then this variable remains at null and an error
1197 message is displayed.
1198<P>
1199<DD><DL>
1200</DL>
1201</DD>
1202<DD><DL>
1203</DL>
1204</DD>
1205</DL>
1206<HR>
1207
1208<A NAME="createFedoraDLConnection()"><!-- --></A><H3>
1209createFedoraDLConnection</H3>
1210<PRE>
1211protected boolean <B>createFedoraDLConnection</B>()</PRE>
1212<DL>
1213<DD>Attempts to establish a connection to FedoraGS3.jar and instantiate
1214 a FedoraServicesAPIA object and store it in the member variable fedoraDL.
1215 If it was unsuccessful, then this variable remains at null and an error
1216 message is displayed.
1217<P>
1218<DD><DL>
1219</DL>
1220</DD>
1221<DD><DL>
1222</DL>
1223</DD>
1224</DL>
1225<HR>
1226
1227<A NAME="changeDL(org.greenstone.gs3client.dlservices.DigitalLibraryServicesAPIA)"><!-- --></A><H3>
1228changeDL</H3>
1229<PRE>
1230protected void <B>changeDL</B>(<A HREF="../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A>&nbsp;dl)</PRE>
1231<DL>
1232<DD>Method that is called when the user chooses to change the active
1233 digital library (between Greenstone3 and Fedora).
1234<P>
1235<DD><DL>
1236</DL>
1237</DD>
1238<DD><DL>
1239<DT><B>Parameters:</B><DD><CODE>dl</CODE> - is the new active digital library (the
1240 DigitalLibraryServicesAPIA object to change to).</DL>
1241</DD>
1242</DL>
1243<HR>
1244
1245<A NAME="getResponseAsDOM(java.lang.String, java.lang.String)"><!-- --></A><H3>
1246getResponseAsDOM</H3>
1247<PRE>
1248protected org.w3c.dom.Element <B>getResponseAsDOM</B>(java.lang.String&nbsp;debugPrefix,
1249 java.lang.String&nbsp;response)</PRE>
1250<DL>
1251<DD>Given an XML response string, returns the root document (element)
1252 representing its DOM form.
1253<P>
1254<DD><DL>
1255</DL>
1256</DD>
1257<DD><DL>
1258<DT><B>Parameters:</B><DD><CODE>response</CODE> - - the XML response string to be converted into
1259 its DOM form
1260<DT><B>Returns:</B><DD>the response as an XML DOM Element</DL>
1261</DD>
1262</DL>
1263<HR>
1264
1265<A NAME="actionPerformed(java.awt.event.ActionEvent)"><!-- --></A><H3>
1266actionPerformed</H3>
1267<PRE>
1268public void <B>actionPerformed</B>(java.awt.event.ActionEvent&nbsp;e)</PRE>
1269<DL>
1270<DD>Event handler for actionEvents such as a change in the active digital
1271 library, a collection being selected in the dropdown box or the collection
1272 -Info button being pressed, or a service being selected in the service
1273 dropdown box (browsing or searching).
1274<P>
1275<DD><DL>
1276<DT><B>Specified by:</B><DD><CODE>actionPerformed</CODE> in interface <CODE>java.awt.event.ActionListener</CODE></DL>
1277</DD>
1278<DD><DL>
1279</DL>
1280</DD>
1281</DL>
1282<HR>
1283
1284<A NAME="performSearch(java.util.HashMap)"><!-- --></A><H3>
1285performSearch</H3>
1286<PRE>
1287public void <B>performSearch</B>(java.util.HashMap&nbsp;nameValParamsMap)</PRE>
1288<DL>
1289<DD>Called by the instance of the QueryForm class when the user has
1290 pressed the queryPanel's search button to execute a query. Based on
1291 the user-entered values (stored in the parameter HashMap) this
1292 method will call Greenstone to process the query.
1293<P>
1294<DD><DL>
1295</DL>
1296</DD>
1297<DD><DL>
1298<DT><B>Parameters:</B><DD><CODE>nameValParamsMap</CODE> - - the query form control names with the values
1299 the user has entered for them. Example, the pair (fqv, the query string),
1300 where fqv is the form control name for the query term.</DL>
1301</DD>
1302</DL>
1303<HR>
1304
1305<A NAME="retrieveAllMetadataFor(org.greenstone.gs3client.data.DocumentNodeData)"><!-- --></A><H3>
1306retrieveAllMetadataFor</H3>
1307<PRE>
1308public void <B>retrieveAllMetadataFor</B>(<A HREF="../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</PRE>
1309<DL>
1310<DD>Performs a docMetadataRetrieve message request for the docNode
1311 iff the metadata for that docNode is not already set.
1312<P>
1313<DD><DL>
1314</DL>
1315</DD>
1316<DD><DL>
1317<DT><B>Parameters:</B><DD><CODE>docNode</CODE> - is the DocumentNodeData object for which all the
1318 metadata is to be retrieved.</DL>
1319</DD>
1320</DL>
1321<HR>
1322
1323<A NAME="retrieveContentFor(org.greenstone.gs3client.data.DocumentNodeData)"><!-- --></A><H3>
1324retrieveContentFor</H3>
1325<PRE>
1326public void <B>retrieveContentFor</B>(<A HREF="../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</PRE>
1327<DL>
1328<DD>Performs a docMetadataRetrieve message request for the docNode
1329 iff the nodeContent for that docNode is not already set.
1330<P>
1331<DD><DL>
1332</DL>
1333</DD>
1334<DD><DL>
1335<DT><B>Parameters:</B><DD><CODE>docNode</CODE> - is the DocumentNodeData object for which the content
1336 is to be retrieved.</DL>
1337</DD>
1338</DL>
1339<HR>
1340
1341<A NAME="retrieveTitledStructureFor(org.greenstone.gs3client.data.DocumentNodeData)"><!-- --></A><H3>
1342retrieveTitledStructureFor</H3>
1343<PRE>
1344public void <B>retrieveTitledStructureFor</B>(<A HREF="../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</PRE>
1345<DL>
1346<DD>Performs a structureRetrieve and title metadata retrieve message-
1347 request for the docNode, but only iff the structure and title for
1348 that docNode is not already set.
1349<P>
1350<DD><DL>
1351</DL>
1352</DD>
1353<DD><DL>
1354<DT><B>Parameters:</B><DD><CODE>docNode</CODE> - is the DocumentNodeData object for which the title
1355 is to be retrieved along with the titles of all its descendants.</DL>
1356</DD>
1357</DL>
1358<HR>
1359
1360<A NAME="doBrowse(org.greenstone.gs3client.BrowseDisplay.ClassifierData)"><!-- --></A><H3>
1361doBrowse</H3>
1362<PRE>
1363public void <B>doBrowse</B>(<A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html" title="class in org.greenstone.gs3client">BrowseDisplay.ClassifierData</A>&nbsp;classifier)</PRE>
1364<DL>
1365<DD>Given a ClassifierData object indicating what browsing category
1366 was chosen, this method will retrieve all its descendants in the
1367 hierarchy. Only the top-level descendents (children) of the
1368 classification will be set initially.
1369<P>
1370<DD><DL>
1371</DL>
1372</DD>
1373<DD><DL>
1374<DT><B>Parameters:</B><DD><CODE>classifier</CODE> - is the ClassifierData object whose children are
1375 to be retrieved.</DL>
1376</DD>
1377</DL>
1378<HR>
1379
1380<A NAME="retrieveTitledStructureFor(org.greenstone.gs3client.data.ClassifierNodeData)"><!-- --></A><H3>
1381retrieveTitledStructureFor</H3>
1382<PRE>
1383public void <B>retrieveTitledStructureFor</B>(<A HREF="../../../org/greenstone/gs3client/data/ClassifierNodeData.html" title="class in org.greenstone.gs3client.data">ClassifierNodeData</A>&nbsp;classNode)</PRE>
1384<DL>
1385<DD>Given a ClassifierNodeData object for browsing, this method will
1386 set the classNode's children (previously retrieved) and retrieve
1387 all the children's metadata including the title.
1388<P>
1389<DD><DL>
1390</DL>
1391</DD>
1392<DD><DL>
1393<DT><B>Parameters:</B><DD><CODE>classNode</CODE> - is the ClassifierNodeData object whose title is to
1394 be retrieved along with the titles for its children.</DL>
1395</DD>
1396</DL>
1397<HR>
1398
1399<A NAME="getBaseURL()"><!-- --></A><H3>
1400getBaseURL</H3>
1401<PRE>
1402public java.lang.String <B>getBaseURL</B>()</PRE>
1403<DL>
1404<DD><DL>
1405</DL>
1406</DD>
1407<DD><DL>
1408
1409<DT><B>Returns:</B><DD>the baseURL of the active digital library interface object</DL>
1410</DD>
1411</DL>
1412<HR>
1413
1414<A NAME="getFilePath(org.greenstone.gs3client.data.DocumentNodeData)"><!-- --></A><H3>
1415getFilePath</H3>
1416<PRE>
1417public java.lang.String <B>getFilePath</B>(<A HREF="../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</PRE>
1418<DL>
1419<DD><DL>
1420</DL>
1421</DD>
1422<DD><DL>
1423
1424<DT><B>Returns:</B><DD>the filepath of the documentNode in the active digital library</DL>
1425</DD>
1426</DL>
1427<HR>
1428
1429<A NAME="changeUIColour(int)"><!-- --></A><H3>
1430changeUIColour</H3>
1431<PRE>
1432public void <B>changeUIColour</B>(int&nbsp;DL)</PRE>
1433<DL>
1434<DD>Changes the background colours of the client's user interface
1435 based on what the active digital library is.
1436 See files greenstone3/gli/classes/xml/config.xml and
1437 greenstone3/gli/src/org/greenstone/gatherer/Configuration.java
1438<P>
1439<DD><DL>
1440</DL>
1441</DD>
1442<DD><DL>
1443<DT><B>Parameters:</B><DD><CODE>DL</CODE> - indicates whether the active digital library is Greenstone or
1444 Fedora (or neither, in which case the GUI defaults to the usual grey).<DT><B>See Also:</B><DD><a href="http://www.java2s.com/Code/Java/Swing-JFC/UIManagerresourcestotweakthelookofapplications.htm">Java UIManager tutorial</a></DL>
1445</DD>
1446</DL>
1447<HR>
1448
1449<A NAME="main(java.lang.String[])"><!-- --></A><H3>
1450main</H3>
1451<PRE>
1452public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
1453<DL>
1454<DD>The main method of the GS3 java-client application. It instantiates
1455 an instance of the GS3JavaClient main window and makes it visible.
1456<P>
1457<DD><DL>
1458</DL>
1459</DD>
1460<DD><DL>
1461</DL>
1462</DD>
1463</DL>
1464<!-- ========= END OF CLASS DATA ========= -->
1465<HR>
1466
1467
1468<!-- ======= START OF BOTTOM NAVBAR ====== -->
1469<A NAME="navbar_bottom"><!-- --></A>
1470<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1471<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1472<TR>
1473<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1474<A NAME="navbar_bottom_firstrow"><!-- --></A>
1475<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1476 <TR ALIGN="center" VALIGN="top">
1477 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1478 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1479 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1480 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1481 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1482 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1483 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1484 </TR>
1485</TABLE>
1486</TD>
1487<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1488</EM>
1489</TD>
1490</TR>
1491
1492<TR>
1493<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1494&nbsp;<A HREF="../../../org/greenstone/gs3client/GraphPaperLayout.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>&nbsp;
1495&nbsp;<A HREF="../../../org/greenstone/gs3client/GS3JavaClient.PasswordAuthenticator.html" title="class in org.greenstone.gs3client"><B>NEXT CLASS</B></A></FONT></TD>
1496<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1497 <A HREF="../../../index.html?org/greenstone/gs3client/GS3JavaClient.html" target="_top"><B>FRAMES</B></A> &nbsp;
1498&nbsp;<A HREF="GS3JavaClient.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
1499&nbsp;<SCRIPT type="text/javascript">
1500 <!--
1501 if(window==top) {
1502 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
1503 }
1504 //-->
1505</SCRIPT>
1506<NOSCRIPT>
1507 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
1508</NOSCRIPT>
1509
1510
1511</FONT></TD>
1512</TR>
1513<TR>
1514<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1515 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1516<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1517DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1518</TR>
1519</TABLE>
1520<A NAME="skip-navbar_bottom"></A>
1521<!-- ======== END OF BOTTOM NAVBAR ======= -->
1522
1523<HR>
1524
1525</BODY>
1526</HTML>
Note: See TracBrowser for help on using the repository browser.