[15222] | 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 | DocumentNodeData
|
---|
| 8 | </TITLE>
|
---|
| 9 |
|
---|
| 10 | <META NAME="keywords" CONTENT="org.greenstone.gs3client.data.DocumentNodeData 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="DocumentNodeData";
|
---|
| 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/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
|
---|
| 55 | <A HREF="../../../../org/greenstone/gs3client/data/MetaData.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/DocumentNodeData.html" target="_top"><B>FRAMES</B></A>
|
---|
| 58 | <A HREF="DocumentNodeData.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 DocumentNodeData</H2>
|
---|
| 90 | <PRE>
|
---|
| 91 | java.lang.Object
|
---|
| 92 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">org.greenstone.gs3client.data.NodeData</A>
|
---|
| 93 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.data.DocumentNodeData</B>
|
---|
| 94 | </PRE>
|
---|
| 95 | <HR>
|
---|
| 96 | <DL>
|
---|
| 97 | <DT><PRE>public class <B>DocumentNodeData</B><DT>extends <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A></DL>
|
---|
| 98 | </PRE>
|
---|
| 99 |
|
---|
| 100 | <P>
|
---|
| 101 | Represents the data stored in the <documentNode> Elements
|
---|
| 102 | of Greenstone 3's XML response messages. A DocumentNodeData may
|
---|
| 103 | have descendants of type DocumentNodeData. Some DocumentNodeData
|
---|
| 104 | objects are the root of a structure, others are internal nodes or
|
---|
| 105 | leaves.
|
---|
| 106 | See p.47 to p.49 in the manual.
|
---|
| 107 | <P>
|
---|
| 108 |
|
---|
| 109 | <P>
|
---|
| 110 | <DL>
|
---|
| 111 | <DT><B>Author:</B></DT>
|
---|
| 112 | <DD>ak19</DD>
|
---|
| 113 | </DL>
|
---|
| 114 | <HR>
|
---|
| 115 |
|
---|
| 116 | <P>
|
---|
| 117 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
| 118 |
|
---|
| 119 | <A NAME="field_summary"><!-- --></A>
|
---|
| 120 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 121 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 122 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
| 123 | <B>Field Summary</B></FONT></TH>
|
---|
| 124 | </TR>
|
---|
| 125 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 126 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 127 | <CODE>protected <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>[]</CODE></FONT></TD>
|
---|
| 128 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#childnodes">childnodes</A></B></CODE>
|
---|
| 129 |
|
---|
| 130 | <BR>
|
---|
| 131 | children of this node: part of <nodeStructure> Element</TD>
|
---|
| 132 | </TR>
|
---|
| 133 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 134 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 135 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 136 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#docType">docType</A></B></CODE>
|
---|
| 137 |
|
---|
| 138 | <BR>
|
---|
| 139 | DocType can be Hierarchical for instance</TD>
|
---|
| 140 | </TR>
|
---|
| 141 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 142 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 143 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
| 144 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#nodeContent">nodeContent</A></B></CODE>
|
---|
| 145 |
|
---|
| 146 | <BR>
|
---|
| 147 | The text content of the document</TD>
|
---|
| 148 | </TR>
|
---|
| 149 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 150 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 151 | <CODE>protected java.util.HashMap</CODE></FONT></TD>
|
---|
| 152 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#nodeStructureInfo_map">nodeStructureInfo_map</A></B></CODE>
|
---|
| 153 |
|
---|
| 154 | <BR>
|
---|
| 155 | A Hashmap to store <nodeStructureInfo> of a DocumentNodeData
|
---|
| 156 | (if it has any)</TD>
|
---|
| 157 | </TR>
|
---|
| 158 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 159 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 160 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 161 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#nodeType">nodeType</A></B></CODE>
|
---|
| 162 |
|
---|
| 163 | <BR>
|
---|
| 164 | NodeType of this DocumentNodeData: root, internal or leaf</TD>
|
---|
| 165 | </TR>
|
---|
| 166 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 167 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 168 | <CODE> double</CODE></FONT></TD>
|
---|
| 169 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#rank">rank</A></B></CODE>
|
---|
| 170 |
|
---|
| 171 | <BR>
|
---|
| 172 | Rank of this DocumentNodeData if the <documentNode>
|
---|
| 173 | Element was returned in a search result</TD>
|
---|
| 174 | </TR>
|
---|
| 175 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 176 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 177 | <CODE>protected <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A></CODE></FONT></TD>
|
---|
| 178 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#rootDoc">rootDoc</A></B></CODE>
|
---|
| 179 |
|
---|
| 180 | <BR>
|
---|
| 181 | Reference to this doc's root</TD>
|
---|
| 182 | </TR>
|
---|
| 183 | </TABLE>
|
---|
| 184 | <A NAME="fields_inherited_from_class_org.greenstone.gs3client.data.NodeData"><!-- --></A>
|
---|
| 185 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 186 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 187 | <TH ALIGN="left"><B>Fields inherited from class org.greenstone.gs3client.data.<A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A></B></TH>
|
---|
| 188 | </TR>
|
---|
| 189 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 190 | <TD><CODE><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#hasChildren">hasChildren</A>, <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#nodeID">nodeID</A>, <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#nodeMetadata">nodeMetadata</A>, <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#nodeTag">nodeTag</A></CODE></TD>
|
---|
| 191 | </TR>
|
---|
| 192 | </TABLE>
|
---|
| 193 |
|
---|
| 194 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
| 195 |
|
---|
| 196 | <A NAME="constructor_summary"><!-- --></A>
|
---|
| 197 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 198 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 199 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
| 200 | <B>Constructor Summary</B></FONT></TH>
|
---|
| 201 | </TR>
|
---|
| 202 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 203 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#DocumentNodeData(org.w3c.dom.Element)">DocumentNodeData</A></B>(org.w3c.dom.Element docNodeTag)</CODE>
|
---|
| 204 |
|
---|
| 205 | <BR>
|
---|
| 206 | Given tags of the form
|
---|
| 207 | <documentNode nodeID="HASHac0a04dd14571c60d7fbfd.4.2"
|
---|
| 208 | nodeType="x" docType="y">
|
---|
| 209 | <nodeContent>Text</nodeContent>
|
---|
| 210 | <nodeStructureInfo><info name="i" value="1" />
|
---|
| 211 | <info name = "ii" value = "2" /></nodeStructureInfo>
|
---|
| 212 | <metadataList><metadata name="a">Value
|
---|
| 213 | </metadata></metadataList>
|
---|
| 214 | <nodeStructure>
|
---|
| 215 | <documentNode ....></documentNode>
|
---|
| 216 | <documentNode ....></documentNode>
|
---|
| 217 | </nodeStructure>
|
---|
| 218 | </documentNode>
|
---|
| 219 | this constructor extracts the nodeId out of it and any other fields
|
---|
| 220 | that might be set in the docNodeTag <documentNode> element.</TD>
|
---|
| 221 | </TR>
|
---|
| 222 | </TABLE>
|
---|
| 223 |
|
---|
| 224 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
| 225 |
|
---|
| 226 | <A NAME="method_summary"><!-- --></A>
|
---|
| 227 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 228 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 229 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
---|
| 230 | <B>Method Summary</B></FONT></TH>
|
---|
| 231 | </TR>
|
---|
| 232 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 233 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 234 | <CODE> boolean</CODE></FONT></TD>
|
---|
| 235 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#canBeImage()">canBeImage</A></B>()</CODE>
|
---|
| 236 |
|
---|
| 237 | <BR>
|
---|
| 238 | </TD>
|
---|
| 239 | </TR>
|
---|
| 240 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 241 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 242 | <CODE>protected static void</CODE></FONT></TD>
|
---|
| 243 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#descNodeIDsAsList(java.util.Vector, org.greenstone.gs3client.data.DocumentNodeData, boolean)">descNodeIDsAsList</A></B>(java.util.Vector v,
|
---|
| 244 | <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> parent,
|
---|
| 245 | boolean onlyTheUntitled)</CODE>
|
---|
| 246 |
|
---|
| 247 | <BR>
|
---|
| 248 | Recursive method that adds all the nodeIDs of the descendents
|
---|
| 249 | of DocumentNodeData parent into the Vector v.</TD>
|
---|
| 250 | </TR>
|
---|
| 251 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 252 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 253 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 254 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getAssocFilePath()">getAssocFilePath</A></B>()</CODE>
|
---|
| 255 |
|
---|
| 256 | <BR>
|
---|
| 257 | </TD>
|
---|
| 258 | </TR>
|
---|
| 259 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 260 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 261 | <CODE> java.util.Vector</CODE></FONT></TD>
|
---|
| 262 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getAssociatedFileNames()">getAssociatedFileNames</A></B>()</CODE>
|
---|
| 263 |
|
---|
| 264 | <BR>
|
---|
| 265 | </TD>
|
---|
| 266 | </TR>
|
---|
| 267 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 268 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 269 | <CODE> <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A>[]</CODE></FONT></TD>
|
---|
| 270 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getChildren()">getChildren</A></B>()</CODE>
|
---|
| 271 |
|
---|
| 272 | <BR>
|
---|
| 273 | </TD>
|
---|
| 274 | </TR>
|
---|
| 275 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 276 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 277 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 278 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getContent()">getContent</A></B>()</CODE>
|
---|
| 279 |
|
---|
| 280 | <BR>
|
---|
| 281 | </TD>
|
---|
| 282 | </TR>
|
---|
| 283 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 284 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 285 | <CODE> <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>[]</CODE></FONT></TD>
|
---|
| 286 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getDescendents()">getDescendents</A></B>()</CODE>
|
---|
| 287 |
|
---|
| 288 | <BR>
|
---|
| 289 | </TD>
|
---|
| 290 | </TR>
|
---|
| 291 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 292 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 293 | <CODE> java.lang.String[]</CODE></FONT></TD>
|
---|
| 294 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getDescNodeIDsAsList(boolean)">getDescNodeIDsAsList</A></B>(boolean onlyTheUntitled)</CODE>
|
---|
| 295 |
|
---|
| 296 | <BR>
|
---|
| 297 | When called on a rootNode, returns an array of all the descendents'
|
---|
| 298 | nodeIDs.</TD>
|
---|
| 299 | </TR>
|
---|
| 300 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 301 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 302 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 303 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getDocType()">getDocType</A></B>()</CODE>
|
---|
| 304 |
|
---|
| 305 | <BR>
|
---|
| 306 | </TD>
|
---|
| 307 | </TR>
|
---|
| 308 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 309 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 310 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 311 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getImgName()">getImgName</A></B>()</CODE>
|
---|
| 312 |
|
---|
| 313 | <BR>
|
---|
| 314 | </TD>
|
---|
| 315 | </TR>
|
---|
| 316 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 317 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 318 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 319 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getImgURL()">getImgURL</A></B>()</CODE>
|
---|
| 320 |
|
---|
| 321 | <BR>
|
---|
| 322 | </TD>
|
---|
| 323 | </TR>
|
---|
| 324 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 325 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 326 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 327 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getNodeType()">getNodeType</A></B>()</CODE>
|
---|
| 328 |
|
---|
| 329 | <BR>
|
---|
| 330 | </TD>
|
---|
| 331 | </TR>
|
---|
| 332 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 333 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 334 | <CODE> <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A></CODE></FONT></TD>
|
---|
| 335 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#getRoot()">getRoot</A></B>()</CODE>
|
---|
| 336 |
|
---|
| 337 | <BR>
|
---|
| 338 | </TD>
|
---|
| 339 | </TR>
|
---|
| 340 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 341 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 342 | <CODE> boolean</CODE></FONT></TD>
|
---|
| 343 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#hasNoText()">hasNoText</A></B>()</CODE>
|
---|
| 344 |
|
---|
| 345 | <BR>
|
---|
| 346 | </TD>
|
---|
| 347 | </TR>
|
---|
| 348 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 349 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 350 | <CODE> boolean</CODE></FONT></TD>
|
---|
| 351 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#isLeaf()">isLeaf</A></B>()</CODE>
|
---|
| 352 |
|
---|
| 353 | <BR>
|
---|
| 354 | </TD>
|
---|
| 355 | </TR>
|
---|
| 356 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 357 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 358 | <CODE>protected void</CODE></FONT></TD>
|
---|
| 359 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#setDescendents(org.greenstone.gs3client.data.DocumentNodeData, org.w3c.dom.Element, java.util.Map)">setDescendents</A></B>(<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> root,
|
---|
| 360 | org.w3c.dom.Element docNodeTag,
|
---|
| 361 | java.util.Map nodeIDsToDocNodes_map)</CODE>
|
---|
| 362 |
|
---|
| 363 | <BR>
|
---|
| 364 | Recursive method.</TD>
|
---|
| 365 | </TR>
|
---|
| 366 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 367 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 368 | <CODE> <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A></CODE></FONT></TD>
|
---|
| 369 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#setDescendentsOfRootNode(org.w3c.dom.Element, java.util.Map)">setDescendentsOfRootNode</A></B>(org.w3c.dom.Element nodeStructure,
|
---|
| 370 | java.util.Map nodeIDsToDocNodes_map)</CODE>
|
---|
| 371 |
|
---|
| 372 | <BR>
|
---|
| 373 | Given a <nodeStructure></nodeStructure> element returned
|
---|
| 374 | from a request for the *ENTIRE* nodeStructure, this method will find the
|
---|
| 375 | <documentNode> that is the Root (nodeType=ROOT) and from there
|
---|
| 376 | on proceed to set all descendent <documentNode>s.</TD>
|
---|
| 377 | </TR>
|
---|
| 378 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 379 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 380 | <CODE> void</CODE></FONT></TD>
|
---|
| 381 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#setNodeContent(org.w3c.dom.Element)">setNodeContent</A></B>(org.w3c.dom.Element docNodeTag)</CODE>
|
---|
| 382 |
|
---|
| 383 | <BR>
|
---|
| 384 | Sets member variable nodeContent with the text (if any) inside any
|
---|
| 385 | <nodeContent></nodeContent> child element of
|
---|
| 386 | <documentNode>, else the value of nodeContent is set to empty
|
---|
| 387 | string ("").</TD>
|
---|
| 388 | </TR>
|
---|
| 389 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 390 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 391 | <CODE> void</CODE></FONT></TD>
|
---|
| 392 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#setNodeStructInfo(org.w3c.dom.Element)">setNodeStructInfo</A></B>(org.w3c.dom.Element docNodeTag)</CODE>
|
---|
| 393 |
|
---|
| 394 | <BR>
|
---|
| 395 | Sets structureInfo member variable <nodeStructureInfo> element is
|
---|
| 396 | present as child of <documentNode>, else value of structureInfo
|
---|
| 397 | remains unchanged.</TD>
|
---|
| 398 | </TR>
|
---|
| 399 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 400 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
| 401 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
| 402 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html#show()">show</A></B>()</CODE>
|
---|
| 403 |
|
---|
| 404 | <BR>
|
---|
| 405 | </TD>
|
---|
| 406 | </TR>
|
---|
| 407 | </TABLE>
|
---|
| 408 | <A NAME="methods_inherited_from_class_org.greenstone.gs3client.data.NodeData"><!-- --></A>
|
---|
| 409 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 410 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 411 | <TH ALIGN="left"><B>Methods inherited from class org.greenstone.gs3client.data.<A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A></B></TH>
|
---|
| 412 | </TR>
|
---|
| 413 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 414 | <TD><CODE><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#getMetadataList()">getMetadataList</A>, <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#getTitle()">getTitle</A>, <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#setChildren(java.util.Vector, java.util.Map)">setChildren</A>, <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#setMetadataList(org.w3c.dom.Element)">setMetadataList</A>, <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#showMeta()">showMeta</A>, <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#toString()">toString</A></CODE></TD>
|
---|
| 415 | </TR>
|
---|
| 416 | </TABLE>
|
---|
| 417 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
| 418 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 419 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
| 420 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
---|
| 421 | </TR>
|
---|
| 422 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
| 423 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
|
---|
| 424 | </TR>
|
---|
| 425 | </TABLE>
|
---|
| 426 |
|
---|
| 427 | <P>
|
---|
| 428 |
|
---|
| 429 | <!-- ============ FIELD DETAIL =========== -->
|
---|
| 430 |
|
---|
| 431 | <A NAME="field_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>Field Detail</B></FONT></TH>
|
---|
| 436 | </TR>
|
---|
| 437 | </TABLE>
|
---|
| 438 |
|
---|
| 439 | <A NAME="nodeType"><!-- --></A><H3>
|
---|
| 440 | nodeType</H3>
|
---|
| 441 | <PRE>
|
---|
| 442 | public final java.lang.String <B>nodeType</B></PRE>
|
---|
| 443 | <DL>
|
---|
| 444 | <DD>NodeType of this DocumentNodeData: root, internal or leaf
|
---|
| 445 | <P>
|
---|
| 446 | <DL>
|
---|
| 447 | </DL>
|
---|
| 448 | </DL>
|
---|
| 449 | <HR>
|
---|
| 450 |
|
---|
| 451 | <A NAME="docType"><!-- --></A><H3>
|
---|
| 452 | docType</H3>
|
---|
| 453 | <PRE>
|
---|
| 454 | public final java.lang.String <B>docType</B></PRE>
|
---|
| 455 | <DL>
|
---|
| 456 | <DD>DocType can be Hierarchical for instance
|
---|
| 457 | <P>
|
---|
| 458 | <DL>
|
---|
| 459 | </DL>
|
---|
| 460 | </DL>
|
---|
| 461 | <HR>
|
---|
| 462 |
|
---|
| 463 | <A NAME="rank"><!-- --></A><H3>
|
---|
| 464 | rank</H3>
|
---|
| 465 | <PRE>
|
---|
| 466 | public final double <B>rank</B></PRE>
|
---|
| 467 | <DL>
|
---|
| 468 | <DD>Rank of this DocumentNodeData if the <documentNode>
|
---|
| 469 | Element was returned in a search result
|
---|
| 470 | <P>
|
---|
| 471 | <DL>
|
---|
| 472 | </DL>
|
---|
| 473 | </DL>
|
---|
| 474 | <HR>
|
---|
| 475 |
|
---|
| 476 | <A NAME="rootDoc"><!-- --></A><H3>
|
---|
| 477 | rootDoc</H3>
|
---|
| 478 | <PRE>
|
---|
| 479 | protected <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> <B>rootDoc</B></PRE>
|
---|
| 480 | <DL>
|
---|
| 481 | <DD>Reference to this doc's root
|
---|
| 482 | <P>
|
---|
| 483 | <DL>
|
---|
| 484 | </DL>
|
---|
| 485 | </DL>
|
---|
| 486 | <HR>
|
---|
| 487 |
|
---|
| 488 | <A NAME="childnodes"><!-- --></A><H3>
|
---|
| 489 | childnodes</H3>
|
---|
| 490 | <PRE>
|
---|
| 491 | protected <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>[] <B>childnodes</B></PRE>
|
---|
| 492 | <DL>
|
---|
| 493 | <DD>children of this node: part of <nodeStructure> Element
|
---|
| 494 | <P>
|
---|
| 495 | <DL>
|
---|
| 496 | </DL>
|
---|
| 497 | </DL>
|
---|
| 498 | <HR>
|
---|
| 499 |
|
---|
| 500 | <A NAME="nodeStructureInfo_map"><!-- --></A><H3>
|
---|
| 501 | nodeStructureInfo_map</H3>
|
---|
| 502 | <PRE>
|
---|
| 503 | protected java.util.HashMap <B>nodeStructureInfo_map</B></PRE>
|
---|
| 504 | <DL>
|
---|
| 505 | <DD>A Hashmap to store <nodeStructureInfo> of a DocumentNodeData
|
---|
| 506 | (if it has any)
|
---|
| 507 | <P>
|
---|
| 508 | <DL>
|
---|
| 509 | </DL>
|
---|
| 510 | </DL>
|
---|
| 511 | <HR>
|
---|
| 512 |
|
---|
| 513 | <A NAME="nodeContent"><!-- --></A><H3>
|
---|
| 514 | nodeContent</H3>
|
---|
| 515 | <PRE>
|
---|
| 516 | protected java.lang.String <B>nodeContent</B></PRE>
|
---|
| 517 | <DL>
|
---|
| 518 | <DD>The text content of the document
|
---|
| 519 | <P>
|
---|
| 520 | <DL>
|
---|
| 521 | </DL>
|
---|
| 522 | </DL>
|
---|
| 523 |
|
---|
| 524 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
| 525 |
|
---|
| 526 | <A NAME="constructor_detail"><!-- --></A>
|
---|
| 527 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 528 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 529 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
| 530 | <B>Constructor Detail</B></FONT></TH>
|
---|
| 531 | </TR>
|
---|
| 532 | </TABLE>
|
---|
| 533 |
|
---|
| 534 | <A NAME="DocumentNodeData(org.w3c.dom.Element)"><!-- --></A><H3>
|
---|
| 535 | DocumentNodeData</H3>
|
---|
| 536 | <PRE>
|
---|
| 537 | public <B>DocumentNodeData</B>(org.w3c.dom.Element docNodeTag)</PRE>
|
---|
| 538 | <DL>
|
---|
| 539 | <DD>Given tags of the form
|
---|
| 540 | <documentNode nodeID="HASHac0a04dd14571c60d7fbfd.4.2"
|
---|
| 541 | nodeType="x" docType="y">
|
---|
| 542 | <nodeContent>Text</nodeContent>
|
---|
| 543 | <nodeStructureInfo><info name="i" value="1" />
|
---|
| 544 | <info name = "ii" value = "2" /></nodeStructureInfo>
|
---|
| 545 | <metadataList><metadata name="a">Value
|
---|
| 546 | </metadata></metadataList>
|
---|
| 547 | <nodeStructure>
|
---|
| 548 | <documentNode ....></documentNode>
|
---|
| 549 | <documentNode ....></documentNode>
|
---|
| 550 | </nodeStructure>
|
---|
| 551 | </documentNode>
|
---|
| 552 | this constructor extracts the nodeId out of it and any other fields
|
---|
| 553 | that might be set in the docNodeTag <documentNode> element.
|
---|
| 554 | <P>
|
---|
| 555 | <DL>
|
---|
| 556 | <DT><B>Parameters:</B><DD><CODE>docNodeTag</CODE> - is an <documentNode> XML element to construct
|
---|
| 557 | this DocumentNodeData object from</DL>
|
---|
| 558 | </DL>
|
---|
| 559 |
|
---|
| 560 | <!-- ============ METHOD DETAIL ========== -->
|
---|
| 561 |
|
---|
| 562 | <A NAME="method_detail"><!-- --></A>
|
---|
| 563 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
| 564 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
| 565 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
---|
| 566 | <B>Method Detail</B></FONT></TH>
|
---|
| 567 | </TR>
|
---|
| 568 | </TABLE>
|
---|
| 569 |
|
---|
| 570 | <A NAME="setDescendentsOfRootNode(org.w3c.dom.Element, java.util.Map)"><!-- --></A><H3>
|
---|
| 571 | setDescendentsOfRootNode</H3>
|
---|
| 572 | <PRE>
|
---|
| 573 | public <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> <B>setDescendentsOfRootNode</B>(org.w3c.dom.Element nodeStructure,
|
---|
| 574 | java.util.Map nodeIDsToDocNodes_map)</PRE>
|
---|
| 575 | <DL>
|
---|
| 576 | <DD>Given a <nodeStructure></nodeStructure> element returned
|
---|
| 577 | from a request for the *ENTIRE* nodeStructure, this method will find the
|
---|
| 578 | <documentNode> that is the Root (nodeType=ROOT) and from there
|
---|
| 579 | on proceed to set all descendent <documentNode>s.
|
---|
| 580 | If either the root or any descendent <documentNode>s have already
|
---|
| 581 | been instantiated at any point during program execution, it will
|
---|
| 582 | be reused, else a new object representing that descendent/root
|
---|
| 583 | <documentNode> will be created.
|
---|
| 584 | The nodeIDsToDocNodes_map is a mapping of nodeIDs to existing
|
---|
| 585 | documentNodeData objects, so that the DocumentNodeData objects with
|
---|
| 586 | the same ID need not be instantiated where they already exist.
|
---|
| 587 | This method returns the rootNode if it completes successfully,
|
---|
| 588 | otherwise it returns null.
|
---|
| 589 | <P>
|
---|
| 590 | <DD><DL>
|
---|
| 591 | <DT><B>Parameters:</B><DD><CODE>nodeStructure</CODE> - is the <nodeStructure></nodeStructure>
|
---|
| 592 | element returned from a request for the *ENTIRE* nodeStructure<DD><CODE>nodeIDsToDocNodes_map</CODE> - is the Map of node IDs to DocumentNodeData
|
---|
| 593 | objects being maintained
|
---|
| 594 | <DT><B>Returns:</B><DD>the root DocumentNodeData object of the <documentNode>s
|
---|
| 595 | in the <nodeStructure></DL>
|
---|
| 596 | </DD>
|
---|
| 597 | </DL>
|
---|
| 598 | <HR>
|
---|
| 599 |
|
---|
| 600 | <A NAME="setDescendents(org.greenstone.gs3client.data.DocumentNodeData, org.w3c.dom.Element, java.util.Map)"><!-- --></A><H3>
|
---|
| 601 | setDescendents</H3>
|
---|
| 602 | <PRE>
|
---|
| 603 | protected void <B>setDescendents</B>(<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> root,
|
---|
| 604 | org.w3c.dom.Element docNodeTag,
|
---|
| 605 | java.util.Map nodeIDsToDocNodes_map)</PRE>
|
---|
| 606 | <DL>
|
---|
| 607 | <DD>Recursive method.
|
---|
| 608 | Called by setDescendentsOfRootNode(). Given a docNodeTag (of the Root)
|
---|
| 609 | which was nested within a <nodeStructure> element, this method sets
|
---|
| 610 | all the descendents of that root. This means that each documentNodeData
|
---|
| 611 | object in the hierarchy of the root will have its childnodes[] variable
|
---|
| 612 | set, iff that object is not a nodeType==LEAF. With leaves, the
|
---|
| 613 | childnodes array will remain null.
|
---|
| 614 | The nodeIDsToDocNodes_map is a mapping of nodeIDs to existing
|
---|
| 615 | documentNodeData objects, so that the DocumentNodeData objects with the
|
---|
| 616 | same ID need not be instantiated where they already exist.
|
---|
| 617 | <P>
|
---|
| 618 | <DD><DL>
|
---|
| 619 | <DT><B>Parameters:</B><DD><CODE>root</CODE> - - the root element of this documentNodeData<DD><CODE>docNodeTag</CODE> - - the <documentNode> XML Element of the Root
|
---|
| 620 | nested within a <nodeStructure> element<DD><CODE>nodeIDsToDocNodes_map</CODE> - is the Map of node IDs to DocumentNodeData
|
---|
| 621 | objects being maintained</DL>
|
---|
| 622 | </DD>
|
---|
| 623 | </DL>
|
---|
| 624 | <HR>
|
---|
| 625 |
|
---|
| 626 | <A NAME="setNodeStructInfo(org.w3c.dom.Element)"><!-- --></A><H3>
|
---|
| 627 | setNodeStructInfo</H3>
|
---|
| 628 | <PRE>
|
---|
| 629 | public void <B>setNodeStructInfo</B>(org.w3c.dom.Element docNodeTag)</PRE>
|
---|
| 630 | <DL>
|
---|
| 631 | <DD>Sets structureInfo member variable <nodeStructureInfo> element is
|
---|
| 632 | present as child of <documentNode>, else value of structureInfo
|
---|
| 633 | remains unchanged. A <docNode> has no more than one child
|
---|
| 634 | <nodeStructureInfo> in a response to a DocumentStructureRetrieve.
|
---|
| 635 | However, the response can contain many such <docNodes>.
|
---|
| 636 | See manual p.49.
|
---|
| 637 | <P>
|
---|
| 638 | <DD><DL>
|
---|
| 639 | <DT><B>Parameters:</B><DD><CODE>docNodeTag</CODE> - is the <documentNode> XML element containing
|
---|
| 640 | the <nodeStructureInfo> Element that is to be processed</DL>
|
---|
| 641 | </DD>
|
---|
| 642 | </DL>
|
---|
| 643 | <HR>
|
---|
| 644 |
|
---|
| 645 | <A NAME="setNodeContent(org.w3c.dom.Element)"><!-- --></A><H3>
|
---|
| 646 | setNodeContent</H3>
|
---|
| 647 | <PRE>
|
---|
| 648 | public void <B>setNodeContent</B>(org.w3c.dom.Element docNodeTag)</PRE>
|
---|
| 649 | <DL>
|
---|
| 650 | <DD>Sets member variable nodeContent with the text (if any) inside any
|
---|
| 651 | <nodeContent></nodeContent> child element of
|
---|
| 652 | <documentNode>, else the value of nodeContent is set to empty
|
---|
| 653 | string (""). The empty string will prevent it from being retrieved again
|
---|
| 654 | and again (which would happen if nodeContent remained at null) if it had
|
---|
| 655 | already been retrieved once.
|
---|
| 656 | However, if the docNodeTag parameter is not the response from
|
---|
| 657 | a documentContentRetrieve (if it doesn't have the proper XML
|
---|
| 658 | structure for that), nodeContent remains null and can be set
|
---|
| 659 | in future when given an appropriate docNodeTag.
|
---|
| 660 | <P>
|
---|
| 661 | <DD><DL>
|
---|
| 662 | <DT><B>Parameters:</B><DD><CODE>docNodeTag</CODE> - is the <documentNode> XML element containing
|
---|
| 663 | the content information for this DocumentNodeData object</DL>
|
---|
| 664 | </DD>
|
---|
| 665 | </DL>
|
---|
| 666 | <HR>
|
---|
| 667 |
|
---|
| 668 | <A NAME="show()"><!-- --></A><H3>
|
---|
| 669 | show</H3>
|
---|
| 670 | <PRE>
|
---|
| 671 | public java.lang.String <B>show</B>()</PRE>
|
---|
| 672 | <DL>
|
---|
| 673 | <DD><DL>
|
---|
| 674 | <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#show()">show</A></CODE> in class <CODE><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A></CODE></DL>
|
---|
| 675 | </DD>
|
---|
| 676 | <DD><DL>
|
---|
| 677 |
|
---|
| 678 | <DT><B>Returns:</B><DD>the data stored in this DocumentNodeData object, all except
|
---|
| 679 | the document content which can be accessed by calling toString().
|
---|
| 680 | This method is useful for debugging purposes: to view what each
|
---|
| 681 | field's values are.</DL>
|
---|
| 682 | </DD>
|
---|
| 683 | </DL>
|
---|
| 684 | <HR>
|
---|
| 685 |
|
---|
| 686 | <A NAME="isLeaf()"><!-- --></A><H3>
|
---|
| 687 | isLeaf</H3>
|
---|
| 688 | <PRE>
|
---|
| 689 | public boolean <B>isLeaf</B>()</PRE>
|
---|
| 690 | <DL>
|
---|
| 691 | <DD><DL>
|
---|
| 692 |
|
---|
| 693 | <DT><B>Returns:</B><DD>true if the (nodeType of) this DocumentNodeData is a leaf</DL>
|
---|
| 694 | </DD>
|
---|
| 695 | </DL>
|
---|
| 696 | <HR>
|
---|
| 697 |
|
---|
| 698 | <A NAME="getNodeType()"><!-- --></A><H3>
|
---|
| 699 | getNodeType</H3>
|
---|
| 700 | <PRE>
|
---|
| 701 | public java.lang.String <B>getNodeType</B>()</PRE>
|
---|
| 702 | <DL>
|
---|
| 703 | <DD><DL>
|
---|
| 704 |
|
---|
| 705 | <DT><B>Returns:</B><DD>the nodeType of this DocumentNodeData</DL>
|
---|
| 706 | </DD>
|
---|
| 707 | </DL>
|
---|
| 708 | <HR>
|
---|
| 709 |
|
---|
| 710 | <A NAME="getDocType()"><!-- --></A><H3>
|
---|
| 711 | getDocType</H3>
|
---|
| 712 | <PRE>
|
---|
| 713 | public java.lang.String <B>getDocType</B>()</PRE>
|
---|
| 714 | <DL>
|
---|
| 715 | <DD><DL>
|
---|
| 716 |
|
---|
| 717 | <DT><B>Returns:</B><DD>the docType of this DocumentNodeData</DL>
|
---|
| 718 | </DD>
|
---|
| 719 | </DL>
|
---|
| 720 | <HR>
|
---|
| 721 |
|
---|
| 722 | <A NAME="getRoot()"><!-- --></A><H3>
|
---|
| 723 | getRoot</H3>
|
---|
| 724 | <PRE>
|
---|
| 725 | public <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> <B>getRoot</B>()</PRE>
|
---|
| 726 | <DL>
|
---|
| 727 | <DD><DL>
|
---|
| 728 |
|
---|
| 729 | <DT><B>Returns:</B><DD>the root of the structure of which this documentNodeData
|
---|
| 730 | is part (this docNodeData is either the root itself or its child
|
---|
| 731 | or descenedent). A null is returned if the Root docNode and its
|
---|
| 732 | descendents have not been set yet.</DL>
|
---|
| 733 | </DD>
|
---|
| 734 | </DL>
|
---|
| 735 | <HR>
|
---|
| 736 |
|
---|
| 737 | <A NAME="getContent()"><!-- --></A><H3>
|
---|
| 738 | getContent</H3>
|
---|
| 739 | <PRE>
|
---|
| 740 | public java.lang.String <B>getContent</B>()</PRE>
|
---|
| 741 | <DL>
|
---|
| 742 | <DD><DL>
|
---|
| 743 |
|
---|
| 744 | <DT><B>Returns:</B><DD>this document's text content (which may be empty string
|
---|
| 745 | if there was none). It will return null if the nodeContent has
|
---|
| 746 | not been set yet.</DL>
|
---|
| 747 | </DD>
|
---|
| 748 | </DL>
|
---|
| 749 | <HR>
|
---|
| 750 |
|
---|
| 751 | <A NAME="getDescendents()"><!-- --></A><H3>
|
---|
| 752 | getDescendents</H3>
|
---|
| 753 | <PRE>
|
---|
| 754 | public <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>[] <B>getDescendents</B>()</PRE>
|
---|
| 755 | <DL>
|
---|
| 756 | <DD><DL>
|
---|
| 757 |
|
---|
| 758 | <DT><B>Returns:</B><DD>an array of all this DocNode's children. Each childnode
|
---|
| 759 | in turn, can further contain children, etc. Null is returned if
|
---|
| 760 | there are no childnodes or if setDescendentsOfRootNode() has not
|
---|
| 761 | been called (that is, if the root has not yet been set).</DL>
|
---|
| 762 | </DD>
|
---|
| 763 | </DL>
|
---|
| 764 | <HR>
|
---|
| 765 |
|
---|
| 766 | <A NAME="getChildren()"><!-- --></A><H3>
|
---|
| 767 | getChildren</H3>
|
---|
| 768 | <PRE>
|
---|
| 769 | public <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A>[] <B>getChildren</B>()</PRE>
|
---|
| 770 | <DL>
|
---|
| 771 | <DD><DL>
|
---|
| 772 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#getChildren()">getChildren</A></CODE> in class <CODE><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A></CODE></DL>
|
---|
| 773 | </DD>
|
---|
| 774 | <DD><DL>
|
---|
| 775 |
|
---|
| 776 | <DT><B>Returns:</B><DD>gets the children (NodeData) of this DocumentNodeData
|
---|
| 777 | but does not guarantee that their children are set. That is,
|
---|
| 778 | it's possible that this DocumentNodeData's children may have
|
---|
| 779 | children of their own but that these may not be set yet (and
|
---|
| 780 | are temporarily still null).</DL>
|
---|
| 781 | </DD>
|
---|
| 782 | </DL>
|
---|
| 783 | <HR>
|
---|
| 784 |
|
---|
| 785 | <A NAME="getDescNodeIDsAsList(boolean)"><!-- --></A><H3>
|
---|
| 786 | getDescNodeIDsAsList</H3>
|
---|
| 787 | <PRE>
|
---|
| 788 | public java.lang.String[] <B>getDescNodeIDsAsList</B>(boolean onlyTheUntitled)</PRE>
|
---|
| 789 | <DL>
|
---|
| 790 | <DD>When called on a rootNode, returns an array of all the descendents'
|
---|
| 791 | nodeIDs. If this object is not a rootNode, it returns null.
|
---|
| 792 | Parameter onlyTheUntitled, if true, makes this method return only the
|
---|
| 793 | nodeIDs of those documentNodeData descendents for whom the title has
|
---|
| 794 | not yet been set.
|
---|
| 795 | If false, the nodeIDs of all dDcumentNodeData descendents will be
|
---|
| 796 | returned, regardless of whether their titles are already set.
|
---|
| 797 | <P>
|
---|
| 798 | <DD><DL>
|
---|
| 799 | <DT><B>Parameters:</B><DD><CODE>onlyTheUntitled</CODE> - - if true this method is only to return those
|
---|
| 800 | descendants' IDs whose titles have not yet been set. If false,
|
---|
| 801 | all descendants' nodeIDs are returned.
|
---|
| 802 | <DT><B>Returns:</B><DD>an array of all the descendant DocumentNodeData's NodeIDs</DL>
|
---|
| 803 | </DD>
|
---|
| 804 | </DL>
|
---|
| 805 | <HR>
|
---|
| 806 |
|
---|
| 807 | <A NAME="descNodeIDsAsList(java.util.Vector, org.greenstone.gs3client.data.DocumentNodeData, boolean)"><!-- --></A><H3>
|
---|
| 808 | descNodeIDsAsList</H3>
|
---|
| 809 | <PRE>
|
---|
| 810 | protected static void <B>descNodeIDsAsList</B>(java.util.Vector v,
|
---|
| 811 | <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A> parent,
|
---|
| 812 | boolean onlyTheUntitled)</PRE>
|
---|
| 813 | <DL>
|
---|
| 814 | <DD>Recursive method that adds all the nodeIDs of the descendents
|
---|
| 815 | of DocumentNodeData parent into the Vector v.
|
---|
| 816 | If parameter onlyTheUntitled=true, then only the nodeIDs of the
|
---|
| 817 | untitled DocumentNodeData descendents are added in. Otherwise,
|
---|
| 818 | all descendents' nodeIDs are.
|
---|
| 819 | <P>
|
---|
| 820 | <DD><DL>
|
---|
| 821 | <DT><B>Parameters:</B><DD><CODE>v</CODE> - is the Vector being populated with descendant documentNodeData's
|
---|
| 822 | IDs.<DD><CODE>parent</CODE> - is the parent DocumentNodeData node currently being
|
---|
| 823 | considered in this recursion step.<DD><CODE>onlyTheUntitled</CODE> - should be true if only those descendant
|
---|
| 824 | DocumentNodeData objects that don't yet have a title need to be returned.
|
---|
| 825 | If false, it returns all descendants' nodeIDs in the Vector v.</DL>
|
---|
| 826 | </DD>
|
---|
| 827 | </DL>
|
---|
| 828 | <HR>
|
---|
| 829 |
|
---|
| 830 | <A NAME="canBeImage()"><!-- --></A><H3>
|
---|
| 831 | canBeImage</H3>
|
---|
| 832 | <PRE>
|
---|
| 833 | public boolean <B>canBeImage</B>()</PRE>
|
---|
| 834 | <DL>
|
---|
| 835 | <DD><DL>
|
---|
| 836 |
|
---|
| 837 | <DT><B>Returns:</B><DD>true if this documentNode's root is associated with the
|
---|
| 838 | ImagePlug or PagedImgPlug.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/gsdoc/tutorial/en/scanned_image_collection.htm">The scanned image collection, for names of Plugin metadata values PagedImgPlug and ImagePlug</a></DL>
|
---|
| 839 | </DD>
|
---|
| 840 | </DL>
|
---|
| 841 | <HR>
|
---|
| 842 |
|
---|
| 843 | <A NAME="hasNoText()"><!-- --></A><H3>
|
---|
| 844 | hasNoText</H3>
|
---|
| 845 | <PRE>
|
---|
| 846 | public boolean <B>hasNoText</B>()</PRE>
|
---|
| 847 | <DL>
|
---|
| 848 | <DD><DL>
|
---|
| 849 |
|
---|
| 850 | <DT><B>Returns:</B><DD>value of "notext" metadata field, if any. If true, this
|
---|
| 851 | indicates that the document is purely an image. Otherwise it indicates
|
---|
| 852 | that there is both a text view and an image view associated with this
|
---|
| 853 | document.</DL>
|
---|
| 854 | </DD>
|
---|
| 855 | </DL>
|
---|
| 856 | <HR>
|
---|
| 857 |
|
---|
| 858 | <A NAME="getImgURL()"><!-- --></A><H3>
|
---|
| 859 | getImgURL</H3>
|
---|
| 860 | <PRE>
|
---|
| 861 | public java.lang.String <B>getImgURL</B>()</PRE>
|
---|
| 862 | <DL>
|
---|
| 863 | <DD><DL>
|
---|
| 864 |
|
---|
| 865 | <DT><B>Returns:</B><DD>the image url stored in the "srcicon" metadata field, if any.</DL>
|
---|
| 866 | </DD>
|
---|
| 867 | </DL>
|
---|
| 868 | <HR>
|
---|
| 869 |
|
---|
| 870 | <A NAME="getImgName()"><!-- --></A><H3>
|
---|
| 871 | getImgName</H3>
|
---|
| 872 | <PRE>
|
---|
| 873 | public java.lang.String <B>getImgName</B>()</PRE>
|
---|
| 874 | <DL>
|
---|
| 875 | <DD><DL>
|
---|
| 876 |
|
---|
| 877 | <DT><B>Returns:</B><DD>the Source metadata value which represents the image file
|
---|
| 878 | name. Returns "" if this DocumentNodeData is not a root or does not
|
---|
| 879 | have Source meta.</DL>
|
---|
| 880 | </DD>
|
---|
| 881 | </DL>
|
---|
| 882 | <HR>
|
---|
| 883 |
|
---|
| 884 | <A NAME="getAssociatedFileNames()"><!-- --></A><H3>
|
---|
| 885 | getAssociatedFileNames</H3>
|
---|
| 886 | <PRE>
|
---|
| 887 | public java.util.Vector <B>getAssociatedFileNames</B>()</PRE>
|
---|
| 888 | <DL>
|
---|
| 889 | <DD><DL>
|
---|
| 890 |
|
---|
| 891 | <DT><B>Returns:</B><DD>the vector of values for metadata name "gsdlassocfile": a vector
|
---|
| 892 | of MetaPairs(filename, mimetype).
|
---|
| 893 | An empty vector is returned for all docNodes other than the root. And the
|
---|
| 894 | root too need not always have associated files listed in its metadata.</DL>
|
---|
| 895 | </DD>
|
---|
| 896 | </DL>
|
---|
| 897 | <HR>
|
---|
| 898 |
|
---|
| 899 | <A NAME="getAssocFilePath()"><!-- --></A><H3>
|
---|
| 900 | getAssocFilePath</H3>
|
---|
| 901 | <PRE>
|
---|
| 902 | public java.lang.String <B>getAssocFilePath</B>()</PRE>
|
---|
| 903 | <DL>
|
---|
| 904 | <DD><DL>
|
---|
| 905 |
|
---|
| 906 | <DT><B>Returns:</B><DD>the root document's assocfilepath metadata field, if any.
|
---|
| 907 | This will indicate the directory path where the associated images
|
---|
| 908 | and other files are stored.</DL>
|
---|
| 909 | </DD>
|
---|
| 910 | </DL>
|
---|
| 911 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
| 912 | <HR>
|
---|
| 913 |
|
---|
| 914 |
|
---|
| 915 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
| 916 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
| 917 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
| 918 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
| 919 | <TR>
|
---|
| 920 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
| 921 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
| 922 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
| 923 | <TR ALIGN="center" VALIGN="top">
|
---|
| 924 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
| 925 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
| 926 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
| 927 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
| 928 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
| 929 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
| 930 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
| 931 | </TR>
|
---|
| 932 | </TABLE>
|
---|
| 933 | </TD>
|
---|
| 934 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
| 935 | </EM>
|
---|
| 936 | </TD>
|
---|
| 937 | </TR>
|
---|
| 938 |
|
---|
| 939 | <TR>
|
---|
| 940 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 941 | <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
|
---|
| 942 | <A HREF="../../../../org/greenstone/gs3client/data/MetaData.html" title="class in org.greenstone.gs3client.data"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
| 943 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
| 944 | <A HREF="../../../../index.html?org/greenstone/gs3client/data/DocumentNodeData.html" target="_top"><B>FRAMES</B></A>
|
---|
| 945 | <A HREF="DocumentNodeData.html" target="_top"><B>NO FRAMES</B></A>
|
---|
| 946 | <SCRIPT type="text/javascript">
|
---|
| 947 | <!--
|
---|
| 948 | if(window==top) {
|
---|
| 949 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
| 950 | }
|
---|
| 951 | //-->
|
---|
| 952 | </SCRIPT>
|
---|
| 953 | <NOSCRIPT>
|
---|
| 954 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
| 955 | </NOSCRIPT>
|
---|
| 956 |
|
---|
| 957 |
|
---|
| 958 | </FONT></TD>
|
---|
| 959 | </TR>
|
---|
| 960 | <TR>
|
---|
| 961 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 962 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
| 963 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
| 964 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
| 965 | </TR>
|
---|
| 966 | </TABLE>
|
---|
| 967 | <A NAME="skip-navbar_bottom"></A>
|
---|
| 968 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
| 969 |
|
---|
| 970 | <HR>
|
---|
| 971 |
|
---|
| 972 | </BODY>
|
---|
| 973 | </HTML>
|
---|