Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

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

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

Line
1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2	<!--NewPage-->
3	<HTML>
4	<HEAD>
5	<!-- Generated by javadoc (build 1.5.0_10) on Thu May 15 13:34:22 NZST 2008 -->
6	<TITLE>
7	QueryResponseData
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.greenstone.gs3client.data.QueryResponseData 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="QueryResponseData";
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/data/QueryFormData.QueryFormParam.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
55	<A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data"><B>NEXT CLASS</B></A></FONT></TD>
56	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57	<A HREF="../../../../index.html?org/greenstone/gs3client/data/QueryResponseData.html" target="_top"><B>FRAMES</B></A>
58	<A HREF="QueryResponseData.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: <A HREF="#nested_class_summary">NESTED</A> \| <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.data</FONT>
88	<BR>
89	Class QueryResponseData</H2>
90	<PRE>
91	java.lang.Object
92	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html" title="class in org.greenstone.gs3client.data">org.greenstone.gs3client.data.ResponseData</A>
93	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.data.QueryResponseData</B>
94	</PRE>
95	<HR>
96	<DL>
97	<DT><PRE>public class <B>QueryResponseData</B><DT>extends <A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html" title="class in org.greenstone.gs3client.data">ResponseData</A></DL>
98	</PRE>
99
100	<P>
101	Represents the data fields that may be present in a response
102	to a Query-process request. Specifically, this class keeps track of
103	all the DocumentNodes returned in response to a query request.
104	It inherits Map nodeIDsToNodes of (nodeID, NodeData ref) pairs which
105	maintains the NodeData object refs in order of their insertion into
106	the Map (LinkedHashMap).
107	!!! QueryResponseData will only store DocumentNodeData object refs in
108	the nodeIDsToNodes Map.
109	An object of this class can be reused after instatiation by calling
110	setResponseData() with a new query response XML message. This will
111	first call clear() to clear/release its references to all the old data.
112	<P>
113
114	<P>
115	<DL>
116	<DT><B>Author:</B></DT>
117	<DD>ak19</DD>
118	</DL>
119	<HR>
120
121	<P>
122	<!-- ======== NESTED CLASS SUMMARY ======== -->
123
124	<A NAME="nested_class_summary"><!-- --></A>
125	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
128	<B>Nested Class Summary</B></FONT></TH>
129	</TR>
130	<TR BGCOLOR="white" CLASS="TableRowColor">
131	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132	<CODE>static class</CODE></FONT></TD>
133	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data">QueryResponseData.TermData</A></B></CODE>
134
135	<BR>
136	Static inner class Term represents a <term> XML element
137	(these are nested in a <termList>) - see manual p.</TD>
138	</TR>
139	</TABLE>
140	<!-- =========== FIELD SUMMARY =========== -->
141
142	<A NAME="field_summary"><!-- --></A>
143	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
146	<B>Field Summary</B></FONT></TH>
147	</TR>
148	<TR BGCOLOR="white" CLASS="TableRowColor">
149	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150	<CODE>protected  java.util.HashMap</CODE></FONT></TD>
151	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#metadataList">metadataList</A></B></CODE>
152
153	<BR>
154	Metadata of the query's response - not a documentNode's metadata!</TD>
155	</TR>
156	<TR BGCOLOR="white" CLASS="TableRowColor">
157	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158	<CODE>protected  java.lang.String</CODE></FONT></TD>
159	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#numDocsMatched">numDocsMatched</A></B></CODE>
160
161	<BR>
162	</TD>
163	</TR>
164	<TR BGCOLOR="white" CLASS="TableRowColor">
165	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166	<CODE>protected  java.lang.String</CODE></FONT></TD>
167	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#numDocsReturned">numDocsReturned</A></B></CODE>
168
169	<BR>
170	</TD>
171	</TR>
172	<TR BGCOLOR="white" CLASS="TableRowColor">
173	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174	<CODE>protected  java.lang.String</CODE></FONT></TD>
175	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#queryField">queryField</A></B></CODE>
176
177	<BR>
178	</TD>
179	</TR>
180	<TR BGCOLOR="white" CLASS="TableRowColor">
181	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182	<CODE>protected  <A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data">QueryResponseData.TermData</A>[]</CODE></FONT></TD>
183	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#termList">termList</A></B></CODE>
184
185	<BR>
186	</TD>
187	</TR>
188	</TABLE>
189	<A NAME="fields_inherited_from_class_org.greenstone.gs3client.data.ResponseData"><!-- --></A>
190	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
191	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
192	<TH ALIGN="left"><B>Fields inherited from class org.greenstone.gs3client.data.<A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html" title="class in org.greenstone.gs3client.data">ResponseData</A></B></TH>
193	</TR>
194	<TR BGCOLOR="white" CLASS="TableRowColor">
195	<TD><CODE><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#nodeIDsToNodes">nodeIDsToNodes</A></CODE></TD>
196	</TR>
197	</TABLE>
198
199	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
200
201	<A NAME="constructor_summary"><!-- --></A>
202	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
204	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
205	<B>Constructor Summary</B></FONT></TH>
206	</TR>
207	<TR BGCOLOR="white" CLASS="TableRowColor">
208	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#QueryResponseData()">QueryResponseData</A></B>()</CODE>
209
210	<BR>
211	Default constructor</TD>
212	</TR>
213	</TABLE>
214
215	<!-- ========== METHOD SUMMARY =========== -->
216
217	<A NAME="method_summary"><!-- --></A>
218	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
219	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
220	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
221	<B>Method Summary</B></FONT></TH>
222	</TR>
223	<TR BGCOLOR="white" CLASS="TableRowColor">
224	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225	<CODE> void</CODE></FONT></TD>
226	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#clear()">clear</A></B>()</CODE>
227
228	<BR>
229	Resets the internal data members of this QueryResponseData object of
230	their values so that this QueryResponseData can be reused for the
231	next Query response message.</TD>
232	</TR>
233	<TR BGCOLOR="white" CLASS="TableRowColor">
234	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235	<CODE> <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A></CODE></FONT></TD>
236	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#getDocNodeForID(java.lang.String)">getDocNodeForID</A></B>(java.lang.String ID)</CODE>
237
238	<BR>
239	Given an nodeID, returns the DocumentNodeData object with that nodeID
240	if any.</TD>
241	</TR>
242	<TR BGCOLOR="white" CLASS="TableRowColor">
243	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244	<CODE> java.lang.String[]</CODE></FONT></TD>
245	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#getDocumentNodeIDs()">getDocumentNodeIDs</A></B>()</CODE>
246
247	<BR>
248	</TD>
249	</TR>
250	<TR BGCOLOR="white" CLASS="TableRowColor">
251	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252	<CODE> <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>[]</CODE></FONT></TD>
253	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#getDocumentNodeList()">getDocumentNodeList</A></B>()</CODE>
254
255	<BR>
256	</TD>
257	</TR>
258	<TR BGCOLOR="white" CLASS="TableRowColor">
259	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260	<CODE> java.lang.String</CODE></FONT></TD>
261	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#getMetaValueForName(java.lang.String)">getMetaValueForName</A></B>(java.lang.String name)</CODE>
262
263	<BR>
264	</TD>
265	</TR>
266	<TR BGCOLOR="white" CLASS="TableRowColor">
267	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268	<CODE> java.lang.String</CODE></FONT></TD>
269	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#getNumDocsMatched()">getNumDocsMatched</A></B>()</CODE>
270
271	<BR>
272	</TD>
273	</TR>
274	<TR BGCOLOR="white" CLASS="TableRowColor">
275	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276	<CODE> java.lang.String</CODE></FONT></TD>
277	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#getNumDocsReturned()">getNumDocsReturned</A></B>()</CODE>
278
279	<BR>
280	</TD>
281	</TR>
282	<TR BGCOLOR="white" CLASS="TableRowColor">
283	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
284	<CODE> java.lang.String</CODE></FONT></TD>
285	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#getQueryField()">getQueryField</A></B>()</CODE>
286
287	<BR>
288	</TD>
289	</TR>
290	<TR BGCOLOR="white" CLASS="TableRowColor">
291	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
292	<CODE> <A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data">QueryResponseData.TermData</A>[]</CODE></FONT></TD>
293	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#getTermList()">getTermList</A></B>()</CODE>
294
295	<BR>
296	</TD>
297	</TR>
298	<TR BGCOLOR="white" CLASS="TableRowColor">
299	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
300	<CODE> void</CODE></FONT></TD>
301	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#setResponseData(org.w3c.dom.Element)">setResponseData</A></B>(org.w3c.dom.Element responseMessageTag)</CODE>
302
303	<BR>
304	Given the response to a query message (XML with root <message>
305	or <response> tag), a QueryResponseData object is created
306	to store all the document Identifiers and document data returned
307	as well as information about the terms that were searched on.</TD>
308	</TR>
309	<TR BGCOLOR="white" CLASS="TableRowColor">
310	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
311	<CODE> java.util.Vector</CODE></FONT></TD>
312	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#setStructureForDocs(org.w3c.dom.Element)">setStructureForDocs</A></B>(org.w3c.dom.Element messageTag)</CODE>
313
314	<BR>
315	This method can be called after a DocumentStructureRetrieve request
316	(for the entire structure of all/many of its documents) has returned
317	a response.</TD>
318	</TR>
319	<TR BGCOLOR="white" CLASS="TableRowColor">
320	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321	<CODE> java.lang.String</CODE></FONT></TD>
322	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html#toString()">toString</A></B>()</CODE>
323
324	<BR>
325	</TD>
326	</TR>
327	</TABLE>
328	<A NAME="methods_inherited_from_class_org.greenstone.gs3client.data.ResponseData"><!-- --></A>
329	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
330	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
331	<TH ALIGN="left"><B>Methods inherited from class org.greenstone.gs3client.data.<A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html" title="class in org.greenstone.gs3client.data">ResponseData</A></B></TH>
332	</TR>
333	<TR BGCOLOR="white" CLASS="TableRowColor">
334	<TD><CODE><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#getIDToNodeMapping()">getIDToNodeMapping</A>, <A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#getNodeForID(java.lang.String)">getNodeForID</A>, <A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#setContentForDocs(org.w3c.dom.Element)">setContentForDocs</A>, <A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#setMetadataForDocuments(org.w3c.dom.Element)">setMetadataForDocuments</A>, <A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#setMetadataForNodes(org.w3c.dom.Element, java.lang.String)">setMetadataForNodes</A></CODE></TD>
335	</TR>
336	</TABLE>
337	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
338	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
339	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
340	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
341	</TR>
342	<TR BGCOLOR="white" CLASS="TableRowColor">
343	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
344	</TR>
345	</TABLE>
346
347	<P>
348
349	<!-- ============ FIELD DETAIL =========== -->
350
351	<A NAME="field_detail"><!-- --></A>
352	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
353	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
354	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
355	<B>Field Detail</B></FONT></TH>
356	</TR>
357	</TABLE>
358
359	<A NAME="numDocsMatched"><!-- --></A><H3>
360	numDocsMatched</H3>
361	<PRE>
362	protected java.lang.String <B>numDocsMatched</B></PRE>
363	<DL>
364	<DL>
365	</DL>
366	</DL>
367	<HR>
368
369	<A NAME="numDocsReturned"><!-- --></A><H3>
370	numDocsReturned</H3>
371	<PRE>
372	protected java.lang.String <B>numDocsReturned</B></PRE>
373	<DL>
374	<DL>
375	</DL>
376	</DL>
377	<HR>
378
379	<A NAME="queryField"><!-- --></A><H3>
380	queryField</H3>
381	<PRE>
382	protected java.lang.String <B>queryField</B></PRE>
383	<DL>
384	<DL>
385	</DL>
386	</DL>
387	<HR>
388
389	<A NAME="termList"><!-- --></A><H3>
390	termList</H3>
391	<PRE>
392	protected <A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data">QueryResponseData.TermData</A>[] <B>termList</B></PRE>
393	<DL>
394	<DL>
395	</DL>
396	</DL>
397	<HR>
398
399	<A NAME="metadataList"><!-- --></A><H3>
400	metadataList</H3>
401	<PRE>
402	protected java.util.HashMap <B>metadataList</B></PRE>
403	<DL>
404	<DD>Metadata of the query's response - not a documentNode's metadata!
405	<P>
406	<DL>
407	</DL>
408	</DL>
409
410	<!-- ========= CONSTRUCTOR DETAIL ======== -->
411
412	<A NAME="constructor_detail"><!-- --></A>
413	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
414	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
415	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
416	<B>Constructor Detail</B></FONT></TH>
417	</TR>
418	</TABLE>
419
420	<A NAME="QueryResponseData()"><!-- --></A><H3>
421	QueryResponseData</H3>
422	<PRE>
423	public <B>QueryResponseData</B>()</PRE>
424	<DL>
425	<DD>Default constructor
426	<P>
427	</DL>
428
429	<!-- ============ METHOD DETAIL ========== -->
430
431	<A NAME="method_detail"><!-- --></A>
432	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
433	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
434	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
435	<B>Method Detail</B></FONT></TH>
436	</TR>
437	</TABLE>
438
439	<A NAME="clear()"><!-- --></A><H3>
440	clear</H3>
441	<PRE>
442	public void <B>clear</B>()</PRE>
443	<DL>
444	<DD>Resets the internal data members of this QueryResponseData object of
445	their values so that this QueryResponseData can be reused for the
446	next Query response message.
447	<P>
448	<DD><DL>
449	<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#clear()">clear</A></CODE> in class <CODE><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html" title="class in org.greenstone.gs3client.data">ResponseData</A></CODE></DL>
450	</DD>
451	<DD><DL>
452	</DL>
453	</DD>
454	</DL>
455	<HR>
456
457	<A NAME="setResponseData(org.w3c.dom.Element)"><!-- --></A><H3>
458	setResponseData</H3>
459	<PRE>
460	public void <B>setResponseData</B>(org.w3c.dom.Element responseMessageTag)</PRE>
461	<DL>
462	<DD>Given the response to a query message (XML with root <message>
463	or <response> tag), a QueryResponseData object is created
464	to store all the document Identifiers and document data returned
465	as well as information about the terms that were searched on.
466	Furthermore, metadata such as the number of Docs that matched and
467	were returned (if any such are present in the response-message)
468	are also stored.
469	It first performs a clear to empty its data members and then fills
470	them with the new Query response message's data.
471	<P>
472	<DD><DL>
473	<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#setResponseData(org.w3c.dom.Element)">setResponseData</A></CODE> in class <CODE><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html" title="class in org.greenstone.gs3client.data">ResponseData</A></CODE></DL>
474	</DD>
475	<DD><DL>
476	<DT><B>Parameters:</B><DD><CODE>responseMessageTag</CODE> - is the XML DOM Element representing a query
477	response XML message.</DL>
478	</DD>
479	</DL>
480	<HR>
481
482	<A NAME="getNumDocsMatched()"><!-- --></A><H3>
483	getNumDocsMatched</H3>
484	<PRE>
485	public java.lang.String <B>getNumDocsMatched</B>()</PRE>
486	<DL>
487	<DD><DL>
488
489	<DT><B>Returns:</B><DD>the number of matching documents for the query information</DL>
490	</DD>
491	</DL>
492	<HR>
493
494	<A NAME="getNumDocsReturned()"><!-- --></A><H3>
495	getNumDocsReturned</H3>
496	<PRE>
497	public java.lang.String <B>getNumDocsReturned</B>()</PRE>
498	<DL>
499	<DD><DL>
500
501	<DT><B>Returns:</B><DD>the number of documents returned for the query information</DL>
502	</DD>
503	</DL>
504	<HR>
505
506	<A NAME="getQueryField()"><!-- --></A><H3>
507	getQueryField</H3>
508	<PRE>
509	public java.lang.String <B>getQueryField</B>()</PRE>
510	<DL>
511	<DD><DL>
512
513	<DT><B>Returns:</B><DD>the query field information</DL>
514	</DD>
515	</DL>
516	<HR>
517
518	<A NAME="getTermList()"><!-- --></A><H3>
519	getTermList</H3>
520	<PRE>
521	public <A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data">QueryResponseData.TermData</A>[] <B>getTermList</B>()</PRE>
522	<DL>
523	<DD><DL>
524
525	<DT><B>Returns:</B><DD>the list of termData (search terms along with frequency
526	information, etc.)</DL>
527	</DD>
528	</DL>
529	<HR>
530
531	<A NAME="getDocNodeForID(java.lang.String)"><!-- --></A><H3>
532	getDocNodeForID</H3>
533	<PRE>
534	public <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> <B>getDocNodeForID</B>(java.lang.String ID)</PRE>
535	<DL>
536	<DD>Given an nodeID, returns the DocumentNodeData object with that nodeID
537	if any. Otherwise, null is returned.
538	Superclass has method getNodeForID that returns NodeData instead.
539	This is just a convenience method.
540	<P>
541	<DD><DL>
542	<DT><B>Parameters:</B><DD><CODE>ID</CODE> - is the nodeID of the DocumentNodeData to be returned.
543	<DT><B>Returns:</B><DD>the DocumentNodeData object for the given ID or null if not
544	present.</DL>
545	</DD>
546	</DL>
547	<HR>
548
549	<A NAME="getDocumentNodeList()"><!-- --></A><H3>
550	getDocumentNodeList</H3>
551	<PRE>
552	public <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>[] <B>getDocumentNodeList</B>()</PRE>
553	<DL>
554	<DD><DL>
555
556	<DT><B>Returns:</B><DD>an array of the DocumentNodeData objects of the documents
557	returned by the executed Query Response and stored in this
558	QueryResponseData object. I.e. the documentNodes of the documents in
559	the search results.
560	In cases of an error (such as not being able to connect to a collection
561	like Infomine) this method may return an empty array (length = 0)
562	if docIDsToDocNodes is empty!</DL>
563	</DD>
564	</DL>
565	<HR>
566
567	<A NAME="getDocumentNodeIDs()"><!-- --></A><H3>
568	getDocumentNodeIDs</H3>
569	<PRE>
570	public java.lang.String[] <B>getDocumentNodeIDs</B>()</PRE>
571	<DL>
572	<DD><DL>
573
574	<DT><B>Returns:</B><DD>an array of the IDs of the list of documentNodes maintained
575	by this QueryResponseData object (the documentNodes of the documents'
576	in the search results).
577	In cases of an error (such as not being able to connect to collection
578	such as Infomine) this method may return an empty array (length = 0)
579	if docIDsToDocNodes is empty!</DL>
580	</DD>
581	</DL>
582	<HR>
583
584	<A NAME="getMetaValueForName(java.lang.String)"><!-- --></A><H3>
585	getMetaValueForName</H3>
586	<PRE>
587	public java.lang.String <B>getMetaValueForName</B>(java.lang.String name)</PRE>
588	<DL>
589	<DD><DL>
590
591	<DT><B>Returns:</B><DD>metadata of the query's response. This includes values such
592	as numDocsMatched, numDocsReturned, query. This does not return any
593	document's metadata!</DL>
594	</DD>
595	</DL>
596	<HR>
597
598	<A NAME="setStructureForDocs(org.w3c.dom.Element)"><!-- --></A><H3>
599	setStructureForDocs</H3>
600	<PRE>
601	public java.util.Vector <B>setStructureForDocs</B>(org.w3c.dom.Element messageTag)</PRE>
602	<DL>
603	<DD>This method can be called after a DocumentStructureRetrieve request
604	(for the entire structure of all/many of its documents) has returned
605	a response. Given the response message (XML) element, this method
606	attempts to set the document structure for all the documentNodeData
607	objects it has, using the nodeStructure tags in the
608	response-message-XML. But only those documentNodeData whose nodeIDs
609	are mentioned in the response-message-XML are actually set!
610	This method returns a null vector if the responseMessage XMl does not
611	contain any <documentNodeList> element with <documentNode>s
612	each with <nodeStructure> children.
613	Otherwise it returns a Vector of all the rootNodes of the list of
614	docNodes that this QueryResponseData object maintains.
615	<P>
616	<DD><DL>
617	</DL>
618	</DD>
619	</DL>
620	<HR>
621
622	<A NAME="toString()"><!-- --></A><H3>
623	toString</H3>
624	<PRE>
625	public java.lang.String <B>toString</B>()</PRE>
626	<DL>
627	<DD><DL>
628	<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
629	</DD>
630	<DD><DL>
631
632	<DT><B>Returns:</B><DD>some summary info on how the search went. This may include
633	how many documents matched the query, and how many of them have been
634	returned. With mult-term queries, the frequencies of each separate
635	term is also returned for display.</DL>
636	</DD>
637	</DL>
638	<!-- ========= END OF CLASS DATA ========= -->
639	<HR>
640
641
642	<!-- ======= START OF BOTTOM NAVBAR ====== -->
643	<A NAME="navbar_bottom"><!-- --></A>
644	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
645	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
646	<TR>
647	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
648	<A NAME="navbar_bottom_firstrow"><!-- --></A>
649	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
650	<TR ALIGN="center" VALIGN="top">
651	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
652	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
653	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
654	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
655	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
656	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
657	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
658	</TR>
659	</TABLE>
660	</TD>
661	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
662	</EM>
663	</TD>
664	</TR>
665
666	<TR>
667	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
668	<A HREF="../../../../org/greenstone/gs3client/data/QueryFormData.QueryFormParam.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
669	<A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data"><B>NEXT CLASS</B></A></FONT></TD>
670	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
671	<A HREF="../../../../index.html?org/greenstone/gs3client/data/QueryResponseData.html" target="_top"><B>FRAMES</B></A>
672	<A HREF="QueryResponseData.html" target="_top"><B>NO FRAMES</B></A>
673	<SCRIPT type="text/javascript">
674	<!--
675	if(window==top) {
676	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
677	}
678	//-->
679	</SCRIPT>
680	<NOSCRIPT>
681	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
682	</NOSCRIPT>
683
684
685	</FONT></TD>
686	</TR>
687	<TR>
688	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
689	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
690	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
691	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
692	</TR>
693	</TABLE>
694	<A NAME="skip-navbar_bottom"></A>
695	<!-- ======== END OF BOTTOM NAVBAR ======= -->
696
697	<HR>
698
699	</BODY>
700	</HTML>

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

Download in other formats: