| 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 | ResponseData
|
|---|
| 8 | </TITLE>
|
|---|
| 9 |
|
|---|
| 10 | <META NAME="keywords" CONTENT="org.greenstone.gs3client.data.ResponseData 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="ResponseData";
|
|---|
| 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/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
|
|---|
| 55 | NEXT CLASS</FONT></TD>
|
|---|
| 56 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 57 | <A HREF="../../../../index.html?org/greenstone/gs3client/data/ResponseData.html" target="_top"><B>FRAMES</B></A>
|
|---|
| 58 | <A HREF="ResponseData.html" target="_top"><B>NO FRAMES</B></A>
|
|---|
| 59 | <SCRIPT type="text/javascript">
|
|---|
| 60 | <!--
|
|---|
| 61 | if(window==top) {
|
|---|
| 62 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|---|
| 63 | }
|
|---|
| 64 | //-->
|
|---|
| 65 | </SCRIPT>
|
|---|
| 66 | <NOSCRIPT>
|
|---|
| 67 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|---|
| 68 | </NOSCRIPT>
|
|---|
| 69 |
|
|---|
| 70 |
|
|---|
| 71 | </FONT></TD>
|
|---|
| 72 | </TR>
|
|---|
| 73 | <TR>
|
|---|
| 74 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 75 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|---|
| 76 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 77 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|---|
| 78 | </TR>
|
|---|
| 79 | </TABLE>
|
|---|
| 80 | <A NAME="skip-navbar_top"></A>
|
|---|
| 81 | <!-- ========= END OF TOP NAVBAR ========= -->
|
|---|
| 82 |
|
|---|
| 83 | <HR>
|
|---|
| 84 | <!-- ======== START OF CLASS DATA ======== -->
|
|---|
| 85 | <H2>
|
|---|
| 86 | <FONT SIZE="-1">
|
|---|
| 87 | org.greenstone.gs3client.data</FONT>
|
|---|
| 88 | <BR>
|
|---|
| 89 | Class ResponseData</H2>
|
|---|
| 90 | <PRE>
|
|---|
| 91 | java.lang.Object
|
|---|
| 92 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.data.ResponseData</B>
|
|---|
| 93 | </PRE>
|
|---|
| 94 | <DL>
|
|---|
| 95 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/greenstone/gs3client/data/BrowseResponseData.html" title="class in org.greenstone.gs3client.data">BrowseResponseData</A>, <A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.html" title="class in org.greenstone.gs3client.data">QueryResponseData</A></DD>
|
|---|
| 96 | </DL>
|
|---|
| 97 | <HR>
|
|---|
| 98 | <DL>
|
|---|
| 99 | <DT><PRE>public abstract class <B>ResponseData</B><DT>extends java.lang.Object</DL>
|
|---|
| 100 | </PRE>
|
|---|
| 101 |
|
|---|
| 102 | <P>
|
|---|
| 103 | Represents the data in a response XML message that is returned as
|
|---|
| 104 | either a Browse or Query (Search) request.
|
|---|
| 105 | Subclasses therefore are BrowseResponseData and QueryResponseData.
|
|---|
| 106 | This class maintains a Map of (nodeID, NodeData ref) pairs
|
|---|
| 107 | representing the resulting <classifierNode>s and <documentNode>s
|
|---|
| 108 | that can be returned when executing a SINGLE browse or query request.
|
|---|
| 109 | <P>
|
|---|
| 110 |
|
|---|
| 111 | <P>
|
|---|
| 112 | <DL>
|
|---|
| 113 | <DT><B>Author:</B></DT>
|
|---|
| 114 | <DD>ak19</DD>
|
|---|
| 115 | </DL>
|
|---|
| 116 | <HR>
|
|---|
| 117 |
|
|---|
| 118 | <P>
|
|---|
| 119 | <!-- =========== FIELD SUMMARY =========== -->
|
|---|
| 120 |
|
|---|
| 121 | <A NAME="field_summary"><!-- --></A>
|
|---|
| 122 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 123 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 124 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 125 | <B>Field Summary</B></FONT></TH>
|
|---|
| 126 | </TR>
|
|---|
| 127 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 128 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 129 | <CODE>protected java.util.Map</CODE></FONT></TD>
|
|---|
| 130 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#nodeIDsToNodes">nodeIDsToNodes</A></B></CODE>
|
|---|
| 131 |
|
|---|
| 132 | <BR>
|
|---|
| 133 | map of (nodeIDs, references to associated NodeData) pairs,
|
|---|
| 134 | stored in the order they are contained in the response XML messages
|
|---|
| 135 | (the order in which data objects are parsed and created for them)</TD>
|
|---|
| 136 | </TR>
|
|---|
| 137 | </TABLE>
|
|---|
| 138 |
|
|---|
| 139 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|---|
| 140 |
|
|---|
| 141 | <A NAME="constructor_summary"><!-- --></A>
|
|---|
| 142 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 143 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 144 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 145 | <B>Constructor Summary</B></FONT></TH>
|
|---|
| 146 | </TR>
|
|---|
| 147 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 148 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#ResponseData()">ResponseData</A></B>()</CODE>
|
|---|
| 149 |
|
|---|
| 150 | <BR>
|
|---|
| 151 | Default constructor, creates the nodeIDsToNodes map</TD>
|
|---|
| 152 | </TR>
|
|---|
| 153 | </TABLE>
|
|---|
| 154 |
|
|---|
| 155 | <!-- ========== METHOD SUMMARY =========== -->
|
|---|
| 156 |
|
|---|
| 157 | <A NAME="method_summary"><!-- --></A>
|
|---|
| 158 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 159 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 160 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 161 | <B>Method Summary</B></FONT></TH>
|
|---|
| 162 | </TR>
|
|---|
| 163 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 164 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 165 | <CODE> void</CODE></FONT></TD>
|
|---|
| 166 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#clear()">clear</A></B>()</CODE>
|
|---|
| 167 |
|
|---|
| 168 | <BR>
|
|---|
| 169 | Clears/resets this ResponseData object of all data, so that it can be
|
|---|
| 170 | reused to process future Browse and Query requests.</TD>
|
|---|
| 171 | </TR>
|
|---|
| 172 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 173 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 174 | <CODE> java.util.Map</CODE></FONT></TD>
|
|---|
| 175 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#getIDToNodeMapping()">getIDToNodeMapping</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> <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A></CODE></FONT></TD>
|
|---|
| 183 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#getNodeForID(java.lang.String)">getNodeForID</A></B>(java.lang.String ID)</CODE>
|
|---|
| 184 |
|
|---|
| 185 | <BR>
|
|---|
| 186 | Given an nodeID, returns the NodeData object with that nodeID,
|
|---|
| 187 | if any.</TD>
|
|---|
| 188 | </TR>
|
|---|
| 189 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 190 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 191 | <CODE> void</CODE></FONT></TD>
|
|---|
| 192 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#setContentForDocs(org.w3c.dom.Element)">setContentForDocs</A></B>(org.w3c.dom.Element messageTag)</CODE>
|
|---|
| 193 |
|
|---|
| 194 | <BR>
|
|---|
| 195 | After a DocumentContentRetrieve request for one or more documents
|
|---|
| 196 | has returned a response, this method - when given the response XML -
|
|---|
| 197 | will set the nodeContents of each document in the response (as long
|
|---|
| 198 | as those documents already have an associated DocumentNodeData
|
|---|
| 199 | object instantiated, which should/would always be the case).</TD>
|
|---|
| 200 | </TR>
|
|---|
| 201 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 202 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 203 | <CODE> boolean</CODE></FONT></TD>
|
|---|
| 204 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#setMetadataForDocuments(org.w3c.dom.Element)">setMetadataForDocuments</A></B>(org.w3c.dom.Element messageTag)</CODE>
|
|---|
| 205 |
|
|---|
| 206 | <BR>
|
|---|
| 207 | This method sets the metadata for one or even all <documentNode>
|
|---|
| 208 | data objects contained in the Map nodeIDsToNodes, using the <message>
|
|---|
| 209 | element parameter (which is returned upon a documentMetadataRetrieve
|
|---|
| 210 | request.</TD>
|
|---|
| 211 | </TR>
|
|---|
| 212 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 213 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 214 | <CODE>protected boolean</CODE></FONT></TD>
|
|---|
| 215 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#setMetadataForNodes(org.w3c.dom.Element, java.lang.String)">setMetadataForNodes</A></B>(org.w3c.dom.Element messageTag,
|
|---|
| 216 | java.lang.String NODE_ELEM)</CODE>
|
|---|
| 217 |
|
|---|
| 218 | <BR>
|
|---|
| 219 | This method can be called after a DocumentMetadataRetrieve request
|
|---|
| 220 | has returned a response.</TD>
|
|---|
| 221 | </TR>
|
|---|
| 222 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 223 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 224 | <CODE>abstract void</CODE></FONT></TD>
|
|---|
| 225 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/ResponseData.html#setResponseData(org.w3c.dom.Element)">setResponseData</A></B>(org.w3c.dom.Element responseMsgTag)</CODE>
|
|---|
| 226 |
|
|---|
| 227 | <BR>
|
|---|
| 228 | Subclasses must implement this method to parse the
|
|---|
| 229 | <message><response></response></message>
|
|---|
| 230 | that is returned upon executing a browse or query request.</TD>
|
|---|
| 231 | </TR>
|
|---|
| 232 | </TABLE>
|
|---|
| 233 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|---|
| 234 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 235 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|---|
| 236 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|---|
| 237 | </TR>
|
|---|
| 238 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 239 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
|---|
| 240 | </TR>
|
|---|
| 241 | </TABLE>
|
|---|
| 242 |
|
|---|
| 243 | <P>
|
|---|
| 244 |
|
|---|
| 245 | <!-- ============ FIELD DETAIL =========== -->
|
|---|
| 246 |
|
|---|
| 247 | <A NAME="field_detail"><!-- --></A>
|
|---|
| 248 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 249 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 250 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 251 | <B>Field Detail</B></FONT></TH>
|
|---|
| 252 | </TR>
|
|---|
| 253 | </TABLE>
|
|---|
| 254 |
|
|---|
| 255 | <A NAME="nodeIDsToNodes"><!-- --></A><H3>
|
|---|
| 256 | nodeIDsToNodes</H3>
|
|---|
| 257 | <PRE>
|
|---|
| 258 | protected java.util.Map <B>nodeIDsToNodes</B></PRE>
|
|---|
| 259 | <DL>
|
|---|
| 260 | <DD>map of (nodeIDs, references to associated NodeData) pairs,
|
|---|
| 261 | stored in the order they are contained in the response XML messages
|
|---|
| 262 | (the order in which data objects are parsed and created for them)
|
|---|
| 263 | <P>
|
|---|
| 264 | <DL>
|
|---|
| 265 | </DL>
|
|---|
| 266 | </DL>
|
|---|
| 267 |
|
|---|
| 268 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|---|
| 269 |
|
|---|
| 270 | <A NAME="constructor_detail"><!-- --></A>
|
|---|
| 271 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 272 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 273 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 274 | <B>Constructor Detail</B></FONT></TH>
|
|---|
| 275 | </TR>
|
|---|
| 276 | </TABLE>
|
|---|
| 277 |
|
|---|
| 278 | <A NAME="ResponseData()"><!-- --></A><H3>
|
|---|
| 279 | ResponseData</H3>
|
|---|
| 280 | <PRE>
|
|---|
| 281 | public <B>ResponseData</B>()</PRE>
|
|---|
| 282 | <DL>
|
|---|
| 283 | <DD>Default constructor, creates the nodeIDsToNodes map
|
|---|
| 284 | <P>
|
|---|
| 285 | </DL>
|
|---|
| 286 |
|
|---|
| 287 | <!-- ============ METHOD DETAIL ========== -->
|
|---|
| 288 |
|
|---|
| 289 | <A NAME="method_detail"><!-- --></A>
|
|---|
| 290 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 291 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 292 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 293 | <B>Method Detail</B></FONT></TH>
|
|---|
| 294 | </TR>
|
|---|
| 295 | </TABLE>
|
|---|
| 296 |
|
|---|
| 297 | <A NAME="setResponseData(org.w3c.dom.Element)"><!-- --></A><H3>
|
|---|
| 298 | setResponseData</H3>
|
|---|
| 299 | <PRE>
|
|---|
| 300 | public abstract void <B>setResponseData</B>(org.w3c.dom.Element responseMsgTag)</PRE>
|
|---|
| 301 | <DL>
|
|---|
| 302 | <DD>Subclasses must implement this method to parse the
|
|---|
| 303 | <message><response></response></message>
|
|---|
| 304 | that is returned upon executing a browse or query request.
|
|---|
| 305 | At the end of this method, the Map nodeIDsToNodes will contain
|
|---|
| 306 | any DocumentNodeData or ClassifierNodeData objects described
|
|---|
| 307 | in the responseMsgTag.
|
|---|
| 308 | <P>
|
|---|
| 309 | <DD><DL>
|
|---|
| 310 | <DT><B>Parameters:</B><DD><CODE>responseMsgTag</CODE> - the XMl response message Element whose data will
|
|---|
| 311 | be parsed and stored in the ResponseData subclass</DL>
|
|---|
| 312 | </DD>
|
|---|
| 313 | </DL>
|
|---|
| 314 | <HR>
|
|---|
| 315 |
|
|---|
| 316 | <A NAME="clear()"><!-- --></A><H3>
|
|---|
| 317 | clear</H3>
|
|---|
| 318 | <PRE>
|
|---|
| 319 | public void <B>clear</B>()</PRE>
|
|---|
| 320 | <DL>
|
|---|
| 321 | <DD>Clears/resets this ResponseData object of all data, so that it can be
|
|---|
| 322 | reused to process future Browse and Query requests. In this case, it
|
|---|
| 323 | merely clears the internal Map nodeIDsToNodes. Subclasses may need to
|
|---|
| 324 | clear other variables.
|
|---|
| 325 | <P>
|
|---|
| 326 | <DD><DL>
|
|---|
| 327 | </DL>
|
|---|
| 328 | </DD>
|
|---|
| 329 | </DL>
|
|---|
| 330 | <HR>
|
|---|
| 331 |
|
|---|
| 332 | <A NAME="getIDToNodeMapping()"><!-- --></A><H3>
|
|---|
| 333 | getIDToNodeMapping</H3>
|
|---|
| 334 | <PRE>
|
|---|
| 335 | public java.util.Map <B>getIDToNodeMapping</B>()</PRE>
|
|---|
| 336 | <DL>
|
|---|
| 337 | <DD><DL>
|
|---|
| 338 |
|
|---|
| 339 | <DT><B>Returns:</B><DD>the Map of mappings from nodeIDs to NodeData object references</DL>
|
|---|
| 340 | </DD>
|
|---|
| 341 | </DL>
|
|---|
| 342 | <HR>
|
|---|
| 343 |
|
|---|
| 344 | <A NAME="getNodeForID(java.lang.String)"><!-- --></A><H3>
|
|---|
| 345 | getNodeForID</H3>
|
|---|
| 346 | <PRE>
|
|---|
| 347 | public <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A> <B>getNodeForID</B>(java.lang.String ID)</PRE>
|
|---|
| 348 | <DL>
|
|---|
| 349 | <DD>Given an nodeID, returns the NodeData object with that nodeID,
|
|---|
| 350 | if any. Otherwise, null is returned. Subclass might want to add
|
|---|
| 351 | a different method that converts this to DocumentNodeData type.
|
|---|
| 352 | <P>
|
|---|
| 353 | <DD><DL>
|
|---|
| 354 | <DT><B>Parameters:</B><DD><CODE>ID</CODE> - is the nodeID whose NodeData object is requested</DL>
|
|---|
| 355 | </DD>
|
|---|
| 356 | </DL>
|
|---|
| 357 | <HR>
|
|---|
| 358 |
|
|---|
| 359 | <A NAME="setContentForDocs(org.w3c.dom.Element)"><!-- --></A><H3>
|
|---|
| 360 | setContentForDocs</H3>
|
|---|
| 361 | <PRE>
|
|---|
| 362 | public void <B>setContentForDocs</B>(org.w3c.dom.Element messageTag)</PRE>
|
|---|
| 363 | <DL>
|
|---|
| 364 | <DD>After a DocumentContentRetrieve request for one or more documents
|
|---|
| 365 | has returned a response, this method - when given the response XML -
|
|---|
| 366 | will set the nodeContents of each document in the response (as long
|
|---|
| 367 | as those documents already have an associated DocumentNodeData
|
|---|
| 368 | object instantiated, which should/would always be the case).
|
|---|
| 369 | <P>
|
|---|
| 370 | <DD><DL>
|
|---|
| 371 | <DT><B>Parameters:</B><DD><CODE>messageTag</CODE> - is the DocumentContentRetrieve XML response message
|
|---|
| 372 | containing the document contents for one or more documentNodes</DL>
|
|---|
| 373 | </DD>
|
|---|
| 374 | </DL>
|
|---|
| 375 | <HR>
|
|---|
| 376 |
|
|---|
| 377 | <A NAME="setMetadataForNodes(org.w3c.dom.Element, java.lang.String)"><!-- --></A><H3>
|
|---|
| 378 | setMetadataForNodes</H3>
|
|---|
| 379 | <PRE>
|
|---|
| 380 | protected boolean <B>setMetadataForNodes</B>(org.w3c.dom.Element messageTag,
|
|---|
| 381 | java.lang.String NODE_ELEM)</PRE>
|
|---|
| 382 | <DL>
|
|---|
| 383 | <DD>This method can be called after a DocumentMetadataRetrieve request
|
|---|
| 384 | has returned a response. Given the response message (XML) element,
|
|---|
| 385 | this method attempts to set the metadata for all the documentNodeData
|
|---|
| 386 | objects it has, using the metadata tags in the response-message-XML.
|
|---|
| 387 | This method returns false if the responseMessage XMl does not contain
|
|---|
| 388 | any <documentNodeList> elements.
|
|---|
| 389 | <P>
|
|---|
| 390 | <DD><DL>
|
|---|
| 391 | <DT><B>Parameters:</B><DD><CODE>NODE_ELEM</CODE> - can be either GSXML defined constant for
|
|---|
| 392 | <ClassifierNode> or <DocumentNode><DD><CODE>messageTag</CODE> - is the DocumentMetadataRetrieve XML response message
|
|---|
| 393 | containing the metadata for one or more documentNodes/classifierNodes
|
|---|
| 394 | as specified by NODE_ELEM</DL>
|
|---|
| 395 | </DD>
|
|---|
| 396 | </DL>
|
|---|
| 397 | <HR>
|
|---|
| 398 |
|
|---|
| 399 | <A NAME="setMetadataForDocuments(org.w3c.dom.Element)"><!-- --></A><H3>
|
|---|
| 400 | setMetadataForDocuments</H3>
|
|---|
| 401 | <PRE>
|
|---|
| 402 | public boolean <B>setMetadataForDocuments</B>(org.w3c.dom.Element messageTag)</PRE>
|
|---|
| 403 | <DL>
|
|---|
| 404 | <DD>This method sets the metadata for one or even all <documentNode>
|
|---|
| 405 | data objects contained in the Map nodeIDsToNodes, using the <message>
|
|---|
| 406 | element parameter (which is returned upon a documentMetadataRetrieve
|
|---|
| 407 | request. Metadata for <classifierNodes> are not set with this method.
|
|---|
| 408 | It merely calls the setMetadataForDocuments(messageTag, tagName)
|
|---|
| 409 | method to parse out data for the tagName=<documentNode>.
|
|---|
| 410 | <P>
|
|---|
| 411 | <DD><DL>
|
|---|
| 412 | <DT><B>Parameters:</B><DD><CODE>messageTag</CODE> - is the DocumentMetadataRetrieve XML response message
|
|---|
| 413 | containing the metadata for one or more documentNodes</DL>
|
|---|
| 414 | </DD>
|
|---|
| 415 | </DL>
|
|---|
| 416 | <!-- ========= END OF CLASS DATA ========= -->
|
|---|
| 417 | <HR>
|
|---|
| 418 |
|
|---|
| 419 |
|
|---|
| 420 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|---|
| 421 | <A NAME="navbar_bottom"><!-- --></A>
|
|---|
| 422 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|---|
| 423 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|---|
| 424 | <TR>
|
|---|
| 425 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|---|
| 426 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|---|
| 427 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|---|
| 428 | <TR ALIGN="center" VALIGN="top">
|
|---|
| 429 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|---|
| 430 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|---|
| 431 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|---|
| 432 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|---|
| 433 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|---|
| 434 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|---|
| 435 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|---|
| 436 | </TR>
|
|---|
| 437 | </TABLE>
|
|---|
| 438 | </TD>
|
|---|
| 439 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|---|
| 440 | </EM>
|
|---|
| 441 | </TD>
|
|---|
| 442 | </TR>
|
|---|
| 443 |
|
|---|
| 444 | <TR>
|
|---|
| 445 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 446 | <A HREF="../../../../org/greenstone/gs3client/data/QueryResponseData.TermData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
|
|---|
| 447 | NEXT CLASS</FONT></TD>
|
|---|
| 448 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 449 | <A HREF="../../../../index.html?org/greenstone/gs3client/data/ResponseData.html" target="_top"><B>FRAMES</B></A>
|
|---|
| 450 | <A HREF="ResponseData.html" target="_top"><B>NO FRAMES</B></A>
|
|---|
| 451 | <SCRIPT type="text/javascript">
|
|---|
| 452 | <!--
|
|---|
| 453 | if(window==top) {
|
|---|
| 454 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|---|
| 455 | }
|
|---|
| 456 | //-->
|
|---|
| 457 | </SCRIPT>
|
|---|
| 458 | <NOSCRIPT>
|
|---|
| 459 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|---|
| 460 | </NOSCRIPT>
|
|---|
| 461 |
|
|---|
| 462 |
|
|---|
| 463 | </FONT></TD>
|
|---|
| 464 | </TR>
|
|---|
| 465 | <TR>
|
|---|
| 466 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 467 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|---|
| 468 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 469 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|---|
| 470 | </TR>
|
|---|
| 471 | </TABLE>
|
|---|
| 472 | <A NAME="skip-navbar_bottom"></A>
|
|---|
| 473 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|---|
| 474 |
|
|---|
| 475 | <HR>
|
|---|
| 476 |
|
|---|
| 477 | </BODY>
|
|---|
| 478 | </HTML>
|
|---|
