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:14 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#browse(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">browse</A></B>(java.lang.String collection,
|
---|
242 | java.lang.String browseService,
|
---|
243 | java.lang.String lang,
|
---|
244 | java.lang.String[] classifierNodeIDs,
|
---|
245 | java.lang.String[] structureParams)</CODE>
|
---|
246 |
|
---|
247 | <BR>
|
---|
248 | To send a browse request for specific parts of a classifier node
|
---|
249 | (children, ancestors, descendants).</TD>
|
---|
250 | </TR>
|
---|
251 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
252 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
253 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
254 | <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,
|
---|
255 | java.lang.String browseService,
|
---|
256 | java.lang.String lang,
|
---|
257 | java.lang.String[] classifierNodeIDs)</CODE>
|
---|
258 |
|
---|
259 | <BR>
|
---|
260 | To send a browse request for all the descendants of a classifier node.</TD>
|
---|
261 | </TR>
|
---|
262 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
263 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
264 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
265 | <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,
|
---|
266 | java.lang.String subsetOption)</CODE>
|
---|
267 |
|
---|
268 | <BR>
|
---|
269 | Describe request message sent to the Message Router.</TD>
|
---|
270 | </TR>
|
---|
271 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
272 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
273 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
274 | <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,
|
---|
275 | java.lang.String lang,
|
---|
276 | java.lang.String subsetOption)</CODE>
|
---|
277 |
|
---|
278 | <BR>
|
---|
279 | For sending Describe messages to Collections.</TD>
|
---|
280 | </TR>
|
---|
281 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
282 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
283 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
284 | <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,
|
---|
285 | java.lang.String service,
|
---|
286 | java.lang.String lang,
|
---|
287 | java.lang.String subsetOption)</CODE>
|
---|
288 |
|
---|
289 | <BR>
|
---|
290 | For sending a describe message to a Collection's Service.</TD>
|
---|
291 | </TR>
|
---|
292 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
293 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
294 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
295 | <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,
|
---|
296 | java.lang.String lang,
|
---|
297 | java.lang.String subsetOption)</CODE>
|
---|
298 |
|
---|
299 | <BR>
|
---|
300 | For sending a describe message to a Service hosted by the Message Router
|
---|
301 | (no collection).</TD>
|
---|
302 | </TR>
|
---|
303 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
304 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
305 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
306 | <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,
|
---|
307 | java.lang.String lang,
|
---|
308 | java.lang.String subsetOption)</CODE>
|
---|
309 |
|
---|
310 | <BR>
|
---|
311 | For sending Describe messages to ServiceClusters.</TD>
|
---|
312 | </TR>
|
---|
313 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
314 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
315 | <CODE>protected static java.util.Vector</CODE></FONT></TD>
|
---|
316 | <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,
|
---|
317 | java.lang.String namespacePrefix,
|
---|
318 | java.lang.String localName)</CODE>
|
---|
319 |
|
---|
320 | <BR>
|
---|
321 | Static method that gets all the descendant elements of a portion of XMl
|
---|
322 | within the same namespace as indicated by parameters namespacePrefix and
|
---|
323 | localName.</TD>
|
---|
324 | </TR>
|
---|
325 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
326 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
327 | <CODE>protected static void</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, java.util.Vector)">getElementsByTagNameNS</A></B>(org.w3c.dom.Element parentElement,
|
---|
329 | java.lang.String namespacePrefix,
|
---|
330 | java.lang.String localName,
|
---|
331 | java.util.Vector v)</CODE>
|
---|
332 |
|
---|
333 | <BR>
|
---|
334 | At method's end, Vector v will contain those descendent elements of
|
---|
335 | parentElement where the element's name is prefixed by namespacePrefix
|
---|
336 | and suffixed by localName.</TD>
|
---|
337 | </TR>
|
---|
338 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
339 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
340 | <CODE>protected static void</CODE></FONT></TD>
|
---|
341 | <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,
|
---|
342 | java.lang.String localName,
|
---|
343 | java.util.Vector v)</CODE>
|
---|
344 |
|
---|
345 | <BR>
|
---|
346 | Recursive method.</TD>
|
---|
347 | </TR>
|
---|
348 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
349 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
350 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
351 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getNamespace()">getNamespace</A></B>()</CODE>
|
---|
352 |
|
---|
353 | <BR>
|
---|
354 | </TD>
|
---|
355 | </TR>
|
---|
356 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
357 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
358 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
359 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getPort()">getPort</A></B>()</CODE>
|
---|
360 |
|
---|
361 | <BR>
|
---|
362 | </TD>
|
---|
363 | </TR>
|
---|
364 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
365 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
366 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
367 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getService()">getService</A></B>()</CODE>
|
---|
368 |
|
---|
369 | <BR>
|
---|
370 | </TD>
|
---|
371 | </TR>
|
---|
372 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
373 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
374 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
375 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getWsdl()">getWsdl</A></B>()</CODE>
|
---|
376 |
|
---|
377 | <BR>
|
---|
378 | </TD>
|
---|
379 | </TR>
|
---|
380 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
381 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
382 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
383 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#help()">help</A></B>()</CODE>
|
---|
384 |
|
---|
385 | <BR>
|
---|
386 | </TD>
|
---|
387 | </TR>
|
---|
388 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
389 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
390 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
391 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#helpWithMethod(java.lang.String)">helpWithMethod</A></B>(java.lang.String methodname)</CODE>
|
---|
392 |
|
---|
393 | <BR>
|
---|
394 | </TD>
|
---|
395 | </TR>
|
---|
396 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
397 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
398 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
399 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#invokeWith(java.lang.Object[])">invokeWith</A></B>(java.lang.Object[] params)</CODE>
|
---|
400 |
|
---|
401 | <BR>
|
---|
402 | Helper method.</TD>
|
---|
403 | </TR>
|
---|
404 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
405 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
406 | <CODE>static void</CODE></FONT></TD>
|
---|
407 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
|
---|
408 |
|
---|
409 | <BR>
|
---|
410 | </TD>
|
---|
411 | </TR>
|
---|
412 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
413 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
414 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
415 | <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,
|
---|
416 | java.lang.String service,
|
---|
417 | java.lang.String lang,
|
---|
418 | java.util.Map nameToValsMap)</CODE>
|
---|
419 |
|
---|
420 | <BR>
|
---|
421 | For executing a (process-type message) query-type service.</TD>
|
---|
422 | </TR>
|
---|
423 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
424 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
425 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
426 | <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,
|
---|
427 | java.lang.String categoryName,
|
---|
428 | java.lang.String lang,
|
---|
429 | java.lang.String[] nodeIDs)</CODE>
|
---|
430 |
|
---|
431 | <BR>
|
---|
432 | Retrieve all classification Metadata for browsing (sent to the
|
---|
433 | ClassifierBrowseMetadataRetrieve 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#retrieveAllDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveAllDocumentMetadata</A></B>(java.lang.String collection,
|
---|
439 | java.lang.String lang,
|
---|
440 | java.lang.String[] docNodeIDs)</CODE>
|
---|
441 |
|
---|
442 | <BR>
|
---|
443 | (c) DocumentMetadataRetrieve request sent to a collection's
|
---|
444 | DocumentMetadataRetrieve service to retrieve all of a document's metadata.</TD>
|
---|
445 | </TR>
|
---|
446 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
447 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
448 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
449 | <TD><CODE><B><A HREF="../../../../org/greenstone/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,
|
---|
450 | java.lang.String categoryName,
|
---|
451 | java.lang.String lang,
|
---|
452 | java.lang.String[] nodeIDs,
|
---|
453 | java.lang.String[] metaNames)</CODE>
|
---|
454 |
|
---|
455 | <BR>
|
---|
456 | ClassifierBrowseMetadataRetrieve service to retrieve some specific
|
---|
457 | metadata values of a document.</TD>
|
---|
458 | </TR>
|
---|
459 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
460 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
461 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
462 | <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,
|
---|
463 | java.lang.String lang,
|
---|
464 | java.lang.String[] docNodeIDs)</CODE>
|
---|
465 |
|
---|
466 | <BR>
|
---|
467 | (a) DocumentContentRetrieve request sent to a collection's
|
---|
468 | DocumentContentRetrieve service (p.48)</TD>
|
---|
469 | </TR>
|
---|
470 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
471 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
472 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
473 | <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,
|
---|
474 | java.lang.String lang,
|
---|
475 | java.lang.String[] docNodeIDs,
|
---|
476 | java.lang.String[] metaNames)</CODE>
|
---|
477 |
|
---|
478 | <BR>
|
---|
479 | DocumentMetadataRetrieve service to retrieve some specific
|
---|
480 | metadata values of a document.</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#retrieveDocumentStructure(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[])">retrieveDocumentStructure</A></B>(java.lang.String collection,
|
---|
486 | java.lang.String lang,
|
---|
487 | java.lang.String[] docNodeIDs,
|
---|
488 | java.lang.String[] structure,
|
---|
489 | java.lang.String[] info)</CODE>
|
---|
490 |
|
---|
491 | <BR>
|
---|
492 | DocumentStructureRetrieve request sent to a collection's
|
---|
493 | DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
|
---|
494 | the specified part of the document's structure.</TD>
|
---|
495 | </TR>
|
---|
496 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
497 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
498 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
499 | <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,
|
---|
500 | java.lang.String lang,
|
---|
501 | java.lang.String[] docNodeIDs)</CODE>
|
---|
502 |
|
---|
503 | <BR>
|
---|
504 | (b) DocumentStructureRetrieve request sent to a collection's
|
---|
505 | DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
|
---|
506 | the entire document structure.</TD>
|
---|
507 | </TR>
|
---|
508 | </TABLE>
|
---|
509 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
510 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
511 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
512 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
---|
513 | </TR>
|
---|
514 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
515 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
516 | </TR>
|
---|
517 | </TABLE>
|
---|
518 |
|
---|
519 | <P>
|
---|
520 |
|
---|
521 | <!-- ============ FIELD DETAIL =========== -->
|
---|
522 |
|
---|
523 | <A NAME="field_detail"><!-- --></A>
|
---|
524 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
525 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
526 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
527 | <B>Field Detail</B></FONT></TH>
|
---|
528 | </TR>
|
---|
529 | </TABLE>
|
---|
530 |
|
---|
531 | <A NAME="LOG"><!-- --></A><H3>
|
---|
532 | LOG</H3>
|
---|
533 | <PRE>
|
---|
534 | static org.apache.log4j.Logger <B>LOG</B></PRE>
|
---|
535 | <DL>
|
---|
536 | <DD>The Logger for this class
|
---|
537 | <P>
|
---|
538 | <DL>
|
---|
539 | </DL>
|
---|
540 | </DL>
|
---|
541 | <HR>
|
---|
542 |
|
---|
543 | <A NAME="defaultWsdlURL"><!-- --></A><H3>
|
---|
544 | defaultWsdlURL</H3>
|
---|
545 | <PRE>
|
---|
546 | public static final java.lang.String <B>defaultWsdlURL</B></PRE>
|
---|
547 | <DL>
|
---|
548 | <DD>The value that the input dialog's field wsdlURL will default
|
---|
549 | to if there is (no properties file and) no wsdlURL property
|
---|
550 | <P>
|
---|
551 | <DL>
|
---|
552 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.gs3client.dlservices.GS3WebServicesQBRAPI.defaultWsdlURL">Constant Field Values</A></DL>
|
---|
553 | </DL>
|
---|
554 | <HR>
|
---|
555 |
|
---|
556 | <A NAME="service"><!-- --></A><H3>
|
---|
557 | service</H3>
|
---|
558 | <PRE>
|
---|
559 | protected org.apache.axis.client.Service <B>service</B></PRE>
|
---|
560 | <DL>
|
---|
561 | <DD>Axis Service object for connecting to invoking Greenstone 3's WebServices
|
---|
562 | using its WSDL file
|
---|
563 | <P>
|
---|
564 | <DL>
|
---|
565 | </DL>
|
---|
566 | </DL>
|
---|
567 | <HR>
|
---|
568 |
|
---|
569 | <A NAME="call"><!-- --></A><H3>
|
---|
570 | call</H3>
|
---|
571 | <PRE>
|
---|
572 | protected org.apache.axis.client.Call <B>call</B></PRE>
|
---|
573 | <DL>
|
---|
574 | <DD>Axis Call object for invoking Greenstone 3's WebServices
|
---|
575 | using its WSDL file
|
---|
576 | <P>
|
---|
577 | <DL>
|
---|
578 | </DL>
|
---|
579 | </DL>
|
---|
580 | <HR>
|
---|
581 |
|
---|
582 | <A NAME="portName"><!-- --></A><H3>
|
---|
583 | portName</H3>
|
---|
584 | <PRE>
|
---|
585 | protected java.lang.String <B>portName</B></PRE>
|
---|
586 | <DL>
|
---|
587 | <DD>port Name of Greenstone 3's WebServices, as given in the WSDL file
|
---|
588 | <P>
|
---|
589 | <DL>
|
---|
590 | </DL>
|
---|
591 | </DL>
|
---|
592 | <HR>
|
---|
593 |
|
---|
594 | <A NAME="namespace"><!-- --></A><H3>
|
---|
595 | namespace</H3>
|
---|
596 | <PRE>
|
---|
597 | protected java.lang.String <B>namespace</B></PRE>
|
---|
598 | <DL>
|
---|
599 | <DD>namespace 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="serviceName"><!-- --></A><H3>
|
---|
607 | serviceName</H3>
|
---|
608 | <PRE>
|
---|
609 | protected java.lang.String <B>serviceName</B></PRE>
|
---|
610 | <DL>
|
---|
611 | <DD>service Name 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="wsdlURLName"><!-- --></A><H3>
|
---|
619 | wsdlURLName</H3>
|
---|
620 | <PRE>
|
---|
621 | protected java.lang.String <B>wsdlURLName</B></PRE>
|
---|
622 | <DL>
|
---|
623 | <DD>Url of the Greenstone 3 WebServices' WSDL
|
---|
624 | <P>
|
---|
625 | <DL>
|
---|
626 | </DL>
|
---|
627 | </DL>
|
---|
628 |
|
---|
629 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
630 |
|
---|
631 | <A NAME="constructor_detail"><!-- --></A>
|
---|
632 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
633 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
634 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
635 | <B>Constructor Detail</B></FONT></TH>
|
---|
636 | </TR>
|
---|
637 | </TABLE>
|
---|
638 |
|
---|
639 | <A NAME="GS3WebServicesQBRAPI(java.lang.String)"><!-- --></A><H3>
|
---|
640 | GS3WebServicesQBRAPI</H3>
|
---|
641 | <PRE>
|
---|
642 | public <B>GS3WebServicesQBRAPI</B>(java.lang.String wsdlURLName)
|
---|
643 | throws javax.xml.rpc.ServiceException,
|
---|
644 | java.net.MalformedURLException,
|
---|
645 | javax.xml.parsers.ParserConfigurationException,
|
---|
646 | java.io.IOException,
|
---|
647 | org.xml.sax.SAXException</PRE>
|
---|
648 | <DL>
|
---|
649 | <DD>GS3ServicesAPIA constructor, that given the url to the wsdl file, finds
|
---|
650 | either service and port or the service's endpoint of the GS3 Web Services
|
---|
651 | and instantiates the associated Service and Call objects.
|
---|
652 | <P>
|
---|
653 | <DL>
|
---|
654 | <DT><B>Parameters:</B><DD><CODE>wsdlURLName</CODE> - - location of the WSDL URL for Greenstone 3's
|
---|
655 | web services
|
---|
656 | <DT><B>Throws:</B>
|
---|
657 | <DD><CODE>javax.xml.rpc.ServiceException</CODE>
|
---|
658 | <DD><CODE>java.net.MalformedURLException</CODE>
|
---|
659 | <DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
|
---|
660 | <DD><CODE>java.io.IOException</CODE>
|
---|
661 | <DD><CODE>org.xml.sax.SAXException</CODE></DL>
|
---|
662 | </DL>
|
---|
663 |
|
---|
664 | <!-- ============ METHOD DETAIL ========== -->
|
---|
665 |
|
---|
666 | <A NAME="method_detail"><!-- --></A>
|
---|
667 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
668 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
669 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
670 | <B>Method Detail</B></FONT></TH>
|
---|
671 | </TR>
|
---|
672 | </TABLE>
|
---|
673 |
|
---|
674 | <A NAME="getElementsByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
675 | getElementsByTagNameNS</H3>
|
---|
676 | <PRE>
|
---|
677 | protected static java.util.Vector <B>getElementsByTagNameNS</B>(org.w3c.dom.Element parentElement,
|
---|
678 | java.lang.String namespacePrefix,
|
---|
679 | java.lang.String localName)</PRE>
|
---|
680 | <DL>
|
---|
681 | <DD>Static method that gets all the descendant elements of a portion of XMl
|
---|
682 | within the same namespace as indicated by parameters namespacePrefix and
|
---|
683 | localName.
|
---|
684 | <P>
|
---|
685 | <DD><DL>
|
---|
686 | <DT><B>Parameters:</B><DD><CODE>namespacePrefix</CODE> - - a String for the namespacePrefix to search for.
|
---|
687 | This can be the wildcard * for any/allnamespaces.<DD><CODE>localName</CODE> - - the suffix of the namespaceprefix. For instance, localName
|
---|
688 | "soap" will return elements that have the tag wsdlsoap.<DD><CODE>parentElement</CODE> - - the XML element whose descendants will be returned if
|
---|
689 | their element names conform to the specified namespacePrefix and localName
|
---|
690 | parameters.
|
---|
691 | <DT><B>Returns:</B><DD>a Vector of all descendant elements whose namespace-qualfied tag
|
---|
692 | names are as specified by the parameters namespacePrefix and localName.
|
---|
693 | Had to implement my own getElementsByTagNameNS() method since the original
|
---|
694 | Element.getElementsByTagNameNS() does not work for Elements created using
|
---|
695 | DOM level 1 (such as with document.createElement()). See the API for Element.
|
---|
696 | This method is slightly more generic, as it returns all descendent elements
|
---|
697 | in a vector where the element name is prefixed by "namespacePrefix" (which
|
---|
698 | need not be a namespace uri at all) and is suffixed by an equally arbitrary
|
---|
699 | String called localName.
|
---|
700 | If "*" is passed instead of namespacePrefix, this method will ignore any
|
---|
701 | prefixes and check only for element names that end on the suffix localName.
|
---|
702 |
|
---|
703 | Old versions of this method had all the same functionality in one method,
|
---|
704 | but it was not so optimised (several if-statement checks would have been executed an unnecessary
|
---|
705 | number of times. This (current) version is split into 3 methods: this one
|
---|
706 | and two helper functions that deal with the case where namespacePrefix can
|
---|
707 | be anything and where it is particularly specified.</DL>
|
---|
708 | </DD>
|
---|
709 | </DL>
|
---|
710 | <HR>
|
---|
711 |
|
---|
712 | <A NAME="getElementsByTagNameSuffix(org.w3c.dom.Element, java.lang.String, java.util.Vector)"><!-- --></A><H3>
|
---|
713 | getElementsByTagNameSuffix</H3>
|
---|
714 | <PRE>
|
---|
715 | protected static void <B>getElementsByTagNameSuffix</B>(org.w3c.dom.Element parentElement,
|
---|
716 | java.lang.String localName,
|
---|
717 | java.util.Vector v)</PRE>
|
---|
718 | <DL>
|
---|
719 | <DD>Recursive method.
|
---|
720 | At method's end, Vector v will contain those descendent elements of
|
---|
721 | parentElement where the element's name is suffixed by/ends with parameter
|
---|
722 | localName.
|
---|
723 | Related to local method getElementsByTagNameNS(). Deals with the case
|
---|
724 | where any and all (namespace)Prefix of an element is accepted, but where
|
---|
725 | an element name's suffix should match with the given localName.
|
---|
726 | <P>
|
---|
727 | <DD><DL>
|
---|
728 | <DT><B>Parameters:</B><DD><CODE>parentElement</CODE> - us the XML element whose descendants are to be
|
---|
729 | retrieved by the given TagNameSuffix.<DD><CODE>localName</CODE> - is the tagName suffix to retrieve the descendants of
|
---|
730 | parentElement by.<DD><CODE>v</CODE> - is a Vector of all the previously retrieved elements whose tag
|
---|
731 | names are suffixed by localName. This Vector is appended to by recursive
|
---|
732 | calls to this method.</DL>
|
---|
733 | </DD>
|
---|
734 | </DL>
|
---|
735 | <HR>
|
---|
736 |
|
---|
737 | <A NAME="getElementsByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String, java.util.Vector)"><!-- --></A><H3>
|
---|
738 | getElementsByTagNameNS</H3>
|
---|
739 | <PRE>
|
---|
740 | protected static void <B>getElementsByTagNameNS</B>(org.w3c.dom.Element parentElement,
|
---|
741 | java.lang.String namespacePrefix,
|
---|
742 | java.lang.String localName,
|
---|
743 | java.util.Vector v)</PRE>
|
---|
744 | <DL>
|
---|
745 | <DD>At method's end, Vector v will contain those descendent elements of
|
---|
746 | parentElement where the element's name is prefixed by namespacePrefix
|
---|
747 | and suffixed by localName.
|
---|
748 | Related to local method getElementsByTagNameNS(). Deals with the case
|
---|
749 | where a particular (namespace)Prefix of an element and suffix (localname)
|
---|
750 | are given and an element's name should match both prefix and suffix.
|
---|
751 | <P>
|
---|
752 | <DD><DL>
|
---|
753 | <DT><B>Parameters:</B><DD><CODE>parentElement</CODE> - is the XML element whose descendants are to be
|
---|
754 | retrieved by the given TagNameSuffix.<DD><CODE>namespacePrefix</CODE> - is the namespace prefix to look for in the
|
---|
755 | 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
|
---|
756 | parentElement that will be collected in Vector v.<DD><CODE>v</CODE> - is a Vector of all the previously retrieved elements whose tag
|
---|
757 | names are prefixed by namespacePrefix and suffixed by localName.
|
---|
758 | This Vector is appended to by recursive calls to this method.</DL>
|
---|
759 | </DD>
|
---|
760 | </DL>
|
---|
761 | <HR>
|
---|
762 |
|
---|
763 | <A NAME="getNamespace()"><!-- --></A><H3>
|
---|
764 | getNamespace</H3>
|
---|
765 | <PRE>
|
---|
766 | public java.lang.String <B>getNamespace</B>()</PRE>
|
---|
767 | <DL>
|
---|
768 | <DD><DL>
|
---|
769 |
|
---|
770 | <DT><B>Returns:</B><DD>the namespace of the wsdl file.</DL>
|
---|
771 | </DD>
|
---|
772 | </DL>
|
---|
773 | <HR>
|
---|
774 |
|
---|
775 | <A NAME="getService()"><!-- --></A><H3>
|
---|
776 | getService</H3>
|
---|
777 | <PRE>
|
---|
778 | public java.lang.String <B>getService</B>()</PRE>
|
---|
779 | <DL>
|
---|
780 | <DD><DL>
|
---|
781 |
|
---|
782 | <DT><B>Returns:</B><DD>the web service's serviceName without the namespace</DL>
|
---|
783 | </DD>
|
---|
784 | </DL>
|
---|
785 | <HR>
|
---|
786 |
|
---|
787 | <A NAME="getPort()"><!-- --></A><H3>
|
---|
788 | getPort</H3>
|
---|
789 | <PRE>
|
---|
790 | public java.lang.String <B>getPort</B>()</PRE>
|
---|
791 | <DL>
|
---|
792 | <DD><DL>
|
---|
793 |
|
---|
794 | <DT><B>Returns:</B><DD>the web service's portName without the namespace</DL>
|
---|
795 | </DD>
|
---|
796 | </DL>
|
---|
797 | <HR>
|
---|
798 |
|
---|
799 | <A NAME="getWsdl()"><!-- --></A><H3>
|
---|
800 | getWsdl</H3>
|
---|
801 | <PRE>
|
---|
802 | public java.lang.String <B>getWsdl</B>()</PRE>
|
---|
803 | <DL>
|
---|
804 | <DD><DL>
|
---|
805 |
|
---|
806 | <DT><B>Returns:</B><DD>the the URL of the wsdl file.</DL>
|
---|
807 | </DD>
|
---|
808 | </DL>
|
---|
809 | <HR>
|
---|
810 |
|
---|
811 | <A NAME="invokeWith(java.lang.Object[])"><!-- --></A><H3>
|
---|
812 | invokeWith</H3>
|
---|
813 | <PRE>
|
---|
814 | protected java.lang.String <B>invokeWith</B>(java.lang.Object[] params)</PRE>
|
---|
815 | <DL>
|
---|
816 | <DD>Helper method. Uses the Call object to invoke the operation (already
|
---|
817 | set prior to calling invokeWith()) with the given parameters.
|
---|
818 | <P>
|
---|
819 | <DD><DL>
|
---|
820 | </DL>
|
---|
821 | </DD>
|
---|
822 | </DL>
|
---|
823 | <HR>
|
---|
824 |
|
---|
825 | <A NAME="addStringParam(java.lang.String)"><!-- --></A><H3>
|
---|
826 | addStringParam</H3>
|
---|
827 | <PRE>
|
---|
828 | protected void <B>addStringParam</B>(java.lang.String paramName)</PRE>
|
---|
829 | <DL>
|
---|
830 | <DD>Helper method. Adds a string parameter by the name of paramName to
|
---|
831 | the Call object.
|
---|
832 | <P>
|
---|
833 | <DD><DL>
|
---|
834 | <DT><B>Parameters:</B><DD><CODE>paramName</CODE> - - the name of the String parameter to add to the call
|
---|
835 | object</DL>
|
---|
836 | </DD>
|
---|
837 | </DL>
|
---|
838 | <HR>
|
---|
839 |
|
---|
840 | <A NAME="addArrayParam(java.lang.String)"><!-- --></A><H3>
|
---|
841 | addArrayParam</H3>
|
---|
842 | <PRE>
|
---|
843 | protected void <B>addArrayParam</B>(java.lang.String arrayParamName)</PRE>
|
---|
844 | <DL>
|
---|
845 | <DD>Helper method. Adds an array parameter by the name of arrayParamName
|
---|
846 | to the Call object.
|
---|
847 | <P>
|
---|
848 | <DD><DL>
|
---|
849 | <DT><B>Parameters:</B><DD><CODE>arrayParamName</CODE> - - the name of the Array parameter to add to the
|
---|
850 | Call object</DL>
|
---|
851 | </DD>
|
---|
852 | </DL>
|
---|
853 | <HR>
|
---|
854 |
|
---|
855 | <A NAME="describe(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
856 | describe</H3>
|
---|
857 | <PRE>
|
---|
858 | public java.lang.String <B>describe</B>(java.lang.String lang,
|
---|
859 | java.lang.String subsetOption)</PRE>
|
---|
860 | <DL>
|
---|
861 | <DD>Describe request message sent to the Message Router.
|
---|
862 | <P>
|
---|
863 | <DD><DL>
|
---|
864 | <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
|
---|
865 | For the Message Router this can be collectionList, serviceClusterList,
|
---|
866 | 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>
|
---|
867 | </DD>
|
---|
868 | </DL>
|
---|
869 | <HR>
|
---|
870 |
|
---|
871 | <A NAME="describeServiceCluster(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
872 | describeServiceCluster</H3>
|
---|
873 | <PRE>
|
---|
874 | public java.lang.String <B>describeServiceCluster</B>(java.lang.String serviceCluster,
|
---|
875 | java.lang.String lang,
|
---|
876 | java.lang.String subsetOption)</PRE>
|
---|
877 | <DL>
|
---|
878 | <DD>For sending Describe messages to ServiceClusters.
|
---|
879 | <P>
|
---|
880 | <DD><DL>
|
---|
881 | <DT><B>Parameters:</B><DD><CODE>serviceCluster</CODE> - is the name of the Service Cluster that this describe
|
---|
882 | 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
|
---|
883 | 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>
|
---|
884 | </DD>
|
---|
885 | </DL>
|
---|
886 | <HR>
|
---|
887 |
|
---|
888 | <A NAME="describeCollection(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
889 | describeCollection</H3>
|
---|
890 | <PRE>
|
---|
891 | public java.lang.String <B>describeCollection</B>(java.lang.String collection,
|
---|
892 | java.lang.String lang,
|
---|
893 | java.lang.String subsetOption)</PRE>
|
---|
894 | <DL>
|
---|
895 | <DD>For sending Describe messages to Collections.
|
---|
896 | <P>
|
---|
897 | <DD><DL>
|
---|
898 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection that this describe request
|
---|
899 | 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
|
---|
900 | 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>
|
---|
901 | </DD>
|
---|
902 | </DL>
|
---|
903 | <HR>
|
---|
904 |
|
---|
905 | <A NAME="describeCollectionService(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
906 | describeCollectionService</H3>
|
---|
907 | <PRE>
|
---|
908 | public java.lang.String <B>describeCollectionService</B>(java.lang.String collection,
|
---|
909 | java.lang.String service,
|
---|
910 | java.lang.String lang,
|
---|
911 | java.lang.String subsetOption)</PRE>
|
---|
912 | <DL>
|
---|
913 | <DD>For sending a describe message to a Collection's Service.
|
---|
914 | <P>
|
---|
915 | <DD><DL>
|
---|
916 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose service
|
---|
917 | this describe request is sent to.<DD><CODE>service</CODE> - is the name of the Service (of that collection) to
|
---|
918 | 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
|
---|
919 | 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>
|
---|
920 | </DD>
|
---|
921 | </DL>
|
---|
922 | <HR>
|
---|
923 |
|
---|
924 | <A NAME="describeService(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
925 | describeService</H3>
|
---|
926 | <PRE>
|
---|
927 | public java.lang.String <B>describeService</B>(java.lang.String service,
|
---|
928 | java.lang.String lang,
|
---|
929 | java.lang.String subsetOption)</PRE>
|
---|
930 | <DL>
|
---|
931 | <DD>For sending a describe message to a Service hosted by the Message Router
|
---|
932 | (no collection).
|
---|
933 | <P>
|
---|
934 | <DD><DL>
|
---|
935 | <DT><B>Parameters:</B><DD><CODE>service</CODE> - is the name of the MessageRouter's Service to which this
|
---|
936 | 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
|
---|
937 | 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>
|
---|
938 | </DD>
|
---|
939 | </DL>
|
---|
940 | <HR>
|
---|
941 |
|
---|
942 | <A NAME="query(java.lang.String, java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3>
|
---|
943 | query</H3>
|
---|
944 | <PRE>
|
---|
945 | public java.lang.String <B>query</B>(java.lang.String collection,
|
---|
946 | java.lang.String service,
|
---|
947 | java.lang.String lang,
|
---|
948 | java.util.Map nameToValsMap)</PRE>
|
---|
949 | <DL>
|
---|
950 | <DD>For executing a (process-type message) query-type service.
|
---|
951 | <P>
|
---|
952 | <DD><DL>
|
---|
953 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose query service this
|
---|
954 | 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
|
---|
955 | 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
|
---|
956 | parameters of the query. The field names should be those recognised by
|
---|
957 | Greenstone 3. That is, the names must exist for the (Collection-)Service Query that this
|
---|
958 | message is sent To (as given in 'to' argument).
|
---|
959 | 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>,
|
---|
960 | <a href="http://wiki.greenstone.org/wiki/index.php/Actions_and_Arguments">Greenstone wiki - Actions and Arguments</a>,
|
---|
961 | <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>
|
---|
962 | </DD>
|
---|
963 | </DL>
|
---|
964 | <HR>
|
---|
965 |
|
---|
966 | <A NAME="retrieveDocumentContent(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
967 | retrieveDocumentContent</H3>
|
---|
968 | <PRE>
|
---|
969 | public java.lang.String <B>retrieveDocumentContent</B>(java.lang.String collection,
|
---|
970 | java.lang.String lang,
|
---|
971 | java.lang.String[] docNodeIDs)</PRE>
|
---|
972 | <DL>
|
---|
973 | <DD>(a) DocumentContentRetrieve request sent to a collection's
|
---|
974 | DocumentContentRetrieve service (p.48)
|
---|
975 | <P>
|
---|
976 | <DD><DL>
|
---|
977 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
978 | 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
|
---|
979 | 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>
|
---|
980 | </DD>
|
---|
981 | </DL>
|
---|
982 | <HR>
|
---|
983 |
|
---|
984 | <A NAME="retrieveEntireDocumentStructure(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
985 | retrieveEntireDocumentStructure</H3>
|
---|
986 | <PRE>
|
---|
987 | public java.lang.String <B>retrieveEntireDocumentStructure</B>(java.lang.String collection,
|
---|
988 | java.lang.String lang,
|
---|
989 | java.lang.String[] docNodeIDs)</PRE>
|
---|
990 | <DL>
|
---|
991 | <DD>(b) DocumentStructureRetrieve request sent to a collection's
|
---|
992 | DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
|
---|
993 | the entire document structure.
|
---|
994 | <P>
|
---|
995 | <DD><DL>
|
---|
996 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
997 | 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
|
---|
998 | 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>
|
---|
999 | </DD>
|
---|
1000 | </DL>
|
---|
1001 | <HR>
|
---|
1002 |
|
---|
1003 | <A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
1004 | retrieveDocumentStructure</H3>
|
---|
1005 | <PRE>
|
---|
1006 | public java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String collection,
|
---|
1007 | java.lang.String lang,
|
---|
1008 | java.lang.String[] docNodeIDs,
|
---|
1009 | java.lang.String[] structure,
|
---|
1010 | java.lang.String[] info)</PRE>
|
---|
1011 | <DL>
|
---|
1012 | <DD>DocumentStructureRetrieve request sent to a collection's
|
---|
1013 | DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
|
---|
1014 | the specified part of the document's structure.
|
---|
1015 | <P>
|
---|
1016 | <DD><DL>
|
---|
1017 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
1018 | 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
|
---|
1019 | structure ought to be retrieved.<DD><CODE>structure</CODE> - specifies what structure information needs to
|
---|
1020 | be retrieved. The values can be one or more of ancestors, parent,
|
---|
1021 | siblings, children, descendents (NOTE SPELLING), entire.<DD><CODE>info</CODE> - - for specifying extra information to be retrieved.
|
---|
1022 | Possible values for info parameters are numSiblings, siblingPosition,
|
---|
1023 | 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>
|
---|
1024 | </DD>
|
---|
1025 | </DL>
|
---|
1026 | <HR>
|
---|
1027 |
|
---|
1028 | <A NAME="retrieveAllDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
1029 | retrieveAllDocumentMetadata</H3>
|
---|
1030 | <PRE>
|
---|
1031 | public java.lang.String <B>retrieveAllDocumentMetadata</B>(java.lang.String collection,
|
---|
1032 | java.lang.String lang,
|
---|
1033 | java.lang.String[] docNodeIDs)</PRE>
|
---|
1034 | <DL>
|
---|
1035 | <DD>(c) DocumentMetadataRetrieve request sent to a collection's
|
---|
1036 | DocumentMetadataRetrieve service to retrieve all of a document's metadata.
|
---|
1037 | <P>
|
---|
1038 | <DD><DL>
|
---|
1039 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
1040 | 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
|
---|
1041 | 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>
|
---|
1042 | </DD>
|
---|
1043 | </DL>
|
---|
1044 | <HR>
|
---|
1045 |
|
---|
1046 | <A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
1047 | retrieveDocumentMetadata</H3>
|
---|
1048 | <PRE>
|
---|
1049 | public java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String collection,
|
---|
1050 | java.lang.String lang,
|
---|
1051 | java.lang.String[] docNodeIDs,
|
---|
1052 | java.lang.String[] metaNames)</PRE>
|
---|
1053 | <DL>
|
---|
1054 | <DD>DocumentMetadataRetrieve service to retrieve some specific
|
---|
1055 | metadata values of a document. (Manual on page 47.)
|
---|
1056 | <P>
|
---|
1057 | <DD><DL>
|
---|
1058 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
1059 | 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
|
---|
1060 | structure ought to be retrieved.<DD><CODE>metaNames</CODE> - is a list of metadata names which are requested
|
---|
1061 | 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>
|
---|
1062 | </DD>
|
---|
1063 | </DL>
|
---|
1064 | <HR>
|
---|
1065 |
|
---|
1066 | <A NAME="retrieveAllBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
1067 | retrieveAllBrowseMetadata</H3>
|
---|
1068 | <PRE>
|
---|
1069 | public java.lang.String <B>retrieveAllBrowseMetadata</B>(java.lang.String collection,
|
---|
1070 | java.lang.String categoryName,
|
---|
1071 | java.lang.String lang,
|
---|
1072 | java.lang.String[] nodeIDs)</PRE>
|
---|
1073 | <DL>
|
---|
1074 | <DD>Retrieve all classification Metadata for browsing (sent to the
|
---|
1075 | ClassifierBrowseMetadataRetrieve service).
|
---|
1076 | <P>
|
---|
1077 | <DD><DL>
|
---|
1078 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
1079 | ClassifierBrowseMetadataRetrieve service is called<DD><CODE>categoryName</CODE> - - name of the browsing category, usually
|
---|
1080 | 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
|
---|
1081 | 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>
|
---|
1082 | </DD>
|
---|
1083 | </DL>
|
---|
1084 | <HR>
|
---|
1085 |
|
---|
1086 | <A NAME="retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
1087 | retrieveBrowseMetadata</H3>
|
---|
1088 | <PRE>
|
---|
1089 | public java.lang.String <B>retrieveBrowseMetadata</B>(java.lang.String collection,
|
---|
1090 | java.lang.String categoryName,
|
---|
1091 | java.lang.String lang,
|
---|
1092 | java.lang.String[] nodeIDs,
|
---|
1093 | java.lang.String[] metaNames)</PRE>
|
---|
1094 | <DL>
|
---|
1095 | <DD>ClassifierBrowseMetadataRetrieve service to retrieve some specific
|
---|
1096 | metadata values of a document.
|
---|
1097 | <P>
|
---|
1098 | <DD><DL>
|
---|
1099 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
1100 | ClassifierBrowseMetadataRetrieve service is called<DD><CODE>categoryName</CODE> - - name of the browsing category, usually
|
---|
1101 | "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
|
---|
1102 | for which the metadata ought to be retrieved.<DD><CODE>metaNames</CODE> - is a list of metadata names which are requested
|
---|
1103 | 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>
|
---|
1104 | </DD>
|
---|
1105 | </DL>
|
---|
1106 | <HR>
|
---|
1107 |
|
---|
1108 | <A NAME="browseDescendants(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
1109 | browseDescendants</H3>
|
---|
1110 | <PRE>
|
---|
1111 | public java.lang.String <B>browseDescendants</B>(java.lang.String collection,
|
---|
1112 | java.lang.String browseService,
|
---|
1113 | java.lang.String lang,
|
---|
1114 | java.lang.String[] classifierNodeIDs)</PRE>
|
---|
1115 | <DL>
|
---|
1116 | <DD>To send a browse request for all the descendants of a classifier node.
|
---|
1117 | Useful for getting the entire structure of a top-level
|
---|
1118 | <classificationNode>.
|
---|
1119 | <P>
|
---|
1120 | <DD><DL>
|
---|
1121 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose browse Classifier
|
---|
1122 | Browse Service is called<DD><CODE>browseService</CODE> - is the name of the (Classifier) Browse Service (of
|
---|
1123 | 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
|
---|
1124 | 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>
|
---|
1125 | </DD>
|
---|
1126 | </DL>
|
---|
1127 | <HR>
|
---|
1128 |
|
---|
1129 | <A NAME="browse(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
1130 | browse</H3>
|
---|
1131 | <PRE>
|
---|
1132 | public java.lang.String <B>browse</B>(java.lang.String collection,
|
---|
1133 | java.lang.String browseService,
|
---|
1134 | java.lang.String lang,
|
---|
1135 | java.lang.String[] classifierNodeIDs,
|
---|
1136 | java.lang.String[] structureParams)</PRE>
|
---|
1137 | <DL>
|
---|
1138 | <DD>To send a browse request for specific parts of a classifier node
|
---|
1139 | (children, ancestors, descendants). Useful for getting specific parts
|
---|
1140 | of the structure of a top-level <classificationNode>.
|
---|
1141 | <P>
|
---|
1142 | <DD><DL>
|
---|
1143 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose browse Classifier
|
---|
1144 | Browse Service is called<DD><CODE>browseService</CODE> - is the name of the (Classifier) Browse Service (of
|
---|
1145 | 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
|
---|
1146 | structure ought to be retrieved.<DD><CODE>structureParams</CODE> - the list of parameters indicating what structure
|
---|
1147 | information is requested. Accepted values are ancestors, parent, siblings,
|
---|
1148 | 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>
|
---|
1149 | </DD>
|
---|
1150 | </DL>
|
---|
1151 | <HR>
|
---|
1152 |
|
---|
1153 | <A NAME="help()"><!-- --></A><H3>
|
---|
1154 | help</H3>
|
---|
1155 | <PRE>
|
---|
1156 | public java.lang.String <B>help</B>()</PRE>
|
---|
1157 | <DL>
|
---|
1158 | <DD><DL>
|
---|
1159 |
|
---|
1160 | <DT><B>Returns:</B><DD>a help string for listing all the web service methods.</DL>
|
---|
1161 | </DD>
|
---|
1162 | </DL>
|
---|
1163 | <HR>
|
---|
1164 |
|
---|
1165 | <A NAME="helpWithMethod(java.lang.String)"><!-- --></A><H3>
|
---|
1166 | helpWithMethod</H3>
|
---|
1167 | <PRE>
|
---|
1168 | public java.lang.String <B>helpWithMethod</B>(java.lang.String methodname)</PRE>
|
---|
1169 | <DL>
|
---|
1170 | <DD><DL>
|
---|
1171 | <DT><B>Parameters:</B><DD><CODE>methodname</CODE> - is the name of the method to be described.
|
---|
1172 | <DT><B>Returns:</B><DD>a help string for the given method, explaining what the method
|
---|
1173 | does, what parameters it expects and their types and what it returns.</DL>
|
---|
1174 | </DD>
|
---|
1175 | </DL>
|
---|
1176 | <HR>
|
---|
1177 |
|
---|
1178 | <A NAME="main(java.lang.String[])"><!-- --></A><H3>
|
---|
1179 | main</H3>
|
---|
1180 | <PRE>
|
---|
1181 | public static void <B>main</B>(java.lang.String[] args)</PRE>
|
---|
1182 | <DL>
|
---|
1183 | <DD><DL>
|
---|
1184 | </DL>
|
---|
1185 | </DD>
|
---|
1186 | </DL>
|
---|
1187 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
1188 | <HR>
|
---|
1189 |
|
---|
1190 |
|
---|
1191 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
1192 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
1193 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
1194 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
1195 | <TR>
|
---|
1196 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
1197 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
1198 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
1199 | <TR ALIGN="center" VALIGN="top">
|
---|
1200 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
1201 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
1202 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
1203 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
1204 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
1205 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
1206 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
1207 | </TR>
|
---|
1208 | </TABLE>
|
---|
1209 | </TD>
|
---|
1210 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
1211 | </EM>
|
---|
1212 | </TD>
|
---|
1213 | </TR>
|
---|
1214 |
|
---|
1215 | <TR>
|
---|
1216 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1217 | <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices"><B>PREV CLASS</B></A>
|
---|
1218 | NEXT CLASS</FONT></TD>
|
---|
1219 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1220 | <A HREF="../../../../index.html?org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" target="_top"><B>FRAMES</B></A>
|
---|
1221 | <A HREF="GS3WebServicesQBRAPI.html" target="_top"><B>NO FRAMES</B></A>
|
---|
1222 | <SCRIPT type="text/javascript">
|
---|
1223 | <!--
|
---|
1224 | if(window==top) {
|
---|
1225 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
1226 | }
|
---|
1227 | //-->
|
---|
1228 | </SCRIPT>
|
---|
1229 | <NOSCRIPT>
|
---|
1230 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
1231 | </NOSCRIPT>
|
---|
1232 |
|
---|
1233 |
|
---|
1234 | </FONT></TD>
|
---|
1235 | </TR>
|
---|
1236 | <TR>
|
---|
1237 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1238 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
1239 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1240 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
1241 | </TR>
|
---|
1242 | </TABLE>
|
---|
1243 | <A NAME="skip-navbar_bottom"></A>
|
---|
1244 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
1245 |
|
---|
1246 | <HR>
|
---|
1247 |
|
---|
1248 | </BODY>
|
---|
1249 | </HTML>
|
---|