Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: other-projects/trunk/gs3-webservices-democlient/docs/GS3DemoClient/org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html@ 15490

Last change on this file since 15490 was 15490, checked in by ak19, 16 years ago
Updated docs significantly
File size: 60.2 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:34:12 NZST 2008 -->
6	<TITLE>
7	GS3WebServicesQBRAPI
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.greenstone.gs3client.dlservices.GS3WebServicesQBRAPI 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="GS3WebServicesQBRAPI";
18	}
19	</SCRIPT>
20	<NOSCRIPT>
21	</NOSCRIPT>
22
23	</HEAD>
24
25	<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28	<!-- ========= START OF TOP NAVBAR ======= -->
29	<A NAME="navbar_top"><!-- --></A>
30	<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32	<TR>
33	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34	<A NAME="navbar_top_firstrow"><!-- --></A>
35	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36	<TR ALIGN="center" VALIGN="top">
37	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
39	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
42	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
43	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
44	</TR>
45	</TABLE>
46	</TD>
47	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48	</EM>
49	</TD>
50	</TR>
51
52	<TR>
53	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54	<A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices"><B>PREV CLASS</B></A>
55	NEXT CLASS</FONT></TD>
56	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57	<A HREF="../../../../index.html?org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" target="_top"><B>FRAMES</B></A>
58	<A HREF="GS3WebServicesQBRAPI.html" target="_top"><B>NO FRAMES</B></A>
59	<SCRIPT type="text/javascript">
60	<!--
61	if(window==top) {
62	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
63	}
64	//-->
65	</SCRIPT>
66	<NOSCRIPT>
67	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
68	</NOSCRIPT>
69
70
71	</FONT></TD>
72	</TR>
73	<TR>
74	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
76	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
78	</TR>
79	</TABLE>
80	<A NAME="skip-navbar_top"></A>
81	<!-- ========= END OF TOP NAVBAR ========= -->
82
83	<HR>
84	<!-- ======== START OF CLASS DATA ======== -->
85	<H2>
86	<FONT SIZE="-1">
87	org.greenstone.gs3client.dlservices</FONT>
88	<BR>
89	Class GS3WebServicesQBRAPI</H2>
90	<PRE>
91	java.lang.Object
92	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.dlservices.GS3WebServicesQBRAPI</B>
93	</PRE>
94	<DL>
95	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices">GS3ServicesAPIA</A></DD>
96	</DL>
97	<HR>
98	<DL>
99	<DT><PRE>public class <B>GS3WebServicesQBRAPI</B><DT>extends java.lang.Object</DL>
100	</PRE>
101
102	<P>
103	GS3WebServicesQBRAPI deals with invoking the Greenstone 3 web services
104	functionality through use of Apache Axis' Service and Call objects.
105	Each Greenstone 3 web service operation has an equivalent method here
106	that invokes it, even if some of these web service operations are never
107	called by the Java-client and therefore not prescribed by the
108	DigitalLibraryServicesAPIA interface.
109	<P>
110
111	<P>
112	<DL>
113	<DT><B>Author:</B></DT>
114	<DD>ak19</DD>
115	</DL>
116	<HR>
117
118	<P>
119	<!-- =========== FIELD SUMMARY =========== -->
120
121	<A NAME="field_summary"><!-- --></A>
122	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125	<B>Field Summary</B></FONT></TH>
126	</TR>
127	<TR BGCOLOR="white" CLASS="TableRowColor">
128	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129	<CODE>protected  org.apache.axis.client.Call</CODE></FONT></TD>
130	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#call">call</A></B></CODE>
131
132	<BR>
133	Axis Call object for invoking Greenstone 3's WebServices
134	using its WSDL file</TD>
135	</TR>
136	<TR BGCOLOR="white" CLASS="TableRowColor">
137	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138	<CODE>static java.lang.String</CODE></FONT></TD>
139	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#defaultWsdlURL">defaultWsdlURL</A></B></CODE>
140
141	<BR>
142	The value that the input dialog's field wsdlURL will default
143	to if there is (no properties file and) no wsdlURL property</TD>
144	</TR>
145	<TR BGCOLOR="white" CLASS="TableRowColor">
146	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147	<CODE>(package private) static org.apache.log4j.Logger</CODE></FONT></TD>
148	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#LOG">LOG</A></B></CODE>
149
150	<BR>
151	The Logger for this class</TD>
152	</TR>
153	<TR BGCOLOR="white" CLASS="TableRowColor">
154	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
155	<CODE>protected  java.lang.String</CODE></FONT></TD>
156	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#namespace">namespace</A></B></CODE>
157
158	<BR>
159	namespace of Greenstone 3's WebServices, as given in the WSDL file</TD>
160	</TR>
161	<TR BGCOLOR="white" CLASS="TableRowColor">
162	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163	<CODE>protected  java.lang.String</CODE></FONT></TD>
164	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#portName">portName</A></B></CODE>
165
166	<BR>
167	port Name of Greenstone 3's WebServices, as given in the WSDL file</TD>
168	</TR>
169	<TR BGCOLOR="white" CLASS="TableRowColor">
170	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171	<CODE>protected  org.apache.axis.client.Service</CODE></FONT></TD>
172	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#service">service</A></B></CODE>
173
174	<BR>
175	Axis Service object for connecting to invoking Greenstone 3's WebServices
176	using its WSDL file</TD>
177	</TR>
178	<TR BGCOLOR="white" CLASS="TableRowColor">
179	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180	<CODE>protected  java.lang.String</CODE></FONT></TD>
181	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#serviceName">serviceName</A></B></CODE>
182
183	<BR>
184	service Name of Greenstone 3's WebServices, as given in the WSDL file</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/gs3client/dlservices/GS3WebServicesQBRAPI.html#wsdlURLName">wsdlURLName</A></B></CODE>
190
191	<BR>
192	Url of the Greenstone 3 WebServices' WSDL</TD>
193	</TR>
194	</TABLE>
195
196	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
197
198	<A NAME="constructor_summary"><!-- --></A>
199	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
202	<B>Constructor Summary</B></FONT></TH>
203	</TR>
204	<TR BGCOLOR="white" CLASS="TableRowColor">
205	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#GS3WebServicesQBRAPI(java.lang.String)">GS3WebServicesQBRAPI</A></B>(java.lang.String wsdlURLName)</CODE>
206
207	<BR>
208	GS3ServicesAPIA constructor, that given the url to the wsdl file, finds
209	either service and port or the service's endpoint of the GS3 Web Services
210	and instantiates the associated Service and Call objects.</TD>
211	</TR>
212	</TABLE>
213
214	<!-- ========== METHOD SUMMARY =========== -->
215
216	<A NAME="method_summary"><!-- --></A>
217	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
218	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
219	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
220	<B>Method Summary</B></FONT></TH>
221	</TR>
222	<TR BGCOLOR="white" CLASS="TableRowColor">
223	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224	<CODE>protected  void</CODE></FONT></TD>
225	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#addArrayParam(java.lang.String)">addArrayParam</A></B>(java.lang.String arrayParamName)</CODE>
226
227	<BR>
228	Helper method.</TD>
229	</TR>
230	<TR BGCOLOR="white" CLASS="TableRowColor">
231	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232	<CODE>protected  void</CODE></FONT></TD>
233	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#addStringParam(java.lang.String)">addStringParam</A></B>(java.lang.String paramName)</CODE>
234
235	<BR>
236	Helper method.</TD>
237	</TR>
238	<TR BGCOLOR="white" CLASS="TableRowColor">
239	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240	<CODE> java.lang.String</CODE></FONT></TD>
241	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#basicQuery(java.lang.String, java.lang.String, java.lang.String)">basicQuery</A></B>(java.lang.String collection,
242	java.lang.String lang,
243	java.lang.String query)</CODE>
244
245	<BR>
246	This method is used to perform the most basic query:
247	it assumes defaults for all other parameters and provides only
248	the query string.</TD>
249	</TR>
250	<TR BGCOLOR="white" CLASS="TableRowColor">
251	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252	<CODE> java.lang.String</CODE></FONT></TD>
253	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#browse(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">browse</A></B>(java.lang.String collection,
254	java.lang.String browseService,
255	java.lang.String lang,
256	java.lang.String[] classifierNodeIDs,
257	java.lang.String[] structureParams)</CODE>
258
259	<BR>
260	To send a browse request for specific parts of a classifier node
261	(children, ancestors, descendants).</TD>
262	</TR>
263	<TR BGCOLOR="white" CLASS="TableRowColor">
264	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265	<CODE> java.lang.String</CODE></FONT></TD>
266	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#browseDescendants(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">browseDescendants</A></B>(java.lang.String collection,
267	java.lang.String browseService,
268	java.lang.String lang,
269	java.lang.String[] classifierNodeIDs)</CODE>
270
271	<BR>
272	To send a browse request for all the descendants of a classifier node.</TD>
273	</TR>
274	<TR BGCOLOR="white" CLASS="TableRowColor">
275	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276	<CODE> java.lang.String</CODE></FONT></TD>
277	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describe(java.lang.String, java.lang.String)">describe</A></B>(java.lang.String lang,
278	java.lang.String subsetOption)</CODE>
279
280	<BR>
281	Describe request message sent to the Message Router.</TD>
282	</TR>
283	<TR BGCOLOR="white" CLASS="TableRowColor">
284	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285	<CODE> java.lang.String</CODE></FONT></TD>
286	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describeCollection(java.lang.String, java.lang.String, java.lang.String)">describeCollection</A></B>(java.lang.String collection,
287	java.lang.String lang,
288	java.lang.String subsetOption)</CODE>
289
290	<BR>
291	For sending Describe messages to Collections.</TD>
292	</TR>
293	<TR BGCOLOR="white" CLASS="TableRowColor">
294	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295	<CODE> java.lang.String</CODE></FONT></TD>
296	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describeCollectionService(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">describeCollectionService</A></B>(java.lang.String collection,
297	java.lang.String service,
298	java.lang.String lang,
299	java.lang.String subsetOption)</CODE>
300
301	<BR>
302	For sending a describe message to a Collection's Service.</TD>
303	</TR>
304	<TR BGCOLOR="white" CLASS="TableRowColor">
305	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
306	<CODE> java.lang.String</CODE></FONT></TD>
307	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describeService(java.lang.String, java.lang.String, java.lang.String)">describeService</A></B>(java.lang.String service,
308	java.lang.String lang,
309	java.lang.String subsetOption)</CODE>
310
311	<BR>
312	For sending a describe message to a Service hosted by the Message Router
313	(no collection).</TD>
314	</TR>
315	<TR BGCOLOR="white" CLASS="TableRowColor">
316	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
317	<CODE> java.lang.String</CODE></FONT></TD>
318	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describeServiceCluster(java.lang.String, java.lang.String, java.lang.String)">describeServiceCluster</A></B>(java.lang.String serviceCluster,
319	java.lang.String lang,
320	java.lang.String subsetOption)</CODE>
321
322	<BR>
323	For sending Describe messages to ServiceClusters.</TD>
324	</TR>
325	<TR BGCOLOR="white" CLASS="TableRowColor">
326	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
327	<CODE>protected static java.util.Vector</CODE></FONT></TD>
328	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getElementsByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String)">getElementsByTagNameNS</A></B>(org.w3c.dom.Element parentElement,
329	java.lang.String namespacePrefix,
330	java.lang.String localName)</CODE>
331
332	<BR>
333	Static method that gets all the descendant elements of a portion of XMl
334	within the same namespace as indicated by parameters namespacePrefix and
335	localName.</TD>
336	</TR>
337	<TR BGCOLOR="white" CLASS="TableRowColor">
338	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
339	<CODE>protected static void</CODE></FONT></TD>
340	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getElementsByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String, java.util.Vector)">getElementsByTagNameNS</A></B>(org.w3c.dom.Element parentElement,
341	java.lang.String namespacePrefix,
342	java.lang.String localName,
343	java.util.Vector v)</CODE>
344
345	<BR>
346	At method's end, Vector v will contain those descendent elements of
347	parentElement where the element's name is prefixed by namespacePrefix
348	and suffixed by localName.</TD>
349	</TR>
350	<TR BGCOLOR="white" CLASS="TableRowColor">
351	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
352	<CODE>protected static void</CODE></FONT></TD>
353	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getElementsByTagNameSuffix(org.w3c.dom.Element, java.lang.String, java.util.Vector)">getElementsByTagNameSuffix</A></B>(org.w3c.dom.Element parentElement,
354	java.lang.String localName,
355	java.util.Vector v)</CODE>
356
357	<BR>
358	Recursive method.</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/gs3client/dlservices/GS3WebServicesQBRAPI.html#getNamespace()">getNamespace</A></B>()</CODE>
364
365	<BR>
366	</TD>
367	</TR>
368	<TR BGCOLOR="white" CLASS="TableRowColor">
369	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
370	<CODE> java.lang.String</CODE></FONT></TD>
371	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getPort()">getPort</A></B>()</CODE>
372
373	<BR>
374	</TD>
375	</TR>
376	<TR BGCOLOR="white" CLASS="TableRowColor">
377	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
378	<CODE> java.lang.String</CODE></FONT></TD>
379	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getService()">getService</A></B>()</CODE>
380
381	<BR>
382	</TD>
383	</TR>
384	<TR BGCOLOR="white" CLASS="TableRowColor">
385	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
386	<CODE> java.lang.String</CODE></FONT></TD>
387	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getWsdl()">getWsdl</A></B>()</CODE>
388
389	<BR>
390	</TD>
391	</TR>
392	<TR BGCOLOR="white" CLASS="TableRowColor">
393	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
394	<CODE> java.lang.String</CODE></FONT></TD>
395	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#help()">help</A></B>()</CODE>
396
397	<BR>
398	</TD>
399	</TR>
400	<TR BGCOLOR="white" CLASS="TableRowColor">
401	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
402	<CODE> java.lang.String</CODE></FONT></TD>
403	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#helpWithMethod(java.lang.String)">helpWithMethod</A></B>(java.lang.String methodname)</CODE>
404
405	<BR>
406	</TD>
407	</TR>
408	<TR BGCOLOR="white" CLASS="TableRowColor">
409	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
410	<CODE>protected  java.lang.String</CODE></FONT></TD>
411	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#invokeWith(java.lang.Object[])">invokeWith</A></B>(java.lang.Object[] params)</CODE>
412
413	<BR>
414	Helper method.</TD>
415	</TR>
416	<TR BGCOLOR="white" CLASS="TableRowColor">
417	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
418	<CODE>static void</CODE></FONT></TD>
419	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
420
421	<BR>
422	</TD>
423	</TR>
424	<TR BGCOLOR="white" CLASS="TableRowColor">
425	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
426	<CODE> java.lang.String</CODE></FONT></TD>
427	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#query(java.lang.String, java.lang.String, java.lang.String, java.util.Map)">query</A></B>(java.lang.String collection,
428	java.lang.String service,
429	java.lang.String lang,
430	java.util.Map nameToValsMap)</CODE>
431
432	<BR>
433	For executing a (process-type message) query-type service.</TD>
434	</TR>
435	<TR BGCOLOR="white" CLASS="TableRowColor">
436	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
437	<CODE> java.lang.String</CODE></FONT></TD>
438	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveAllBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">retrieveAllBrowseMetadata</A></B>(java.lang.String collection,
439	java.lang.String categoryName,
440	java.lang.String lang,
441	java.lang.String[] nodeIDs)</CODE>
442
443	<BR>
444	Retrieve all classification Metadata for browsing (sent to the
445	ClassifierBrowseMetadataRetrieve service).</TD>
446	</TR>
447	<TR BGCOLOR="white" CLASS="TableRowColor">
448	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
449	<CODE> java.lang.String</CODE></FONT></TD>
450	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveAllDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveAllDocumentMetadata</A></B>(java.lang.String collection,
451	java.lang.String lang,
452	java.lang.String[] docNodeIDs)</CODE>
453
454	<BR>
455	(c) DocumentMetadataRetrieve request sent to a collection's
456	DocumentMetadataRetrieve service to retrieve all of a document's metadata.</TD>
457	</TR>
458	<TR BGCOLOR="white" CLASS="TableRowColor">
459	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
460	<CODE> java.lang.String</CODE></FONT></TD>
461	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">retrieveBrowseMetadata</A></B>(java.lang.String collection,
462	java.lang.String categoryName,
463	java.lang.String lang,
464	java.lang.String[] nodeIDs,
465	java.lang.String[] metaNames)</CODE>
466
467	<BR>
468	ClassifierBrowseMetadataRetrieve service to retrieve some specific
469	metadata values of a document.</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/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveDocumentContent(java.lang.String, java.lang.String, java.lang.String[])">retrieveDocumentContent</A></B>(java.lang.String collection,
475	java.lang.String lang,
476	java.lang.String[] docNodeIDs)</CODE>
477
478	<BR>
479	(a) DocumentContentRetrieve request sent to a collection's
480	DocumentContentRetrieve service (p.48)</TD>
481	</TR>
482	<TR BGCOLOR="white" CLASS="TableRowColor">
483	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
484	<CODE> java.lang.String</CODE></FONT></TD>
485	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">retrieveDocumentMetadata</A></B>(java.lang.String collection,
486	java.lang.String lang,
487	java.lang.String[] docNodeIDs,
488	java.lang.String[] metaNames)</CODE>
489
490	<BR>
491	DocumentMetadataRetrieve service to retrieve some specific
492	metadata values of a document.</TD>
493	</TR>
494	<TR BGCOLOR="white" CLASS="TableRowColor">
495	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
496	<CODE> java.lang.String</CODE></FONT></TD>
497	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveDocumentStructure(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[])">retrieveDocumentStructure</A></B>(java.lang.String collection,
498	java.lang.String lang,
499	java.lang.String[] docNodeIDs,
500	java.lang.String[] structure,
501	java.lang.String[] info)</CODE>
502
503	<BR>
504	DocumentStructureRetrieve request sent to a collection's
505	DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
506	the specified part of the document's structure.</TD>
507	</TR>
508	<TR BGCOLOR="white" CLASS="TableRowColor">
509	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
510	<CODE> java.lang.String</CODE></FONT></TD>
511	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveEntireDocumentStructure(java.lang.String, java.lang.String, java.lang.String[])">retrieveEntireDocumentStructure</A></B>(java.lang.String collection,
512	java.lang.String lang,
513	java.lang.String[] docNodeIDs)</CODE>
514
515	<BR>
516	(b) DocumentStructureRetrieve request sent to a collection's
517	DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
518	the entire document structure.</TD>
519	</TR>
520	</TABLE>
521	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
522	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
523	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
524	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
525	</TR>
526	<TR BGCOLOR="white" CLASS="TableRowColor">
527	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
528	</TR>
529	</TABLE>
530
531	<P>
532
533	<!-- ============ FIELD DETAIL =========== -->
534
535	<A NAME="field_detail"><!-- --></A>
536	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
537	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
538	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
539	<B>Field Detail</B></FONT></TH>
540	</TR>
541	</TABLE>
542
543	<A NAME="LOG"><!-- --></A><H3>
544	LOG</H3>
545	<PRE>
546	static org.apache.log4j.Logger <B>LOG</B></PRE>
547	<DL>
548	<DD>The Logger for this class
549	<P>
550	<DL>
551	</DL>
552	</DL>
553	<HR>
554
555	<A NAME="defaultWsdlURL"><!-- --></A><H3>
556	defaultWsdlURL</H3>
557	<PRE>
558	public static final java.lang.String <B>defaultWsdlURL</B></PRE>
559	<DL>
560	<DD>The value that the input dialog's field wsdlURL will default
561	to if there is (no properties file and) no wsdlURL property
562	<P>
563	<DL>
564	<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.gs3client.dlservices.GS3WebServicesQBRAPI.defaultWsdlURL">Constant Field Values</A></DL>
565	</DL>
566	<HR>
567
568	<A NAME="service"><!-- --></A><H3>
569	service</H3>
570	<PRE>
571	protected org.apache.axis.client.Service <B>service</B></PRE>
572	<DL>
573	<DD>Axis Service object for connecting to invoking Greenstone 3's WebServices
574	using its WSDL file
575	<P>
576	<DL>
577	</DL>
578	</DL>
579	<HR>
580
581	<A NAME="call"><!-- --></A><H3>
582	call</H3>
583	<PRE>
584	protected org.apache.axis.client.Call <B>call</B></PRE>
585	<DL>
586	<DD>Axis Call object for invoking Greenstone 3's WebServices
587	using its WSDL file
588	<P>
589	<DL>
590	</DL>
591	</DL>
592	<HR>
593
594	<A NAME="portName"><!-- --></A><H3>
595	portName</H3>
596	<PRE>
597	protected java.lang.String <B>portName</B></PRE>
598	<DL>
599	<DD>port Name of Greenstone 3's WebServices, as given in the WSDL file
600	<P>
601	<DL>
602	</DL>
603	</DL>
604	<HR>
605
606	<A NAME="namespace"><!-- --></A><H3>
607	namespace</H3>
608	<PRE>
609	protected java.lang.String <B>namespace</B></PRE>
610	<DL>
611	<DD>namespace of Greenstone 3's WebServices, as given in the WSDL file
612	<P>
613	<DL>
614	</DL>
615	</DL>
616	<HR>
617
618	<A NAME="serviceName"><!-- --></A><H3>
619	serviceName</H3>
620	<PRE>
621	protected java.lang.String <B>serviceName</B></PRE>
622	<DL>
623	<DD>service Name of Greenstone 3's WebServices, as given in the WSDL file
624	<P>
625	<DL>
626	</DL>
627	</DL>
628	<HR>
629
630	<A NAME="wsdlURLName"><!-- --></A><H3>
631	wsdlURLName</H3>
632	<PRE>
633	protected java.lang.String <B>wsdlURLName</B></PRE>
634	<DL>
635	<DD>Url of the Greenstone 3 WebServices' WSDL
636	<P>
637	<DL>
638	</DL>
639	</DL>
640
641	<!-- ========= CONSTRUCTOR DETAIL ======== -->
642
643	<A NAME="constructor_detail"><!-- --></A>
644	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
645	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
646	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
647	<B>Constructor Detail</B></FONT></TH>
648	</TR>
649	</TABLE>
650
651	<A NAME="GS3WebServicesQBRAPI(java.lang.String)"><!-- --></A><H3>
652	GS3WebServicesQBRAPI</H3>
653	<PRE>
654	public <B>GS3WebServicesQBRAPI</B>(java.lang.String wsdlURLName)
655	throws javax.xml.rpc.ServiceException,
656	java.net.MalformedURLException,
657	javax.xml.parsers.ParserConfigurationException,
658	java.io.IOException,
659	org.xml.sax.SAXException</PRE>
660	<DL>
661	<DD>GS3ServicesAPIA constructor, that given the url to the wsdl file, finds
662	either service and port or the service's endpoint of the GS3 Web Services
663	and instantiates the associated Service and Call objects.
664	<P>
665	<DL>
666	<DT><B>Parameters:</B><DD><CODE>wsdlURLName</CODE> - - location of the WSDL URL for Greenstone 3's
667	web services
668	<DT><B>Throws:</B>
669	<DD><CODE>javax.xml.rpc.ServiceException</CODE>
670	<DD><CODE>java.net.MalformedURLException</CODE>
671	<DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
672	<DD><CODE>java.io.IOException</CODE>
673	<DD><CODE>org.xml.sax.SAXException</CODE></DL>
674	</DL>
675
676	<!-- ============ METHOD DETAIL ========== -->
677
678	<A NAME="method_detail"><!-- --></A>
679	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
680	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
681	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
682	<B>Method Detail</B></FONT></TH>
683	</TR>
684	</TABLE>
685
686	<A NAME="getElementsByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String)"><!-- --></A><H3>
687	getElementsByTagNameNS</H3>
688	<PRE>
689	protected static java.util.Vector <B>getElementsByTagNameNS</B>(org.w3c.dom.Element parentElement,
690	java.lang.String namespacePrefix,
691	java.lang.String localName)</PRE>
692	<DL>
693	<DD>Static method that gets all the descendant elements of a portion of XMl
694	within the same namespace as indicated by parameters namespacePrefix and
695	localName.
696	<P>
697	<DD><DL>
698	<DT><B>Parameters:</B><DD><CODE>namespacePrefix</CODE> - - a String for the namespacePrefix to search for.
699	This can be the wildcard * for any/allnamespaces.<DD><CODE>localName</CODE> - - the suffix of the namespaceprefix. For instance, localName
700	"soap" will return elements that have the tag wsdlsoap.<DD><CODE>parentElement</CODE> - - the XML element whose descendants will be returned if
701	their element names conform to the specified namespacePrefix and localName
702	parameters.
703	<DT><B>Returns:</B><DD>a Vector of all descendant elements whose namespace-qualfied tag
704	names are as specified by the parameters namespacePrefix and localName.
705	Had to implement my own getElementsByTagNameNS() method since the original
706	Element.getElementsByTagNameNS() does not work for Elements created using
707	DOM level 1 (such as with document.createElement()). See the API for Element.
708	This method is slightly more generic, as it returns all descendent elements
709	in a vector where the element name is prefixed by "namespacePrefix" (which
710	need not be a namespace uri at all) and is suffixed by an equally arbitrary
711	String called localName.
712	If "*" is passed instead of namespacePrefix, this method will ignore any
713	prefixes and check only for element names that end on the suffix localName.
714
715	Old versions of this method had all the same functionality in one method,
716	but it was not so optimised (several if-statement checks would have been executed an unnecessary
717	number of times. This (current) version is split into 3 methods: this one
718	and two helper functions that deal with the case where namespacePrefix can
719	be anything and where it is particularly specified.</DL>
720	</DD>
721	</DL>
722	<HR>
723
724	<A NAME="getElementsByTagNameSuffix(org.w3c.dom.Element, java.lang.String, java.util.Vector)"><!-- --></A><H3>
725	getElementsByTagNameSuffix</H3>
726	<PRE>
727	protected static void <B>getElementsByTagNameSuffix</B>(org.w3c.dom.Element parentElement,
728	java.lang.String localName,
729	java.util.Vector v)</PRE>
730	<DL>
731	<DD>Recursive method.
732	At method's end, Vector v will contain those descendent elements of
733	parentElement where the element's name is suffixed by/ends with parameter
734	localName.
735	Related to local method getElementsByTagNameNS(). Deals with the case
736	where any and all (namespace)Prefix of an element is accepted, but where
737	an element name's suffix should match with the given localName.
738	<P>
739	<DD><DL>
740	<DT><B>Parameters:</B><DD><CODE>parentElement</CODE> - us the XML element whose descendants are to be
741	retrieved by the given TagNameSuffix.<DD><CODE>localName</CODE> - is the tagName suffix to retrieve the descendants of
742	parentElement by.<DD><CODE>v</CODE> - is a Vector of all the previously retrieved elements whose tag
743	names are suffixed by localName. This Vector is appended to by recursive
744	calls to this method.</DL>
745	</DD>
746	</DL>
747	<HR>
748
749	<A NAME="getElementsByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String, java.util.Vector)"><!-- --></A><H3>
750	getElementsByTagNameNS</H3>
751	<PRE>
752	protected static void <B>getElementsByTagNameNS</B>(org.w3c.dom.Element parentElement,
753	java.lang.String namespacePrefix,
754	java.lang.String localName,
755	java.util.Vector v)</PRE>
756	<DL>
757	<DD>At method's end, Vector v will contain those descendent elements of
758	parentElement where the element's name is prefixed by namespacePrefix
759	and suffixed by localName.
760	Related to local method getElementsByTagNameNS(). Deals with the case
761	where a particular (namespace)Prefix of an element and suffix (localname)
762	are given and an element's name should match both prefix and suffix.
763	<P>
764	<DD><DL>
765	<DT><B>Parameters:</B><DD><CODE>parentElement</CODE> - is the XML element whose descendants are to be
766	retrieved by the given TagNameSuffix.<DD><CODE>namespacePrefix</CODE> - is the namespace prefix to look for in the
767	descendants of parentElement that will be collected in Vector v.<DD><CODE>localName</CODE> - is the tagName suffix to look for in the descendants of
768	parentElement that will be collected in Vector v.<DD><CODE>v</CODE> - is a Vector of all the previously retrieved elements whose tag
769	names are prefixed by namespacePrefix and suffixed by localName.
770	This Vector is appended to by recursive calls to this method.</DL>
771	</DD>
772	</DL>
773	<HR>
774
775	<A NAME="getNamespace()"><!-- --></A><H3>
776	getNamespace</H3>
777	<PRE>
778	public java.lang.String <B>getNamespace</B>()</PRE>
779	<DL>
780	<DD><DL>
781
782	<DT><B>Returns:</B><DD>the namespace of the wsdl file.</DL>
783	</DD>
784	</DL>
785	<HR>
786
787	<A NAME="getService()"><!-- --></A><H3>
788	getService</H3>
789	<PRE>
790	public java.lang.String <B>getService</B>()</PRE>
791	<DL>
792	<DD><DL>
793
794	<DT><B>Returns:</B><DD>the web service's serviceName without the namespace</DL>
795	</DD>
796	</DL>
797	<HR>
798
799	<A NAME="getPort()"><!-- --></A><H3>
800	getPort</H3>
801	<PRE>
802	public java.lang.String <B>getPort</B>()</PRE>
803	<DL>
804	<DD><DL>
805
806	<DT><B>Returns:</B><DD>the web service's portName without the namespace</DL>
807	</DD>
808	</DL>
809	<HR>
810
811	<A NAME="getWsdl()"><!-- --></A><H3>
812	getWsdl</H3>
813	<PRE>
814	public java.lang.String <B>getWsdl</B>()</PRE>
815	<DL>
816	<DD><DL>
817
818	<DT><B>Returns:</B><DD>the the URL of the wsdl file.</DL>
819	</DD>
820	</DL>
821	<HR>
822
823	<A NAME="invokeWith(java.lang.Object[])"><!-- --></A><H3>
824	invokeWith</H3>
825	<PRE>
826	protected java.lang.String <B>invokeWith</B>(java.lang.Object[] params)</PRE>
827	<DL>
828	<DD>Helper method. Uses the Call object to invoke the operation (already
829	set prior to calling invokeWith()) with the given parameters.
830	<P>
831	<DD><DL>
832	</DL>
833	</DD>
834	</DL>
835	<HR>
836
837	<A NAME="addStringParam(java.lang.String)"><!-- --></A><H3>
838	addStringParam</H3>
839	<PRE>
840	protected void <B>addStringParam</B>(java.lang.String paramName)</PRE>
841	<DL>
842	<DD>Helper method. Adds a string parameter by the name of paramName to
843	the Call object.
844	<P>
845	<DD><DL>
846	<DT><B>Parameters:</B><DD><CODE>paramName</CODE> - - the name of the String parameter to add to the call
847	object</DL>
848	</DD>
849	</DL>
850	<HR>
851
852	<A NAME="addArrayParam(java.lang.String)"><!-- --></A><H3>
853	addArrayParam</H3>
854	<PRE>
855	protected void <B>addArrayParam</B>(java.lang.String arrayParamName)</PRE>
856	<DL>
857	<DD>Helper method. Adds an array parameter by the name of arrayParamName
858	to the Call object.
859	<P>
860	<DD><DL>
861	<DT><B>Parameters:</B><DD><CODE>arrayParamName</CODE> - - the name of the Array parameter to add to the
862	Call object</DL>
863	</DD>
864	</DL>
865	<HR>
866
867	<A NAME="describe(java.lang.String, java.lang.String)"><!-- --></A><H3>
868	describe</H3>
869	<PRE>
870	public java.lang.String <B>describe</B>(java.lang.String lang,
871	java.lang.String subsetOption)</PRE>
872	<DL>
873	<DD>Describe request message sent to the Message Router.
874	<P>
875	<DD><DL>
876	<DT><B>Parameters:</B><DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>subsetOption</CODE> - is the requested list of items to return in the response
877	For the Message Router this can be collectionList, serviceClusterList,
878	serviceList, siteList<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 35-41</a></DL>
879	</DD>
880	</DL>
881	<HR>
882
883	<A NAME="describeServiceCluster(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
884	describeServiceCluster</H3>
885	<PRE>
886	public java.lang.String <B>describeServiceCluster</B>(java.lang.String serviceCluster,
887	java.lang.String lang,
888	java.lang.String subsetOption)</PRE>
889	<DL>
890	<DD>For sending Describe messages to ServiceClusters.
891	<P>
892	<DD><DL>
893	<DT><B>Parameters:</B><DD><CODE>serviceCluster</CODE> - is the name of the Service Cluster that this describe
894	request is sent to.<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>subsetOption</CODE> - is the requested list of items to return in the response
895	For Service Clusters this can be metadataList, serviceList, displayItemList.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 35-41</a></DL>
896	</DD>
897	</DL>
898	<HR>
899
900	<A NAME="describeCollection(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
901	describeCollection</H3>
902	<PRE>
903	public java.lang.String <B>describeCollection</B>(java.lang.String collection,
904	java.lang.String lang,
905	java.lang.String subsetOption)</PRE>
906	<DL>
907	<DD>For sending Describe messages to Collections.
908	<P>
909	<DD><DL>
910	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection that this describe request
911	is sent to.<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>subsetOption</CODE> - is the requested list of items to return in the response
912	For Collections this can be metadataList, serviceList and displayItemList.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 35-41</a></DL>
913	</DD>
914	</DL>
915	<HR>
916
917	<A NAME="describeCollectionService(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
918	describeCollectionService</H3>
919	<PRE>
920	public java.lang.String <B>describeCollectionService</B>(java.lang.String collection,
921	java.lang.String service,
922	java.lang.String lang,
923	java.lang.String subsetOption)</PRE>
924	<DL>
925	<DD>For sending a describe message to a Collection's Service.
926	<P>
927	<DD><DL>
928	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose service
929	this describe request is sent to.<DD><CODE>service</CODE> - is the name of the Service (of that collection) to
930	which this describe request is sent.<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>subsetOption</CODE> - is the requested list of items to return in the response
931	For Services this can be paramList, displayItemList<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 35-41</a></DL>
932	</DD>
933	</DL>
934	<HR>
935
936	<A NAME="describeService(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
937	describeService</H3>
938	<PRE>
939	public java.lang.String <B>describeService</B>(java.lang.String service,
940	java.lang.String lang,
941	java.lang.String subsetOption)</PRE>
942	<DL>
943	<DD>For sending a describe message to a Service hosted by the Message Router
944	(no collection).
945	<P>
946	<DD><DL>
947	<DT><B>Parameters:</B><DD><CODE>service</CODE> - is the name of the MessageRouter's Service to which this
948	describe request is sent.<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>subsetOption</CODE> - is the requested list of items to return in the response
949	For Services this can be paramList, displayItemList<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 35-41</a></DL>
950	</DD>
951	</DL>
952	<HR>
953
954	<A NAME="query(java.lang.String, java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3>
955	query</H3>
956	<PRE>
957	public java.lang.String <B>query</B>(java.lang.String collection,
958	java.lang.String service,
959	java.lang.String lang,
960	java.util.Map nameToValsMap)</PRE>
961	<DL>
962	<DD>For executing a (process-type message) query-type service.
963	<P>
964	<DD><DL>
965	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose query service this
966	query-process request is sent to. If "", then the Message Router is assumed.<DD><CODE>service</CODE> - is the name of the Query Service (of that collection) to
967	which this request is sent.<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>nameToValsMap</CODE> - is a Map of the (fieldname, value) pairs for the
968	parameters of the query. The field names should be those recognised by
969	Greenstone 3. That is, the names must exist for the (Collection-)Service Query that this
970	message is sent To (as given in 'to' argument).
971	For names of arguments,<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - page 45</a>,
972	<a href="http://wiki.greenstone.org/wiki/index.php/Actions_and_Arguments">Greenstone wiki - Actions and Arguments</a>,
973	<a href="http://mail-archives.apache.org/mod_mbox/ws-axis-user/200204.mbox/%[email protected]%3E">How to use XMLType.SOAP_MAP</a></DL>
974	</DD>
975	</DL>
976	<HR>
977
978	<A NAME="basicQuery(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
979	basicQuery</H3>
980	<PRE>
981	public java.lang.String <B>basicQuery</B>(java.lang.String collection,
982	java.lang.String lang,
983	java.lang.String query)</PRE>
984	<DL>
985	<DD>This method is used to perform the most basic query:
986	it assumes defaults for all other parameters and provides only
987	the query string. It is built on top of a TextQuery.
988	<P>
989	<DD><DL>
990	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the Greenstone collection to be searched<DD><CODE>lang</CODE> - is the preferred language of the display content in
991	the response to be returned.<DD><CODE>query</CODE> - is the string to be sought in the Greenstone collection
992	<DT><B>Returns:</B><DD>a Greenstone 3 XML response message for the query specifying
993	the search results.</DL>
994	</DD>
995	</DL>
996	<HR>
997
998	<A NAME="retrieveDocumentContent(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
999	retrieveDocumentContent</H3>
1000	<PRE>
1001	public java.lang.String <B>retrieveDocumentContent</B>(java.lang.String collection,
1002	java.lang.String lang,
1003	java.lang.String[] docNodeIDs)</PRE>
1004	<DL>
1005	<DD>(a) DocumentContentRetrieve request sent to a collection's
1006	DocumentContentRetrieve service (p.48)
1007	<P>
1008	<DD><DL>
1009	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
1010	DocumentContentRetrieve is requested<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>docNodeIDs</CODE> - is the list of documentNodeIDs for which the
1011	content ought to be retrieved.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - page 48</a></DL>
1012	</DD>
1013	</DL>
1014	<HR>
1015
1016	<A NAME="retrieveEntireDocumentStructure(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
1017	retrieveEntireDocumentStructure</H3>
1018	<PRE>
1019	public java.lang.String <B>retrieveEntireDocumentStructure</B>(java.lang.String collection,
1020	java.lang.String lang,
1021	java.lang.String[] docNodeIDs)</PRE>
1022	<DL>
1023	<DD>(b) DocumentStructureRetrieve request sent to a collection's
1024	DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
1025	the entire document structure.
1026	<P>
1027	<DD><DL>
1028	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
1029	DocumentStructureRetrieve is requested<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>docNodeIDs</CODE> - is the list of documentNodeIDs for which the
1030	entire structure ought to be retrieved.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 48, 49</a></DL>
1031	</DD>
1032	</DL>
1033	<HR>
1034
1035	<A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[])"><!-- --></A><H3>
1036	retrieveDocumentStructure</H3>
1037	<PRE>
1038	public java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String collection,
1039	java.lang.String lang,
1040	java.lang.String[] docNodeIDs,
1041	java.lang.String[] structure,
1042	java.lang.String[] info)</PRE>
1043	<DL>
1044	<DD>DocumentStructureRetrieve request sent to a collection's
1045	DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
1046	the specified part of the document's structure.
1047	<P>
1048	<DD><DL>
1049	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
1050	DocumentStructureRetrieve is requested<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>docNodeIDs</CODE> - is the list of documentNodeIDs for which the
1051	structure ought to be retrieved.<DD><CODE>structure</CODE> - specifies what structure information needs to
1052	be retrieved. The values can be one or more of ancestors, parent,
1053	siblings, children, descendents (NOTE SPELLING), entire.<DD><CODE>info</CODE> - - for specifying extra information to be retrieved.
1054	Possible values for info parameters are numSiblings, siblingPosition,
1055	numChildren.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 48, 49</a></DL>
1056	</DD>
1057	</DL>
1058	<HR>
1059
1060	<A NAME="retrieveAllDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
1061	retrieveAllDocumentMetadata</H3>
1062	<PRE>
1063	public java.lang.String <B>retrieveAllDocumentMetadata</B>(java.lang.String collection,
1064	java.lang.String lang,
1065	java.lang.String[] docNodeIDs)</PRE>
1066	<DL>
1067	<DD>(c) DocumentMetadataRetrieve request sent to a collection's
1068	DocumentMetadataRetrieve service to retrieve all of a document's metadata.
1069	<P>
1070	<DD><DL>
1071	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
1072	DocumentMetadataRetrieve is requested<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>docNodeIDs</CODE> - is the list of documentNodeIDs for which the
1073	structure ought to be retrieved.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - page 47</a></DL>
1074	</DD>
1075	</DL>
1076	<HR>
1077
1078	<A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
1079	retrieveDocumentMetadata</H3>
1080	<PRE>
1081	public java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String collection,
1082	java.lang.String lang,
1083	java.lang.String[] docNodeIDs,
1084	java.lang.String[] metaNames)</PRE>
1085	<DL>
1086	<DD>DocumentMetadataRetrieve service to retrieve some specific
1087	metadata values of a document. (Manual on page 47.)
1088	<P>
1089	<DD><DL>
1090	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
1091	DocumentContentRetrieve is requested<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>docNodeIDs</CODE> - is the list of documentNodeIDs for which the
1092	structure ought to be retrieved.<DD><CODE>metaNames</CODE> - is a list of metadata names which are requested
1093	to be fetched for the specified documents.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - page 47</a></DL>
1094	</DD>
1095	</DL>
1096	<HR>
1097
1098	<A NAME="retrieveAllBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
1099	retrieveAllBrowseMetadata</H3>
1100	<PRE>
1101	public java.lang.String <B>retrieveAllBrowseMetadata</B>(java.lang.String collection,
1102	java.lang.String categoryName,
1103	java.lang.String lang,
1104	java.lang.String[] nodeIDs)</PRE>
1105	<DL>
1106	<DD>Retrieve all classification Metadata for browsing (sent to the
1107	ClassifierBrowseMetadataRetrieve service).
1108	<P>
1109	<DD><DL>
1110	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
1111	ClassifierBrowseMetadataRetrieve service is called<DD><CODE>categoryName</CODE> - - name of the browsing category, usually
1112	ClassifierBrowse. (If left as "", then it defaults to ClassifierBrowse)<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>nodeIDs</CODE> - is the list of document or classifier NodeIDs
1113	for which the metadata ought to be retrieved.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 47, 48</a></DL>
1114	</DD>
1115	</DL>
1116	<HR>
1117
1118	<A NAME="retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
1119	retrieveBrowseMetadata</H3>
1120	<PRE>
1121	public java.lang.String <B>retrieveBrowseMetadata</B>(java.lang.String collection,
1122	java.lang.String categoryName,
1123	java.lang.String lang,
1124	java.lang.String[] nodeIDs,
1125	java.lang.String[] metaNames)</PRE>
1126	<DL>
1127	<DD>ClassifierBrowseMetadataRetrieve service to retrieve some specific
1128	metadata values of a document.
1129	<P>
1130	<DD><DL>
1131	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
1132	ClassifierBrowseMetadataRetrieve service is called<DD><CODE>categoryName</CODE> - - name of the browsing category, usually
1133	"ClassifierBrowse". (If left as "", then it defaults to ClassifierBrowse)<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>nodeIDs</CODE> - is the list of document or classifier NodeIDs
1134	for which the metadata ought to be retrieved.<DD><CODE>metaNames</CODE> - is a list of metadata names which are requested
1135	to be fetched for the specified documents or classifiers<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 47, 48</a></DL>
1136	</DD>
1137	</DL>
1138	<HR>
1139
1140	<A NAME="browseDescendants(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
1141	browseDescendants</H3>
1142	<PRE>
1143	public java.lang.String <B>browseDescendants</B>(java.lang.String collection,
1144	java.lang.String browseService,
1145	java.lang.String lang,
1146	java.lang.String[] classifierNodeIDs)</PRE>
1147	<DL>
1148	<DD>To send a browse request for all the descendants of a classifier node.
1149	Useful for getting the entire structure of a top-level
1150	<classificationNode>.
1151	<P>
1152	<DD><DL>
1153	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose browse Classifier
1154	Browse Service is called<DD><CODE>browseService</CODE> - is the name of the (Classifier) Browse Service (of
1155	the given collection) to which this request message is sent.<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>classifierNodeIDs</CODE> - is an array of classifierNodeIDs for which the
1156	structures ought to be retrieved.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - page 46</a></DL>
1157	</DD>
1158	</DL>
1159	<HR>
1160
1161	<A NAME="browse(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
1162	browse</H3>
1163	<PRE>
1164	public java.lang.String <B>browse</B>(java.lang.String collection,
1165	java.lang.String browseService,
1166	java.lang.String lang,
1167	java.lang.String[] classifierNodeIDs,
1168	java.lang.String[] structureParams)</PRE>
1169	<DL>
1170	<DD>To send a browse request for specific parts of a classifier node
1171	(children, ancestors, descendants). Useful for getting specific parts
1172	of the structure of a top-level <classificationNode>.
1173	<P>
1174	<DD><DL>
1175	<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose browse Classifier
1176	Browse Service is called<DD><CODE>browseService</CODE> - is the name of the (Classifier) Browse Service (of
1177	the given collection) to which this request message is sent.<DD><CODE>lang</CODE> - is the language of the display content in the response<DD><CODE>classifierNodeIDs</CODE> - is the list of classifierNodeIDs for which the
1178	structure ought to be retrieved.<DD><CODE>structureParams</CODE> - the list of parameters indicating what structure
1179	information is requested. Accepted values are ancestors, parent, siblings,
1180	children, descendants.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - page 46</a></DL>
1181	</DD>
1182	</DL>
1183	<HR>
1184
1185	<A NAME="help()"><!-- --></A><H3>
1186	help</H3>
1187	<PRE>
1188	public java.lang.String <B>help</B>()</PRE>
1189	<DL>
1190	<DD><DL>
1191
1192	<DT><B>Returns:</B><DD>a help string for listing all the web service methods.</DL>
1193	</DD>
1194	</DL>
1195	<HR>
1196
1197	<A NAME="helpWithMethod(java.lang.String)"><!-- --></A><H3>
1198	helpWithMethod</H3>
1199	<PRE>
1200	public java.lang.String <B>helpWithMethod</B>(java.lang.String methodname)</PRE>
1201	<DL>
1202	<DD><DL>
1203	<DT><B>Parameters:</B><DD><CODE>methodname</CODE> - is the name of the method to be described.
1204	<DT><B>Returns:</B><DD>a help string for the given method, explaining what the method
1205	does, what parameters it expects and their types and what it returns.</DL>
1206	</DD>
1207	</DL>
1208	<HR>
1209
1210	<A NAME="main(java.lang.String[])"><!-- --></A><H3>
1211	main</H3>
1212	<PRE>
1213	public static void <B>main</B>(java.lang.String[] args)</PRE>
1214	<DL>
1215	<DD><DL>
1216	</DL>
1217	</DD>
1218	</DL>
1219	<!-- ========= END OF CLASS DATA ========= -->
1220	<HR>
1221
1222
1223	<!-- ======= START OF BOTTOM NAVBAR ====== -->
1224	<A NAME="navbar_bottom"><!-- --></A>
1225	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1226	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1227	<TR>
1228	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1229	<A NAME="navbar_bottom_firstrow"><!-- --></A>
1230	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1231	<TR ALIGN="center" VALIGN="top">
1232	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
1233	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
1234	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
1235	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
1236	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
1237	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
1238	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
1239	</TR>
1240	</TABLE>
1241	</TD>
1242	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1243	</EM>
1244	</TD>
1245	</TR>
1246
1247	<TR>
1248	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1249	<A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices"><B>PREV CLASS</B></A>
1250	NEXT CLASS</FONT></TD>
1251	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1252	<A HREF="../../../../index.html?org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" target="_top"><B>FRAMES</B></A>
1253	<A HREF="GS3WebServicesQBRAPI.html" target="_top"><B>NO FRAMES</B></A>
1254	<SCRIPT type="text/javascript">
1255	<!--
1256	if(window==top) {
1257	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1258	}
1259	//-->
1260	</SCRIPT>
1261	<NOSCRIPT>
1262	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
1263	</NOSCRIPT>
1264
1265
1266	</FONT></TD>
1267	</TR>
1268	<TR>
1269	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1270	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
1271	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1272	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
1273	</TR>
1274	</TABLE>
1275	<A NAME="skip-navbar_bottom"></A>
1276	<!-- ======== END OF BOTTOM NAVBAR ======= -->
1277
1278	<HR>
1279
1280	</BODY>
1281	</HTML>

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

Download in other formats: