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:19 NZST 2008 -->
|
---|
6 | <TITLE>
|
---|
7 | QBRSOAPServer
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.greenstone.gs3services.QBRSOAPServer 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="QBRSOAPServer";
|
---|
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/gs3services/AdminSOAPServer.html" title="class in org.greenstone.gs3services"><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/gs3services/QBRSOAPServer.html" target="_top"><B>FRAMES</B></A>
|
---|
58 | <A HREF="QBRSOAPServer.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.gs3services</FONT>
|
---|
88 | <BR>
|
---|
89 | Class QBRSOAPServer</H2>
|
---|
90 | <PRE>
|
---|
91 | java.lang.Object
|
---|
92 | <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3services.QBRSOAPServer</B>
|
---|
93 | </PRE>
|
---|
94 | <HR>
|
---|
95 | <DL>
|
---|
96 | <DT><PRE>public class <B>QBRSOAPServer</B><DT>extends java.lang.Object</DL>
|
---|
97 | </PRE>
|
---|
98 |
|
---|
99 | <P>
|
---|
100 | Class that provides the basic Query, Browse and Retrieve (QBR) web service
|
---|
101 | operations for Greenstone 3.
|
---|
102 | It contains a MessageRouter that carries out all the tasks by calling the
|
---|
103 | appropriate Greenstone functionality for each request message passed to it,
|
---|
104 | and returning a response message.
|
---|
105 |
|
---|
106 | All response messages are returned from the MessageRouter to clients invoking
|
---|
107 | the web services. All return values are strings that represent XML messages.
|
---|
108 |
|
---|
109 | Method help() reads from the file QBRWebServicesHelp.properties to list the web
|
---|
110 | service operations available. Method helpWithMethod(String methodName)
|
---|
111 | reads from the same file to display a description of the requested operation.
|
---|
112 | (These method descriptions are mostly the same as those in the Javadoc
|
---|
113 | comments.)
|
---|
114 |
|
---|
115 | NOTE: to run this class, the folder containing this web service class'
|
---|
116 | properties helpFile should be on the classpath.
|
---|
117 | <P>
|
---|
118 |
|
---|
119 | <P>
|
---|
120 | <DL>
|
---|
121 | <DT><B>Author:</B></DT>
|
---|
122 | <DD>ak19</DD>
|
---|
123 | </DL>
|
---|
124 | <HR>
|
---|
125 |
|
---|
126 | <P>
|
---|
127 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
128 |
|
---|
129 | <A NAME="field_summary"><!-- --></A>
|
---|
130 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
131 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
132 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
133 | <B>Field Summary</B></FONT></TH>
|
---|
134 | </TR>
|
---|
135 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
136 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
137 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
138 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#browseStructureOptions">browseStructureOptions</A></B></CODE>
|
---|
139 |
|
---|
140 | <BR>
|
---|
141 | </TD>
|
---|
142 | </TR>
|
---|
143 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
144 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
145 | <CODE>protected org.greenstone.gsdl3.util.XMLConverter</CODE></FONT></TD>
|
---|
146 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#converter">converter</A></B></CODE>
|
---|
147 |
|
---|
148 | <BR>
|
---|
149 | A converter class to parse XML and create Docs</TD>
|
---|
150 | </TR>
|
---|
151 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
152 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
153 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
154 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#csSubsetOptions">csSubsetOptions</A></B></CODE>
|
---|
155 |
|
---|
156 | <BR>
|
---|
157 | </TD>
|
---|
158 | </TR>
|
---|
159 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
160 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
161 | <CODE>protected org.w3c.dom.Document</CODE></FONT></TD>
|
---|
162 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#doc">doc</A></B></CODE>
|
---|
163 |
|
---|
164 | <BR>
|
---|
165 | Container Document to create XML Nodes</TD>
|
---|
166 | </TR>
|
---|
167 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
168 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
169 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
170 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#docStructureInfo">docStructureInfo</A></B></CODE>
|
---|
171 |
|
---|
172 | <BR>
|
---|
173 | </TD>
|
---|
174 | </TR>
|
---|
175 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
176 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
177 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
178 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#docStructureOptions">docStructureOptions</A></B></CODE>
|
---|
179 |
|
---|
180 | <BR>
|
---|
181 | </TD>
|
---|
182 | </TR>
|
---|
183 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
184 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
185 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
186 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#helpErrormessage">helpErrormessage</A></B></CODE>
|
---|
187 |
|
---|
188 | <BR>
|
---|
189 | Error message loading helpFile.</TD>
|
---|
190 | </TR>
|
---|
191 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
192 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
193 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
194 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#helpFile">helpFile</A></B></CODE>
|
---|
195 |
|
---|
196 | <BR>
|
---|
197 | The help properties file describing the web service operations</TD>
|
---|
198 | </TR>
|
---|
199 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
200 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
201 | <CODE>protected org.greenstone.gsdl3.core.MessageRouter</CODE></FONT></TD>
|
---|
202 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#mr">mr</A></B></CODE>
|
---|
203 |
|
---|
204 | <BR>
|
---|
205 | Message Router object to pass requests messages to and which
|
---|
206 | will process them.</TD>
|
---|
207 | </TR>
|
---|
208 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
209 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
210 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
211 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#mrSubsetOptions">mrSubsetOptions</A></B></CODE>
|
---|
212 |
|
---|
213 | <BR>
|
---|
214 | </TD>
|
---|
215 | </TR>
|
---|
216 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
217 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
218 | <CODE>protected static java.util.Properties</CODE></FONT></TD>
|
---|
219 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#properties">properties</A></B></CODE>
|
---|
220 |
|
---|
221 | <BR>
|
---|
222 | Properties map with mappings from methodname to help
|
---|
223 | description string.</TD>
|
---|
224 | </TR>
|
---|
225 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
226 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
227 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
228 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#serviceSubsetOptions">serviceSubsetOptions</A></B></CODE>
|
---|
229 |
|
---|
230 | <BR>
|
---|
231 | </TD>
|
---|
232 | </TR>
|
---|
233 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
234 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
235 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
236 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#site_name">site_name</A></B></CODE>
|
---|
237 |
|
---|
238 | <BR>
|
---|
239 | site_name the MessageRouter works with, here set to "localsite"</TD>
|
---|
240 | </TR>
|
---|
241 | </TABLE>
|
---|
242 |
|
---|
243 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
244 |
|
---|
245 | <A NAME="constructor_summary"><!-- --></A>
|
---|
246 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
247 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
248 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
249 | <B>Constructor Summary</B></FONT></TH>
|
---|
250 | </TR>
|
---|
251 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
252 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#QBRSOAPServer()">QBRSOAPServer</A></B>()</CODE>
|
---|
253 |
|
---|
254 | <BR>
|
---|
255 | Constructor that initializes the web services' MessageRouter object
|
---|
256 | Reads from GlobalProperties to get gsdl3_home and set the sitename.</TD>
|
---|
257 | </TR>
|
---|
258 | </TABLE>
|
---|
259 |
|
---|
260 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
261 |
|
---|
262 | <A NAME="method_summary"><!-- --></A>
|
---|
263 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
264 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
265 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
266 | <B>Method Summary</B></FONT></TH>
|
---|
267 | </TR>
|
---|
268 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
269 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
270 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
271 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#browse(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">browse</A></B>(java.lang.String collection,
|
---|
272 | java.lang.String browseService,
|
---|
273 | java.lang.String lang,
|
---|
274 | java.lang.String[] classifierNodeIDs,
|
---|
275 | java.lang.String[] structureParams)</CODE>
|
---|
276 |
|
---|
277 | <BR>
|
---|
278 | To send a browse request for specific parts of a classifier node
|
---|
279 | (children, ancestors, descendants).</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/gs3services/QBRSOAPServer.html#browseDescendants(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">browseDescendants</A></B>(java.lang.String collection,
|
---|
285 | java.lang.String browseService,
|
---|
286 | java.lang.String lang,
|
---|
287 | java.lang.String[] classifierNodeIDs)</CODE>
|
---|
288 |
|
---|
289 | <BR>
|
---|
290 | To send a browse request for all the descendants of a classifier node.</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/gs3services/QBRSOAPServer.html#describe(java.lang.String, java.lang.String)">describe</A></B>(java.lang.String lang,
|
---|
296 | java.lang.String subsetOption)</CODE>
|
---|
297 |
|
---|
298 | <BR>
|
---|
299 | Sends a describe message to the MessageRouter.</TD>
|
---|
300 | </TR>
|
---|
301 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
302 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
303 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
304 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#describe(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">describe</A></B>(java.lang.String to,
|
---|
305 | java.lang.String lang,
|
---|
306 | java.lang.String subsetOption,
|
---|
307 | java.lang.String validSubsetOptions)</CODE>
|
---|
308 |
|
---|
309 | <BR>
|
---|
310 | For sending a describe message.</TD>
|
---|
311 | </TR>
|
---|
312 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
313 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
314 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
315 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#describeCollection(java.lang.String, java.lang.String, java.lang.String)">describeCollection</A></B>(java.lang.String collection,
|
---|
316 | java.lang.String lang,
|
---|
317 | java.lang.String subsetOption)</CODE>
|
---|
318 |
|
---|
319 | <BR>
|
---|
320 | For sending Describe messages to Collections.</TD>
|
---|
321 | </TR>
|
---|
322 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
323 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
324 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
325 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#describeCollectionService(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">describeCollectionService</A></B>(java.lang.String collection,
|
---|
326 | java.lang.String service,
|
---|
327 | java.lang.String lang,
|
---|
328 | java.lang.String subsetOption)</CODE>
|
---|
329 |
|
---|
330 | <BR>
|
---|
331 | For sending a describe message to a Collection's Service.</TD>
|
---|
332 | </TR>
|
---|
333 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
334 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
335 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
336 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#describeService(java.lang.String, java.lang.String, java.lang.String)">describeService</A></B>(java.lang.String service,
|
---|
337 | java.lang.String lang,
|
---|
338 | java.lang.String subsetOption)</CODE>
|
---|
339 |
|
---|
340 | <BR>
|
---|
341 | For sending a describe message to a Service hosted by the Message Router
|
---|
342 | (no collection).</TD>
|
---|
343 | </TR>
|
---|
344 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
345 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
346 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
347 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#describeServiceCluster(java.lang.String, java.lang.String, java.lang.String)">describeServiceCluster</A></B>(java.lang.String serviceCluster,
|
---|
348 | java.lang.String lang,
|
---|
349 | java.lang.String subsetOption)</CODE>
|
---|
350 |
|
---|
351 | <BR>
|
---|
352 | For sending Describe messages to ServiceClusters.</TD>
|
---|
353 | </TR>
|
---|
354 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
355 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
356 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
357 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#error(java.lang.String)">error</A></B>(java.lang.String errorMessage)</CODE>
|
---|
358 |
|
---|
359 | <BR>
|
---|
360 | Creates a String response message to represent an XML error response
|
---|
361 | message using the error specified in the message parameter.</TD>
|
---|
362 | </TR>
|
---|
363 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
364 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
365 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
366 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#help()">help</A></B>()</CODE>
|
---|
367 |
|
---|
368 | <BR>
|
---|
369 | </TD>
|
---|
370 | </TR>
|
---|
371 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
372 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
373 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
374 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#helpWithMethod(java.lang.String)">helpWithMethod</A></B>(java.lang.String methodname)</CODE>
|
---|
375 |
|
---|
376 | <BR>
|
---|
377 | </TD>
|
---|
378 | </TR>
|
---|
379 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
380 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
381 | <CODE>static void</CODE></FONT></TD>
|
---|
382 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#main(java.lang.String[])">main</A></B>(java.lang.String[] args)</CODE>
|
---|
383 |
|
---|
384 | <BR>
|
---|
385 | </TD>
|
---|
386 | </TR>
|
---|
387 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
388 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
389 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
390 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#metadataRetrieve(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String)">metadataRetrieve</A></B>(java.lang.String to,
|
---|
391 | java.lang.String lang,
|
---|
392 | java.lang.String[] nodeIDs,
|
---|
393 | java.lang.String[] metaNames,
|
---|
394 | java.lang.String NODE_ELEM)</CODE>
|
---|
395 |
|
---|
396 | <BR>
|
---|
397 | Performs a metadata retrieve for documents and (browse) classification
|
---|
398 | hierarchies.</TD>
|
---|
399 | </TR>
|
---|
400 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
401 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
402 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
403 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#processInternal(org.w3c.dom.Element)">processInternal</A></B>(org.w3c.dom.Element message)</CODE>
|
---|
404 |
|
---|
405 | <BR>
|
---|
406 | Called by most other methods in order to send the constructed message
|
---|
407 | to the Greenstone's MessageRouter, intercept the response and return it.</TD>
|
---|
408 | </TR>
|
---|
409 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
410 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
411 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
412 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#query(java.lang.String, java.lang.String, java.lang.String, java.util.Map)">query</A></B>(java.lang.String collection,
|
---|
413 | java.lang.String service,
|
---|
414 | java.lang.String lang,
|
---|
415 | java.util.Map nameToValsMap)</CODE>
|
---|
416 |
|
---|
417 | <BR>
|
---|
418 | For executing a (process-type message) query-type service.</TD>
|
---|
419 | </TR>
|
---|
420 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
421 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
422 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
423 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#queryProcess(java.lang.String, java.lang.String, org.w3c.dom.Element)">queryProcess</A></B>(java.lang.String to,
|
---|
424 | java.lang.String lang,
|
---|
425 | org.w3c.dom.Element paramList)</CODE>
|
---|
426 |
|
---|
427 | <BR>
|
---|
428 | Values for field Names given in the paramList must exist for the
|
---|
429 | (Collection-)Service Query that this message is sent To (as given in the
|
---|
430 | 'to' argument).</TD>
|
---|
431 | </TR>
|
---|
432 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
433 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
434 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
435 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#retrieveAllBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">retrieveAllBrowseMetadata</A></B>(java.lang.String collection,
|
---|
436 | java.lang.String categoryName,
|
---|
437 | java.lang.String lang,
|
---|
438 | java.lang.String[] nodeIDs)</CODE>
|
---|
439 |
|
---|
440 | <BR>
|
---|
441 | Retrieve all classification Metadata for browsing (sent to the
|
---|
442 | ClassifierBrowseMetadataRetrieve service).</TD>
|
---|
443 | </TR>
|
---|
444 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
445 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
446 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
447 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#retrieveAllDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveAllDocumentMetadata</A></B>(java.lang.String collection,
|
---|
448 | java.lang.String lang,
|
---|
449 | java.lang.String[] docNodeIDs)</CODE>
|
---|
450 |
|
---|
451 | <BR>
|
---|
452 | DocumentMetadataRetrieve request sent to a collection's
|
---|
453 | DocumentMetadataRetrieve service to retrieve all of a document's metadata.</TD>
|
---|
454 | </TR>
|
---|
455 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
456 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
457 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
458 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">retrieveBrowseMetadata</A></B>(java.lang.String collection,
|
---|
459 | java.lang.String categoryName,
|
---|
460 | java.lang.String lang,
|
---|
461 | java.lang.String[] nodeIDs,
|
---|
462 | java.lang.String[] metaNames)</CODE>
|
---|
463 |
|
---|
464 | <BR>
|
---|
465 | ClassifierBrowseMetadataRetrieve service to retrieve some specific
|
---|
466 | metadata values of a document.</TD>
|
---|
467 | </TR>
|
---|
468 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
469 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
470 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
471 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#retrieveDocumentContent(java.lang.String, java.lang.String, java.lang.String[])">retrieveDocumentContent</A></B>(java.lang.String collection,
|
---|
472 | java.lang.String lang,
|
---|
473 | java.lang.String[] docNodeIDs)</CODE>
|
---|
474 |
|
---|
475 | <BR>
|
---|
476 | DocumentContentRetrieve request sent to a collection's
|
---|
477 | DocumentContentRetrieve service (see manual, p.48)</TD>
|
---|
478 | </TR>
|
---|
479 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
480 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
481 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
482 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#retrieveDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">retrieveDocumentMetadata</A></B>(java.lang.String collection,
|
---|
483 | java.lang.String lang,
|
---|
484 | java.lang.String[] docNodeIDs,
|
---|
485 | java.lang.String[] metaNames)</CODE>
|
---|
486 |
|
---|
487 | <BR>
|
---|
488 | DocumentMetadataRetrieve service to retrieve some specific
|
---|
489 | metadata values of a document.</TD>
|
---|
490 | </TR>
|
---|
491 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
492 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
493 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
494 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#retrieveDocumentStructure(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[])">retrieveDocumentStructure</A></B>(java.lang.String collection,
|
---|
495 | java.lang.String lang,
|
---|
496 | java.lang.String[] docNodeIDs,
|
---|
497 | java.lang.String[] structure,
|
---|
498 | java.lang.String[] info)</CODE>
|
---|
499 |
|
---|
500 | <BR>
|
---|
501 | DocumentStructureRetrieve request sent to a collection's
|
---|
502 | DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
|
---|
503 | the specified part of the document's structure.</TD>
|
---|
504 | </TR>
|
---|
505 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
506 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
507 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
508 | <TD><CODE><B><A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html#retrieveEntireDocumentStructure(java.lang.String, java.lang.String, java.lang.String[])">retrieveEntireDocumentStructure</A></B>(java.lang.String collection,
|
---|
509 | java.lang.String lang,
|
---|
510 | java.lang.String[] docNodeIDs)</CODE>
|
---|
511 |
|
---|
512 | <BR>
|
---|
513 | DocumentStructureRetrieve request sent to a collection's
|
---|
514 | DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
|
---|
515 | the entire document structure.</TD>
|
---|
516 | </TR>
|
---|
517 | </TABLE>
|
---|
518 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
519 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
520 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
521 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
---|
522 | </TR>
|
---|
523 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
524 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
525 | </TR>
|
---|
526 | </TABLE>
|
---|
527 |
|
---|
528 | <P>
|
---|
529 |
|
---|
530 | <!-- ============ FIELD DETAIL =========== -->
|
---|
531 |
|
---|
532 | <A NAME="field_detail"><!-- --></A>
|
---|
533 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
534 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
535 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
536 | <B>Field Detail</B></FONT></TH>
|
---|
537 | </TR>
|
---|
538 | </TABLE>
|
---|
539 |
|
---|
540 | <A NAME="helpErrormessage"><!-- --></A><H3>
|
---|
541 | helpErrormessage</H3>
|
---|
542 | <PRE>
|
---|
543 | protected static java.lang.String <B>helpErrormessage</B></PRE>
|
---|
544 | <DL>
|
---|
545 | <DD>Error message loading helpFile. Remains at "" if everything is fine
|
---|
546 | <P>
|
---|
547 | <DL>
|
---|
548 | </DL>
|
---|
549 | </DL>
|
---|
550 | <HR>
|
---|
551 |
|
---|
552 | <A NAME="properties"><!-- --></A><H3>
|
---|
553 | properties</H3>
|
---|
554 | <PRE>
|
---|
555 | protected static java.util.Properties <B>properties</B></PRE>
|
---|
556 | <DL>
|
---|
557 | <DD>Properties map with mappings from methodname to help
|
---|
558 | description string.
|
---|
559 | <P>
|
---|
560 | <DL>
|
---|
561 | </DL>
|
---|
562 | </DL>
|
---|
563 | <HR>
|
---|
564 |
|
---|
565 | <A NAME="helpFile"><!-- --></A><H3>
|
---|
566 | helpFile</H3>
|
---|
567 | <PRE>
|
---|
568 | protected static java.lang.String <B>helpFile</B></PRE>
|
---|
569 | <DL>
|
---|
570 | <DD>The help properties file describing the web service operations
|
---|
571 | <P>
|
---|
572 | <DL>
|
---|
573 | </DL>
|
---|
574 | </DL>
|
---|
575 | <HR>
|
---|
576 |
|
---|
577 | <A NAME="site_name"><!-- --></A><H3>
|
---|
578 | site_name</H3>
|
---|
579 | <PRE>
|
---|
580 | protected java.lang.String <B>site_name</B></PRE>
|
---|
581 | <DL>
|
---|
582 | <DD>site_name the MessageRouter works with, here set to "localsite"
|
---|
583 | <P>
|
---|
584 | <DL>
|
---|
585 | </DL>
|
---|
586 | </DL>
|
---|
587 | <HR>
|
---|
588 |
|
---|
589 | <A NAME="mr"><!-- --></A><H3>
|
---|
590 | mr</H3>
|
---|
591 | <PRE>
|
---|
592 | protected org.greenstone.gsdl3.core.MessageRouter <B>mr</B></PRE>
|
---|
593 | <DL>
|
---|
594 | <DD>Message Router object to pass requests messages to and which
|
---|
595 | will process them.
|
---|
596 | <P>
|
---|
597 | <DL>
|
---|
598 | </DL>
|
---|
599 | </DL>
|
---|
600 | <HR>
|
---|
601 |
|
---|
602 | <A NAME="doc"><!-- --></A><H3>
|
---|
603 | doc</H3>
|
---|
604 | <PRE>
|
---|
605 | protected org.w3c.dom.Document <B>doc</B></PRE>
|
---|
606 | <DL>
|
---|
607 | <DD>Container Document to create XML Nodes
|
---|
608 | <P>
|
---|
609 | <DL>
|
---|
610 | </DL>
|
---|
611 | </DL>
|
---|
612 | <HR>
|
---|
613 |
|
---|
614 | <A NAME="converter"><!-- --></A><H3>
|
---|
615 | converter</H3>
|
---|
616 | <PRE>
|
---|
617 | protected org.greenstone.gsdl3.util.XMLConverter <B>converter</B></PRE>
|
---|
618 | <DL>
|
---|
619 | <DD>A converter class to parse XML and create Docs
|
---|
620 | <P>
|
---|
621 | <DL>
|
---|
622 | </DL>
|
---|
623 | </DL>
|
---|
624 | <HR>
|
---|
625 |
|
---|
626 | <A NAME="mrSubsetOptions"><!-- --></A><H3>
|
---|
627 | mrSubsetOptions</H3>
|
---|
628 | <PRE>
|
---|
629 | protected static final java.lang.String <B>mrSubsetOptions</B></PRE>
|
---|
630 | <DL>
|
---|
631 | <DL>
|
---|
632 | <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3services.QBRSOAPServer.mrSubsetOptions">Constant Field Values</A></DL>
|
---|
633 | </DL>
|
---|
634 | <HR>
|
---|
635 |
|
---|
636 | <A NAME="csSubsetOptions"><!-- --></A><H3>
|
---|
637 | csSubsetOptions</H3>
|
---|
638 | <PRE>
|
---|
639 | protected static final java.lang.String <B>csSubsetOptions</B></PRE>
|
---|
640 | <DL>
|
---|
641 | <DL>
|
---|
642 | <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3services.QBRSOAPServer.csSubsetOptions">Constant Field Values</A></DL>
|
---|
643 | </DL>
|
---|
644 | <HR>
|
---|
645 |
|
---|
646 | <A NAME="serviceSubsetOptions"><!-- --></A><H3>
|
---|
647 | serviceSubsetOptions</H3>
|
---|
648 | <PRE>
|
---|
649 | protected static final java.lang.String <B>serviceSubsetOptions</B></PRE>
|
---|
650 | <DL>
|
---|
651 | <DL>
|
---|
652 | <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3services.QBRSOAPServer.serviceSubsetOptions">Constant Field Values</A></DL>
|
---|
653 | </DL>
|
---|
654 | <HR>
|
---|
655 |
|
---|
656 | <A NAME="docStructureOptions"><!-- --></A><H3>
|
---|
657 | docStructureOptions</H3>
|
---|
658 | <PRE>
|
---|
659 | protected static final java.lang.String <B>docStructureOptions</B></PRE>
|
---|
660 | <DL>
|
---|
661 | <DL>
|
---|
662 | <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3services.QBRSOAPServer.docStructureOptions">Constant Field Values</A></DL>
|
---|
663 | </DL>
|
---|
664 | <HR>
|
---|
665 |
|
---|
666 | <A NAME="docStructureInfo"><!-- --></A><H3>
|
---|
667 | docStructureInfo</H3>
|
---|
668 | <PRE>
|
---|
669 | protected static final java.lang.String <B>docStructureInfo</B></PRE>
|
---|
670 | <DL>
|
---|
671 | <DL>
|
---|
672 | <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3services.QBRSOAPServer.docStructureInfo">Constant Field Values</A></DL>
|
---|
673 | </DL>
|
---|
674 | <HR>
|
---|
675 |
|
---|
676 | <A NAME="browseStructureOptions"><!-- --></A><H3>
|
---|
677 | browseStructureOptions</H3>
|
---|
678 | <PRE>
|
---|
679 | protected static final java.lang.String <B>browseStructureOptions</B></PRE>
|
---|
680 | <DL>
|
---|
681 | <DL>
|
---|
682 | <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.greenstone.gs3services.QBRSOAPServer.browseStructureOptions">Constant Field Values</A></DL>
|
---|
683 | </DL>
|
---|
684 |
|
---|
685 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
686 |
|
---|
687 | <A NAME="constructor_detail"><!-- --></A>
|
---|
688 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
689 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
690 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
691 | <B>Constructor Detail</B></FONT></TH>
|
---|
692 | </TR>
|
---|
693 | </TABLE>
|
---|
694 |
|
---|
695 | <A NAME="QBRSOAPServer()"><!-- --></A><H3>
|
---|
696 | QBRSOAPServer</H3>
|
---|
697 | <PRE>
|
---|
698 | public <B>QBRSOAPServer</B>()</PRE>
|
---|
699 | <DL>
|
---|
700 | <DD>Constructor that initializes the web services' MessageRouter object
|
---|
701 | Reads from GlobalProperties to get gsdl3_home and set the sitename.
|
---|
702 | <P>
|
---|
703 | </DL>
|
---|
704 |
|
---|
705 | <!-- ============ METHOD DETAIL ========== -->
|
---|
706 |
|
---|
707 | <A NAME="method_detail"><!-- --></A>
|
---|
708 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
709 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
710 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
711 | <B>Method Detail</B></FONT></TH>
|
---|
712 | </TR>
|
---|
713 | </TABLE>
|
---|
714 |
|
---|
715 | <A NAME="describe(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
716 | describe</H3>
|
---|
717 | <PRE>
|
---|
718 | public java.lang.String <B>describe</B>(java.lang.String lang,
|
---|
719 | java.lang.String subsetOption)</PRE>
|
---|
720 | <DL>
|
---|
721 | <DD>Sends a describe message to the MessageRouter.
|
---|
722 | <P>
|
---|
723 | <DD><DL>
|
---|
724 | <DT><B>Parameters:</B><DD><CODE>lang</CODE> - is the language of the display content in the response.<DD><CODE>subsetOption</CODE> - are the requested list of items to return in the
|
---|
725 | response. For the Message Router this can be collectionList,
|
---|
726 | serviceClusterList, 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>
|
---|
727 | </DD>
|
---|
728 | </DL>
|
---|
729 | <HR>
|
---|
730 |
|
---|
731 | <A NAME="describeServiceCluster(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
732 | describeServiceCluster</H3>
|
---|
733 | <PRE>
|
---|
734 | public java.lang.String <B>describeServiceCluster</B>(java.lang.String serviceCluster,
|
---|
735 | java.lang.String lang,
|
---|
736 | java.lang.String subsetOption)</PRE>
|
---|
737 | <DL>
|
---|
738 | <DD>For sending Describe messages to ServiceClusters.
|
---|
739 | <P>
|
---|
740 | <DD><DL>
|
---|
741 | <DT><B>Parameters:</B><DD><CODE>serviceCluster</CODE> - is the name of the Service Cluster that this describe
|
---|
742 | 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
|
---|
743 | 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>
|
---|
744 | </DD>
|
---|
745 | </DL>
|
---|
746 | <HR>
|
---|
747 |
|
---|
748 | <A NAME="describeCollection(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
749 | describeCollection</H3>
|
---|
750 | <PRE>
|
---|
751 | public java.lang.String <B>describeCollection</B>(java.lang.String collection,
|
---|
752 | java.lang.String lang,
|
---|
753 | java.lang.String subsetOption)</PRE>
|
---|
754 | <DL>
|
---|
755 | <DD>For sending Describe messages to Collections.
|
---|
756 | <P>
|
---|
757 | <DD><DL>
|
---|
758 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection that this describe request
|
---|
759 | 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
|
---|
760 | 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>
|
---|
761 | </DD>
|
---|
762 | </DL>
|
---|
763 | <HR>
|
---|
764 |
|
---|
765 | <A NAME="describeCollectionService(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
766 | describeCollectionService</H3>
|
---|
767 | <PRE>
|
---|
768 | public java.lang.String <B>describeCollectionService</B>(java.lang.String collection,
|
---|
769 | java.lang.String service,
|
---|
770 | java.lang.String lang,
|
---|
771 | java.lang.String subsetOption)</PRE>
|
---|
772 | <DL>
|
---|
773 | <DD>For sending a describe message to a Collection's Service.
|
---|
774 | <P>
|
---|
775 | <DD><DL>
|
---|
776 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose service
|
---|
777 | this describe request is sent to.<DD><CODE>service</CODE> - is the name of the Service (of that collection) to
|
---|
778 | 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
|
---|
779 | 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>
|
---|
780 | </DD>
|
---|
781 | </DL>
|
---|
782 | <HR>
|
---|
783 |
|
---|
784 | <A NAME="describeService(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
785 | describeService</H3>
|
---|
786 | <PRE>
|
---|
787 | public java.lang.String <B>describeService</B>(java.lang.String service,
|
---|
788 | java.lang.String lang,
|
---|
789 | java.lang.String subsetOption)</PRE>
|
---|
790 | <DL>
|
---|
791 | <DD>For sending a describe message to a Service hosted by the Message Router
|
---|
792 | (no collection).
|
---|
793 | <P>
|
---|
794 | <DD><DL>
|
---|
795 | <DT><B>Parameters:</B><DD><CODE>service</CODE> - is the name of the MessageRouter's Service to which this
|
---|
796 | 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
|
---|
797 | 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>
|
---|
798 | </DD>
|
---|
799 | </DL>
|
---|
800 | <HR>
|
---|
801 |
|
---|
802 | <A NAME="describe(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
803 | describe</H3>
|
---|
804 | <PRE>
|
---|
805 | protected java.lang.String <B>describe</B>(java.lang.String to,
|
---|
806 | java.lang.String lang,
|
---|
807 | java.lang.String subsetOption,
|
---|
808 | java.lang.String validSubsetOptions)</PRE>
|
---|
809 | <DL>
|
---|
810 | <DD>For sending a describe message.
|
---|
811 | If public, this method would give full access: a describe message that
|
---|
812 | lets the user specify all the details of who the receiver is, and what
|
---|
813 | details are requested.
|
---|
814 | <P>
|
---|
815 | <DD><DL>
|
---|
816 | <DT><B>Parameters:</B><DD><CODE>to</CODE> - - the Greenstone module (MessageRouter, Collection,
|
---|
817 | ServiceCluster or (Collection-)Service to send this describe message to.
|
---|
818 | (The module asked to describe itself.)<DD><CODE>lang</CODE> - - the language of the display content in the response.<DD><CODE>subsetOption</CODE> - - the set of elements of the describe response that
|
---|
819 | are requested. These vary depending on the GS3 module asked to describe
|
---|
820 | itself.<DD><CODE>validSubsetOptions</CODE> - - the list of subsetOptions that are allowed
|
---|
821 | for the module this describe message is sent to. Parameter subsetOption
|
---|
822 | has to be among the list of validSubsetOptions.<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>
|
---|
823 | </DD>
|
---|
824 | </DL>
|
---|
825 | <HR>
|
---|
826 |
|
---|
827 | <A NAME="query(java.lang.String, java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3>
|
---|
828 | query</H3>
|
---|
829 | <PRE>
|
---|
830 | public java.lang.String <B>query</B>(java.lang.String collection,
|
---|
831 | java.lang.String service,
|
---|
832 | java.lang.String lang,
|
---|
833 | java.util.Map nameToValsMap)</PRE>
|
---|
834 | <DL>
|
---|
835 | <DD>For executing a (process-type message) query-type service.
|
---|
836 | <P>
|
---|
837 | <DD><DL>
|
---|
838 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose query service this
|
---|
839 | 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
|
---|
840 | 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
|
---|
841 | parameters of the query. The field names should be those recognised by
|
---|
842 | Greenstone 3. That is, the names must exist for the (Collection-)Service Query that this
|
---|
843 | message is sent To (as given in 'to' argument).
|
---|
844 | For names of Greenstone-accepted 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>,
|
---|
845 | <a href="http://wiki.greenstone.org/wiki/index.php/Actions_and_Arguments">Greenstone wiki - Actions and Arguments</a></DL>
|
---|
846 | </DD>
|
---|
847 | </DL>
|
---|
848 | <HR>
|
---|
849 |
|
---|
850 | <A NAME="queryProcess(java.lang.String, java.lang.String, org.w3c.dom.Element)"><!-- --></A><H3>
|
---|
851 | queryProcess</H3>
|
---|
852 | <PRE>
|
---|
853 | protected java.lang.String <B>queryProcess</B>(java.lang.String to,
|
---|
854 | java.lang.String lang,
|
---|
855 | org.w3c.dom.Element paramList)</PRE>
|
---|
856 | <DL>
|
---|
857 | <DD>Values for field Names given in the paramList must exist for the
|
---|
858 | (Collection-)Service Query that this message is sent To (as given in the
|
---|
859 | 'to' argument).
|
---|
860 | <P>
|
---|
861 | <DD><DL>
|
---|
862 | <DT><B>Parameters:</B><DD><CODE>to</CODE> - - the (Collection-)Service Query that this message is sent To<DD><CODE>lang</CODE> - - the language of the display items in the response<DD><CODE>paramList</CODE> - - XML Dom Element representing the list of field names,
|
---|
863 | and associated values required for executing the query.
|
---|
864 | For names of Greenstone-accepted 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>,
|
---|
865 | <a href="http://wiki.greenstone.org/wiki/index.php/Actions_and_Arguments">Greenstone wiki - Actions and Arguments<a></DL>
|
---|
866 | </DD>
|
---|
867 | </DL>
|
---|
868 | <HR>
|
---|
869 |
|
---|
870 | <A NAME="retrieveDocumentContent(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
871 | retrieveDocumentContent</H3>
|
---|
872 | <PRE>
|
---|
873 | public java.lang.String <B>retrieveDocumentContent</B>(java.lang.String collection,
|
---|
874 | java.lang.String lang,
|
---|
875 | java.lang.String[] docNodeIDs)</PRE>
|
---|
876 | <DL>
|
---|
877 | <DD>DocumentContentRetrieve request sent to a collection's
|
---|
878 | DocumentContentRetrieve service (see manual, p.48)
|
---|
879 | <P>
|
---|
880 | <DD><DL>
|
---|
881 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
882 | 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
|
---|
883 | 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>
|
---|
884 | </DD>
|
---|
885 | </DL>
|
---|
886 | <HR>
|
---|
887 |
|
---|
888 | <A NAME="retrieveEntireDocumentStructure(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
889 | retrieveEntireDocumentStructure</H3>
|
---|
890 | <PRE>
|
---|
891 | public java.lang.String <B>retrieveEntireDocumentStructure</B>(java.lang.String collection,
|
---|
892 | java.lang.String lang,
|
---|
893 | java.lang.String[] docNodeIDs)</PRE>
|
---|
894 | <DL>
|
---|
895 | <DD>DocumentStructureRetrieve request sent to a collection's
|
---|
896 | DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
|
---|
897 | the entire document structure.
|
---|
898 | <P>
|
---|
899 | <DD><DL>
|
---|
900 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
901 | 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
|
---|
902 | 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>
|
---|
903 | </DD>
|
---|
904 | </DL>
|
---|
905 | <HR>
|
---|
906 |
|
---|
907 | <A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
908 | retrieveDocumentStructure</H3>
|
---|
909 | <PRE>
|
---|
910 | public java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String collection,
|
---|
911 | java.lang.String lang,
|
---|
912 | java.lang.String[] docNodeIDs,
|
---|
913 | java.lang.String[] structure,
|
---|
914 | java.lang.String[] info)</PRE>
|
---|
915 | <DL>
|
---|
916 | <DD>DocumentStructureRetrieve request sent to a collection's
|
---|
917 | DocumentStructureRetrieve service (manual pp.48, 49) to retrieve
|
---|
918 | the specified part of the document's structure.
|
---|
919 | <P>
|
---|
920 | <DD><DL>
|
---|
921 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
922 | 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
|
---|
923 | structure ought to be retrieved.<DD><CODE>structure</CODE> - specifies what structure information needs to
|
---|
924 | be retrieved. The values can be one or more of ancestors, parent,
|
---|
925 | siblings, children, descendants (<b>note spelling</b>), entire.<DD><CODE>info</CODE> - - for specifying extra information to be retrieved.
|
---|
926 | Possible values for info parameters are numSiblings, siblingPosition,
|
---|
927 | 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>
|
---|
928 | </DD>
|
---|
929 | </DL>
|
---|
930 | <HR>
|
---|
931 |
|
---|
932 | <A NAME="retrieveAllDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
933 | retrieveAllDocumentMetadata</H3>
|
---|
934 | <PRE>
|
---|
935 | public java.lang.String <B>retrieveAllDocumentMetadata</B>(java.lang.String collection,
|
---|
936 | java.lang.String lang,
|
---|
937 | java.lang.String[] docNodeIDs)</PRE>
|
---|
938 | <DL>
|
---|
939 | <DD>DocumentMetadataRetrieve request sent to a collection's
|
---|
940 | DocumentMetadataRetrieve service to retrieve all of a document's metadata.
|
---|
941 | <P>
|
---|
942 | <DD><DL>
|
---|
943 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
944 | 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
|
---|
945 | 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>
|
---|
946 | </DD>
|
---|
947 | </DL>
|
---|
948 | <HR>
|
---|
949 |
|
---|
950 | <A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
951 | retrieveDocumentMetadata</H3>
|
---|
952 | <PRE>
|
---|
953 | public java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String collection,
|
---|
954 | java.lang.String lang,
|
---|
955 | java.lang.String[] docNodeIDs,
|
---|
956 | java.lang.String[] metaNames)</PRE>
|
---|
957 | <DL>
|
---|
958 | <DD>DocumentMetadataRetrieve service to retrieve some specific
|
---|
959 | metadata values of a document. (Manual on page 47.)
|
---|
960 | <P>
|
---|
961 | <DD><DL>
|
---|
962 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
963 | 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
|
---|
964 | structure ought to be retrieved.<DD><CODE>metaNames</CODE> - is a list of metadata names which are requested
|
---|
965 | 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>
|
---|
966 | </DD>
|
---|
967 | </DL>
|
---|
968 | <HR>
|
---|
969 |
|
---|
970 | <A NAME="retrieveAllBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
971 | retrieveAllBrowseMetadata</H3>
|
---|
972 | <PRE>
|
---|
973 | public java.lang.String <B>retrieveAllBrowseMetadata</B>(java.lang.String collection,
|
---|
974 | java.lang.String categoryName,
|
---|
975 | java.lang.String lang,
|
---|
976 | java.lang.String[] nodeIDs)</PRE>
|
---|
977 | <DL>
|
---|
978 | <DD>Retrieve all classification Metadata for browsing (sent to the
|
---|
979 | ClassifierBrowseMetadataRetrieve service).
|
---|
980 | <P>
|
---|
981 | <DD><DL>
|
---|
982 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
983 | ClassifierBrowseMetadataRetrieve service is called<DD><CODE>categoryName</CODE> - - name of the browsing category, usually
|
---|
984 | 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
|
---|
985 | 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>
|
---|
986 | </DD>
|
---|
987 | </DL>
|
---|
988 | <HR>
|
---|
989 |
|
---|
990 | <A NAME="retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
991 | retrieveBrowseMetadata</H3>
|
---|
992 | <PRE>
|
---|
993 | public java.lang.String <B>retrieveBrowseMetadata</B>(java.lang.String collection,
|
---|
994 | java.lang.String categoryName,
|
---|
995 | java.lang.String lang,
|
---|
996 | java.lang.String[] nodeIDs,
|
---|
997 | java.lang.String[] metaNames)</PRE>
|
---|
998 | <DL>
|
---|
999 | <DD>ClassifierBrowseMetadataRetrieve service to retrieve some specific
|
---|
1000 | metadata values of a document.
|
---|
1001 | <P>
|
---|
1002 | <DD><DL>
|
---|
1003 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose
|
---|
1004 | ClassifierBrowseMetadataRetrieve service is called<DD><CODE>categoryName</CODE> - - name of the browsing category, usually
|
---|
1005 | 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
|
---|
1006 | for which the metadata ought to be retrieved.<DD><CODE>metaNames</CODE> - is a list of metadata names which are requested
|
---|
1007 | 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>
|
---|
1008 | </DD>
|
---|
1009 | </DL>
|
---|
1010 | <HR>
|
---|
1011 |
|
---|
1012 | <A NAME="metadataRetrieve(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String)"><!-- --></A><H3>
|
---|
1013 | metadataRetrieve</H3>
|
---|
1014 | <PRE>
|
---|
1015 | protected java.lang.String <B>metadataRetrieve</B>(java.lang.String to,
|
---|
1016 | java.lang.String lang,
|
---|
1017 | java.lang.String[] nodeIDs,
|
---|
1018 | java.lang.String[] metaNames,
|
---|
1019 | java.lang.String NODE_ELEM)</PRE>
|
---|
1020 | <DL>
|
---|
1021 | <DD>Performs a metadata retrieve for documents and (browse) classification
|
---|
1022 | hierarchies. Sends a Document- or ClassifierBrowse- MetadataRetrieve message
|
---|
1023 | to the Document- or ClassifierBrowse- MetadataRetrieve service.
|
---|
1024 | <P>
|
---|
1025 | <DD><DL>
|
---|
1026 | <DT><B>Parameters:</B><DD><CODE>to</CODE> - - the Document- or ClassifierBrowse- MetadataRetrieve service to
|
---|
1027 | send this metadata retrieve message to.<DD><CODE>lang</CODE> - - the language of the display content in the response<DD><CODE>nodeIDs</CODE> - - the list of (document or classifier) nodeIDs for which
|
---|
1028 | to retrieve the metadata for<DD><CODE>metaNames</CODE> - - a list specifiying the names of the metadata items
|
---|
1029 | to be retrieved for each nodeID. E.g. "Title", but a list is allowed.<DD><CODE>NODE_ELEM</CODE> - - either of GSXML's names for the <documentNode> or
|
---|
1030 | <classifierNode> elements.</DL>
|
---|
1031 | </DD>
|
---|
1032 | </DL>
|
---|
1033 | <HR>
|
---|
1034 |
|
---|
1035 | <A NAME="browseDescendants(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
|
---|
1036 | browseDescendants</H3>
|
---|
1037 | <PRE>
|
---|
1038 | public java.lang.String <B>browseDescendants</B>(java.lang.String collection,
|
---|
1039 | java.lang.String browseService,
|
---|
1040 | java.lang.String lang,
|
---|
1041 | java.lang.String[] classifierNodeIDs)</PRE>
|
---|
1042 | <DL>
|
---|
1043 | <DD>To send a browse request for all the descendants of a classifier node.
|
---|
1044 | Useful for getting the entire structure of a top-level <classificationNode>
|
---|
1045 | <P>
|
---|
1046 | <DD><DL>
|
---|
1047 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose browse Classifier
|
---|
1048 | Browse Service is called<DD><CODE>browseService</CODE> - is the name of the (Classifier) Browse Service (of
|
---|
1049 | 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
|
---|
1050 | 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>
|
---|
1051 | </DD>
|
---|
1052 | </DL>
|
---|
1053 | <HR>
|
---|
1054 |
|
---|
1055 | <A NAME="browse(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
|
---|
1056 | browse</H3>
|
---|
1057 | <PRE>
|
---|
1058 | public java.lang.String <B>browse</B>(java.lang.String collection,
|
---|
1059 | java.lang.String browseService,
|
---|
1060 | java.lang.String lang,
|
---|
1061 | java.lang.String[] classifierNodeIDs,
|
---|
1062 | java.lang.String[] structureParams)</PRE>
|
---|
1063 | <DL>
|
---|
1064 | <DD>To send a browse request for specific parts of a classifier node
|
---|
1065 | (children, ancestors, descendants). Useful for getting specific parts
|
---|
1066 | of the structure of a top-level <classificationNode>.
|
---|
1067 | <P>
|
---|
1068 | <DD><DL>
|
---|
1069 | <DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the Collection whose browse Classifier
|
---|
1070 | Browse Service is called<DD><CODE>browseService</CODE> - is the name of the (Classifier) Browse Service (of
|
---|
1071 | 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
|
---|
1072 | structure ought to be retrieved.<DD><CODE>structureParams</CODE> - the list of parameters indicating what structure
|
---|
1073 | information is requested. Accepted values are ancestors, parent, siblings,
|
---|
1074 | 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>
|
---|
1075 | </DD>
|
---|
1076 | </DL>
|
---|
1077 | <HR>
|
---|
1078 |
|
---|
1079 | <A NAME="processInternal(org.w3c.dom.Element)"><!-- --></A><H3>
|
---|
1080 | processInternal</H3>
|
---|
1081 | <PRE>
|
---|
1082 | protected java.lang.String <B>processInternal</B>(org.w3c.dom.Element message)</PRE>
|
---|
1083 | <DL>
|
---|
1084 | <DD>Called by most other methods in order to send the constructed message
|
---|
1085 | to the Greenstone's MessageRouter, intercept the response and return it.
|
---|
1086 | <P>
|
---|
1087 | <DD><DL>
|
---|
1088 | <DT><B>Parameters:</B><DD><CODE>message</CODE> - is the XML message Element to send to GS3's MessageRouter.
|
---|
1089 | <DT><B>Returns:</B><DD>the XML response in String format.</DL>
|
---|
1090 | </DD>
|
---|
1091 | </DL>
|
---|
1092 | <HR>
|
---|
1093 |
|
---|
1094 | <A NAME="error(java.lang.String)"><!-- --></A><H3>
|
---|
1095 | error</H3>
|
---|
1096 | <PRE>
|
---|
1097 | protected java.lang.String <B>error</B>(java.lang.String errorMessage)</PRE>
|
---|
1098 | <DL>
|
---|
1099 | <DD>Creates a String response message to represent an XML error response
|
---|
1100 | message using the error specified in the message parameter. A String is
|
---|
1101 | created because this method ensures that a response message is reliably
|
---|
1102 | constructed (no exceptions are thrown) that can be sent to clients.
|
---|
1103 | <P>
|
---|
1104 | <DD><DL>
|
---|
1105 | <DT><B>Parameters:</B><DD><CODE>errorMessage</CODE> - - the errormessage to be conveyed
|
---|
1106 | <DT><B>Returns:</B><DD>an XML response message containing an GS3 error element.</DL>
|
---|
1107 | </DD>
|
---|
1108 | </DL>
|
---|
1109 | <HR>
|
---|
1110 |
|
---|
1111 | <A NAME="help()"><!-- --></A><H3>
|
---|
1112 | help</H3>
|
---|
1113 | <PRE>
|
---|
1114 | public static java.lang.String <B>help</B>()</PRE>
|
---|
1115 | <DL>
|
---|
1116 | <DD><DL>
|
---|
1117 |
|
---|
1118 | <DT><B>Returns:</B><DD>a help string for listing all the web service methods.</DL>
|
---|
1119 | </DD>
|
---|
1120 | </DL>
|
---|
1121 | <HR>
|
---|
1122 |
|
---|
1123 | <A NAME="helpWithMethod(java.lang.String)"><!-- --></A><H3>
|
---|
1124 | helpWithMethod</H3>
|
---|
1125 | <PRE>
|
---|
1126 | public static java.lang.String <B>helpWithMethod</B>(java.lang.String methodname)</PRE>
|
---|
1127 | <DL>
|
---|
1128 | <DD><DL>
|
---|
1129 | <DT><B>Parameters:</B><DD><CODE>methodname</CODE> - is the name of the method to be described.
|
---|
1130 | <DT><B>Returns:</B><DD>a help string for the given method, explaining what the method
|
---|
1131 | does, what parameters it expects and their types and what it returns.</DL>
|
---|
1132 | </DD>
|
---|
1133 | </DL>
|
---|
1134 | <HR>
|
---|
1135 |
|
---|
1136 | <A NAME="main(java.lang.String[])"><!-- --></A><H3>
|
---|
1137 | main</H3>
|
---|
1138 | <PRE>
|
---|
1139 | public static void <B>main</B>(java.lang.String[] args)</PRE>
|
---|
1140 | <DL>
|
---|
1141 | <DD><DL>
|
---|
1142 | </DL>
|
---|
1143 | </DD>
|
---|
1144 | </DL>
|
---|
1145 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
1146 | <HR>
|
---|
1147 |
|
---|
1148 |
|
---|
1149 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
1150 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
1151 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
1152 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
1153 | <TR>
|
---|
1154 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
1155 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
1156 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
1157 | <TR ALIGN="center" VALIGN="top">
|
---|
1158 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
1159 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
1160 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
1161 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
1162 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
1163 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
1164 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
1165 | </TR>
|
---|
1166 | </TABLE>
|
---|
1167 | </TD>
|
---|
1168 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
1169 | </EM>
|
---|
1170 | </TD>
|
---|
1171 | </TR>
|
---|
1172 |
|
---|
1173 | <TR>
|
---|
1174 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1175 | <A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html" title="class in org.greenstone.gs3services"><B>PREV CLASS</B></A>
|
---|
1176 | NEXT CLASS</FONT></TD>
|
---|
1177 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1178 | <A HREF="../../../index.html?org/greenstone/gs3services/QBRSOAPServer.html" target="_top"><B>FRAMES</B></A>
|
---|
1179 | <A HREF="QBRSOAPServer.html" target="_top"><B>NO FRAMES</B></A>
|
---|
1180 | <SCRIPT type="text/javascript">
|
---|
1181 | <!--
|
---|
1182 | if(window==top) {
|
---|
1183 | document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
1184 | }
|
---|
1185 | //-->
|
---|
1186 | </SCRIPT>
|
---|
1187 | <NOSCRIPT>
|
---|
1188 | <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
1189 | </NOSCRIPT>
|
---|
1190 |
|
---|
1191 |
|
---|
1192 | </FONT></TD>
|
---|
1193 | </TR>
|
---|
1194 | <TR>
|
---|
1195 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1196 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
1197 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1198 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
1199 | </TR>
|
---|
1200 | </TABLE>
|
---|
1201 | <A NAME="skip-navbar_bottom"></A>
|
---|
1202 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
1203 |
|
---|
1204 | <HR>
|
---|
1205 |
|
---|
1206 | </BODY>
|
---|
1207 | </HTML>
|
---|