| 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 | NodeData
|
|---|
| 8 | </TITLE>
|
|---|
| 9 |
|
|---|
| 10 | <META NAME="keywords" CONTENT="org.greenstone.gs3client.data.NodeData 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="NodeData";
|
|---|
| 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/MetaData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
|
|---|
| 55 | <A HREF="../../../../org/greenstone/gs3client/data/Pair.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/NodeData.html" target="_top"><B>FRAMES</B></A>
|
|---|
| 58 | <A HREF="NodeData.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 NodeData</H2>
|
|---|
| 90 | <PRE>
|
|---|
| 91 | java.lang.Object
|
|---|
| 92 | <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.data.NodeData</B>
|
|---|
| 93 | </PRE>
|
|---|
| 94 | <DL>
|
|---|
| 95 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/greenstone/gs3client/data/ClassifierNodeData.html" title="class in org.greenstone.gs3client.data">ClassifierNodeData</A>, <A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A></DD>
|
|---|
| 96 | </DL>
|
|---|
| 97 | <HR>
|
|---|
| 98 | <DL>
|
|---|
| 99 | <DT><PRE>public abstract class <B>NodeData</B><DT>extends java.lang.Object</DL>
|
|---|
| 100 | </PRE>
|
|---|
| 101 |
|
|---|
| 102 | <P>
|
|---|
| 103 | Abstract superclass NodeData can represent either a the information in
|
|---|
| 104 | a <classifierNode> (stored in a ClassifierNodeData object) or in a
|
|---|
| 105 | <documentNode> (stored in a DocumentNodeData object).
|
|---|
| 106 | <P>
|
|---|
| 107 |
|
|---|
| 108 | <P>
|
|---|
| 109 | <DL>
|
|---|
| 110 | <DT><B>Author:</B></DT>
|
|---|
| 111 | <DD>ak19</DD>
|
|---|
| 112 | </DL>
|
|---|
| 113 | <HR>
|
|---|
| 114 |
|
|---|
| 115 | <P>
|
|---|
| 116 | <!-- =========== FIELD SUMMARY =========== -->
|
|---|
| 117 |
|
|---|
| 118 | <A NAME="field_summary"><!-- --></A>
|
|---|
| 119 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 120 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 121 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 122 | <B>Field Summary</B></FONT></TH>
|
|---|
| 123 | </TR>
|
|---|
| 124 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 125 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 126 | <CODE> boolean</CODE></FONT></TD>
|
|---|
| 127 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#hasChildren">hasChildren</A></B></CODE>
|
|---|
| 128 |
|
|---|
| 129 | <BR>
|
|---|
| 130 | Since we are setting the descendents lazily (only setting the children
|
|---|
| 131 | each time), we have a little flag to indicate whether this node has
|
|---|
| 132 | any children.</TD>
|
|---|
| 133 | </TR>
|
|---|
| 134 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 135 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 136 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 137 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#nodeID">nodeID</A></B></CODE>
|
|---|
| 138 |
|
|---|
| 139 | <BR>
|
|---|
| 140 | The unique nodeID identifying this documentNode or classificationNode</TD>
|
|---|
| 141 | </TR>
|
|---|
| 142 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 143 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 144 | <CODE>protected java.util.Map</CODE></FONT></TD>
|
|---|
| 145 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#nodeMetadata">nodeMetadata</A></B></CODE>
|
|---|
| 146 |
|
|---|
| 147 | <BR>
|
|---|
| 148 | Map of the metadata (name, value) pairs of this document-
|
|---|
| 149 | or classifier-node</TD>
|
|---|
| 150 | </TR>
|
|---|
| 151 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 152 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 153 | <CODE>protected org.w3c.dom.Element</CODE></FONT></TD>
|
|---|
| 154 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#nodeTag">nodeTag</A></B></CODE>
|
|---|
| 155 |
|
|---|
| 156 | <BR>
|
|---|
| 157 | stores this NodeData's tag element: can be either
|
|---|
| 158 | <documentNode> or <classifierNode></TD>
|
|---|
| 159 | </TR>
|
|---|
| 160 | </TABLE>
|
|---|
| 161 |
|
|---|
| 162 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|---|
| 163 |
|
|---|
| 164 | <A NAME="constructor_summary"><!-- --></A>
|
|---|
| 165 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 166 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 167 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 168 | <B>Constructor Summary</B></FONT></TH>
|
|---|
| 169 | </TR>
|
|---|
| 170 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 171 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#NodeData(org.w3c.dom.Element)">NodeData</A></B>(org.w3c.dom.Element nodeTag)</CODE>
|
|---|
| 172 |
|
|---|
| 173 | <BR>
|
|---|
| 174 | Constructor that extracts the nodeID value from the given nodeTag:
|
|---|
| 175 | <classifierNode nodeID = "x" />
|
|---|
| 176 | or <documentNode nodeID = "x" /></TD>
|
|---|
| 177 | </TR>
|
|---|
| 178 | </TABLE>
|
|---|
| 179 |
|
|---|
| 180 | <!-- ========== METHOD SUMMARY =========== -->
|
|---|
| 181 |
|
|---|
| 182 | <A NAME="method_summary"><!-- --></A>
|
|---|
| 183 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 184 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 185 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|---|
| 186 | <B>Method Summary</B></FONT></TH>
|
|---|
| 187 | </TR>
|
|---|
| 188 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 189 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 190 | <CODE>abstract <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A>[]</CODE></FONT></TD>
|
|---|
| 191 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#getChildren()">getChildren</A></B>()</CODE>
|
|---|
| 192 |
|
|---|
| 193 | <BR>
|
|---|
| 194 | </TD>
|
|---|
| 195 | </TR>
|
|---|
| 196 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 197 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 198 | <CODE> java.util.Map</CODE></FONT></TD>
|
|---|
| 199 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#getMetadataList()">getMetadataList</A></B>()</CODE>
|
|---|
| 200 |
|
|---|
| 201 | <BR>
|
|---|
| 202 | </TD>
|
|---|
| 203 | </TR>
|
|---|
| 204 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 205 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 206 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 207 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#getTitle()">getTitle</A></B>()</CODE>
|
|---|
| 208 |
|
|---|
| 209 | <BR>
|
|---|
| 210 | </TD>
|
|---|
| 211 | </TR>
|
|---|
| 212 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 213 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 214 | <CODE>protected void</CODE></FONT></TD>
|
|---|
| 215 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#setChildren(java.util.Vector, java.util.Map)">setChildren</A></B>(java.util.Vector v,
|
|---|
| 216 | java.util.Map idsToNodes_map)</CODE>
|
|---|
| 217 |
|
|---|
| 218 | <BR>
|
|---|
| 219 | Called when setting descendents lazily: only the children of this
|
|---|
| 220 | node are set.</TD>
|
|---|
| 221 | </TR>
|
|---|
| 222 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 223 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 224 | <CODE> void</CODE></FONT></TD>
|
|---|
| 225 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#setMetadataList(org.w3c.dom.Element)">setMetadataList</A></B>(org.w3c.dom.Element nodeTag)</CODE>
|
|---|
| 226 |
|
|---|
| 227 | <BR>
|
|---|
| 228 | Sets member metadataList if there is a <metadataList> subelement in
|
|---|
| 229 | docNodeTag: first get the <metadataList> then its <metadata>
|
|---|
| 230 | children</TD>
|
|---|
| 231 | </TR>
|
|---|
| 232 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 233 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 234 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 235 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#show()">show</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> java.lang.String</CODE></FONT></TD>
|
|---|
| 243 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#showMeta()">showMeta</A></B>()</CODE>
|
|---|
| 244 |
|
|---|
| 245 | <BR>
|
|---|
| 246 | </TD>
|
|---|
| 247 | </TR>
|
|---|
| 248 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 249 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|---|
| 250 | <CODE> java.lang.String</CODE></FONT></TD>
|
|---|
| 251 | <TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/NodeData.html#toString()">toString</A></B>()</CODE>
|
|---|
| 252 |
|
|---|
| 253 | <BR>
|
|---|
| 254 | </TD>
|
|---|
| 255 | </TR>
|
|---|
| 256 | </TABLE>
|
|---|
| 257 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|---|
| 258 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 259 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|---|
| 260 | <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|---|
| 261 | </TR>
|
|---|
| 262 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
|---|
| 263 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
|
|---|
| 264 | </TR>
|
|---|
| 265 | </TABLE>
|
|---|
| 266 |
|
|---|
| 267 | <P>
|
|---|
| 268 |
|
|---|
| 269 | <!-- ============ FIELD DETAIL =========== -->
|
|---|
| 270 |
|
|---|
| 271 | <A NAME="field_detail"><!-- --></A>
|
|---|
| 272 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 273 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 274 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 275 | <B>Field Detail</B></FONT></TH>
|
|---|
| 276 | </TR>
|
|---|
| 277 | </TABLE>
|
|---|
| 278 |
|
|---|
| 279 | <A NAME="nodeID"><!-- --></A><H3>
|
|---|
| 280 | nodeID</H3>
|
|---|
| 281 | <PRE>
|
|---|
| 282 | public final java.lang.String <B>nodeID</B></PRE>
|
|---|
| 283 | <DL>
|
|---|
| 284 | <DD>The unique nodeID identifying this documentNode or classificationNode
|
|---|
| 285 | <P>
|
|---|
| 286 | <DL>
|
|---|
| 287 | </DL>
|
|---|
| 288 | </DL>
|
|---|
| 289 | <HR>
|
|---|
| 290 |
|
|---|
| 291 | <A NAME="hasChildren"><!-- --></A><H3>
|
|---|
| 292 | hasChildren</H3>
|
|---|
| 293 | <PRE>
|
|---|
| 294 | public final boolean <B>hasChildren</B></PRE>
|
|---|
| 295 | <DL>
|
|---|
| 296 | <DD>Since we are setting the descendents lazily (only setting the children
|
|---|
| 297 | each time), we have a little flag to indicate whether this node has
|
|---|
| 298 | any children.
|
|---|
| 299 | <P>
|
|---|
| 300 | <DL>
|
|---|
| 301 | </DL>
|
|---|
| 302 | </DL>
|
|---|
| 303 | <HR>
|
|---|
| 304 |
|
|---|
| 305 | <A NAME="nodeTag"><!-- --></A><H3>
|
|---|
| 306 | nodeTag</H3>
|
|---|
| 307 | <PRE>
|
|---|
| 308 | protected final org.w3c.dom.Element <B>nodeTag</B></PRE>
|
|---|
| 309 | <DL>
|
|---|
| 310 | <DD>stores this NodeData's tag element: can be either
|
|---|
| 311 | <documentNode> or <classifierNode>
|
|---|
| 312 | <P>
|
|---|
| 313 | <DL>
|
|---|
| 314 | </DL>
|
|---|
| 315 | </DL>
|
|---|
| 316 | <HR>
|
|---|
| 317 |
|
|---|
| 318 | <A NAME="nodeMetadata"><!-- --></A><H3>
|
|---|
| 319 | nodeMetadata</H3>
|
|---|
| 320 | <PRE>
|
|---|
| 321 | protected java.util.Map <B>nodeMetadata</B></PRE>
|
|---|
| 322 | <DL>
|
|---|
| 323 | <DD>Map of the metadata (name, value) pairs of this document-
|
|---|
| 324 | or classifier-node
|
|---|
| 325 | <P>
|
|---|
| 326 | <DL>
|
|---|
| 327 | </DL>
|
|---|
| 328 | </DL>
|
|---|
| 329 |
|
|---|
| 330 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|---|
| 331 |
|
|---|
| 332 | <A NAME="constructor_detail"><!-- --></A>
|
|---|
| 333 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 334 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 335 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 336 | <B>Constructor Detail</B></FONT></TH>
|
|---|
| 337 | </TR>
|
|---|
| 338 | </TABLE>
|
|---|
| 339 |
|
|---|
| 340 | <A NAME="NodeData(org.w3c.dom.Element)"><!-- --></A><H3>
|
|---|
| 341 | NodeData</H3>
|
|---|
| 342 | <PRE>
|
|---|
| 343 | public <B>NodeData</B>(org.w3c.dom.Element nodeTag)</PRE>
|
|---|
| 344 | <DL>
|
|---|
| 345 | <DD>Constructor that extracts the nodeID value from the given nodeTag:
|
|---|
| 346 | <classifierNode nodeID = "x" />
|
|---|
| 347 | or <documentNode nodeID = "x" />
|
|---|
| 348 | <P>
|
|---|
| 349 | </DL>
|
|---|
| 350 |
|
|---|
| 351 | <!-- ============ METHOD DETAIL ========== -->
|
|---|
| 352 |
|
|---|
| 353 | <A NAME="method_detail"><!-- --></A>
|
|---|
| 354 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|---|
| 355 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|---|
| 356 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|---|
| 357 | <B>Method Detail</B></FONT></TH>
|
|---|
| 358 | </TR>
|
|---|
| 359 | </TABLE>
|
|---|
| 360 |
|
|---|
| 361 | <A NAME="getChildren()"><!-- --></A><H3>
|
|---|
| 362 | getChildren</H3>
|
|---|
| 363 | <PRE>
|
|---|
| 364 | public abstract <A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data">NodeData</A>[] <B>getChildren</B>()</PRE>
|
|---|
| 365 | <DL>
|
|---|
| 366 | <DD><DL>
|
|---|
| 367 |
|
|---|
| 368 | <DT><B>Returns:</B><DD>an array of the children of this NodeData, however such a
|
|---|
| 369 | structure may be stored internally by a NodeData subclass.</DL>
|
|---|
| 370 | </DD>
|
|---|
| 371 | </DL>
|
|---|
| 372 | <HR>
|
|---|
| 373 |
|
|---|
| 374 | <A NAME="setMetadataList(org.w3c.dom.Element)"><!-- --></A><H3>
|
|---|
| 375 | setMetadataList</H3>
|
|---|
| 376 | <PRE>
|
|---|
| 377 | public void <B>setMetadataList</B>(org.w3c.dom.Element nodeTag)</PRE>
|
|---|
| 378 | <DL>
|
|---|
| 379 | <DD>Sets member metadataList if there is a <metadataList> subelement in
|
|---|
| 380 | docNodeTag: first get the <metadataList> then its <metadata>
|
|---|
| 381 | children
|
|---|
| 382 | <P>
|
|---|
| 383 | <DD><DL>
|
|---|
| 384 | <DT><B>Parameters:</B><DD><CODE>nodeTag</CODE> - is a documentNode or classifierNode XML Element that
|
|---|
| 385 | contains metadata information which is used to set this NodeData object's
|
|---|
| 386 | metadata (if there are any, the HashMap nodeMetadata will be set).</DL>
|
|---|
| 387 | </DD>
|
|---|
| 388 | </DL>
|
|---|
| 389 | <HR>
|
|---|
| 390 |
|
|---|
| 391 | <A NAME="setChildren(java.util.Vector, java.util.Map)"><!-- --></A><H3>
|
|---|
| 392 | setChildren</H3>
|
|---|
| 393 | <PRE>
|
|---|
| 394 | protected void <B>setChildren</B>(java.util.Vector v,
|
|---|
| 395 | java.util.Map idsToNodes_map)</PRE>
|
|---|
| 396 | <DL>
|
|---|
| 397 | <DD>Called when setting descendents lazily: only the children of this
|
|---|
| 398 | node are set. We don't care to setDescendents now, will set it later
|
|---|
| 399 | when necessary.
|
|---|
| 400 | <P>
|
|---|
| 401 | <DD><DL>
|
|---|
| 402 | <DT><B>Parameters:</B><DD><CODE>v</CODE> - is an empty/non-null Vector which will, at method's end, contain
|
|---|
| 403 | all the Document- or ClassifierNodeData objects that are children of
|
|---|
| 404 | this NodeData object.</DL>
|
|---|
| 405 | </DD>
|
|---|
| 406 | </DL>
|
|---|
| 407 | <HR>
|
|---|
| 408 |
|
|---|
| 409 | <A NAME="getMetadataList()"><!-- --></A><H3>
|
|---|
| 410 | getMetadataList</H3>
|
|---|
| 411 | <PRE>
|
|---|
| 412 | public java.util.Map <B>getMetadataList</B>()</PRE>
|
|---|
| 413 | <DL>
|
|---|
| 414 | <DD><DL>
|
|---|
| 415 |
|
|---|
| 416 | <DT><B>Returns:</B><DD>a hashmap of this document's metadata (name, val) pairs.
|
|---|
| 417 | A null is returned if the nodeMetadata has not been set yet.</DL>
|
|---|
| 418 | </DD>
|
|---|
| 419 | </DL>
|
|---|
| 420 | <HR>
|
|---|
| 421 |
|
|---|
| 422 | <A NAME="getTitle()"><!-- --></A><H3>
|
|---|
| 423 | getTitle</H3>
|
|---|
| 424 | <PRE>
|
|---|
| 425 | public java.lang.String <B>getTitle</B>()</PRE>
|
|---|
| 426 | <DL>
|
|---|
| 427 | <DD><DL>
|
|---|
| 428 |
|
|---|
| 429 | <DT><B>Returns:</B><DD>the title of this docNodeData object, if any is set. If it's
|
|---|
| 430 | not been set yet (title metadata not yet set, a null is returned.</DL>
|
|---|
| 431 | </DD>
|
|---|
| 432 | </DL>
|
|---|
| 433 | <HR>
|
|---|
| 434 |
|
|---|
| 435 | <A NAME="toString()"><!-- --></A><H3>
|
|---|
| 436 | toString</H3>
|
|---|
| 437 | <PRE>
|
|---|
| 438 | public java.lang.String <B>toString</B>()</PRE>
|
|---|
| 439 | <DL>
|
|---|
| 440 | <DD><DL>
|
|---|
| 441 | <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|---|
| 442 | </DD>
|
|---|
| 443 | <DD><DL>
|
|---|
| 444 |
|
|---|
| 445 | <DT><B>Returns:</B><DD>the title of this docNodeData object, if any.
|
|---|
| 446 | Otherwise the nodeID is returned.
|
|---|
| 447 | This method is useful for displaying this docNodeData object as a
|
|---|
| 448 | node in a JTree. Some meaningful displayable value is returned,
|
|---|
| 449 | unlike getTitle() which returns a null if title is not set yet.</DL>
|
|---|
| 450 | </DD>
|
|---|
| 451 | </DL>
|
|---|
| 452 | <HR>
|
|---|
| 453 |
|
|---|
| 454 | <A NAME="show()"><!-- --></A><H3>
|
|---|
| 455 | show</H3>
|
|---|
| 456 | <PRE>
|
|---|
| 457 | public java.lang.String <B>show</B>()</PRE>
|
|---|
| 458 | <DL>
|
|---|
| 459 | <DD><DL>
|
|---|
| 460 |
|
|---|
| 461 | <DT><B>Returns:</B><DD>the details contained in this NodeData object.
|
|---|
| 462 | Useful for debugging purposes.</DL>
|
|---|
| 463 | </DD>
|
|---|
| 464 | </DL>
|
|---|
| 465 | <HR>
|
|---|
| 466 |
|
|---|
| 467 | <A NAME="showMeta()"><!-- --></A><H3>
|
|---|
| 468 | showMeta</H3>
|
|---|
| 469 | <PRE>
|
|---|
| 470 | public java.lang.String <B>showMeta</B>()</PRE>
|
|---|
| 471 | <DL>
|
|---|
| 472 | <DD><DL>
|
|---|
| 473 |
|
|---|
| 474 | <DT><B>Returns:</B><DD>a String representation of the contains of the
|
|---|
| 475 | nodeMetadata list (useful for debugging purposes).</DL>
|
|---|
| 476 | </DD>
|
|---|
| 477 | </DL>
|
|---|
| 478 | <!-- ========= END OF CLASS DATA ========= -->
|
|---|
| 479 | <HR>
|
|---|
| 480 |
|
|---|
| 481 |
|
|---|
| 482 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|---|
| 483 | <A NAME="navbar_bottom"><!-- --></A>
|
|---|
| 484 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|---|
| 485 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|---|
| 486 | <TR>
|
|---|
| 487 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|---|
| 488 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|---|
| 489 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|---|
| 490 | <TR ALIGN="center" VALIGN="top">
|
|---|
| 491 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|---|
| 492 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|---|
| 493 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|---|
| 494 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|---|
| 495 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|---|
| 496 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|---|
| 497 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|---|
| 498 | </TR>
|
|---|
| 499 | </TABLE>
|
|---|
| 500 | </TD>
|
|---|
| 501 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|---|
| 502 | </EM>
|
|---|
| 503 | </TD>
|
|---|
| 504 | </TR>
|
|---|
| 505 |
|
|---|
| 506 | <TR>
|
|---|
| 507 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 508 | <A HREF="../../../../org/greenstone/gs3client/data/MetaData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
|
|---|
| 509 | <A HREF="../../../../org/greenstone/gs3client/data/Pair.html" title="class in org.greenstone.gs3client.data"><B>NEXT CLASS</B></A></FONT></TD>
|
|---|
| 510 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|---|
| 511 | <A HREF="../../../../index.html?org/greenstone/gs3client/data/NodeData.html" target="_top"><B>FRAMES</B></A>
|
|---|
| 512 | <A HREF="NodeData.html" target="_top"><B>NO FRAMES</B></A>
|
|---|
| 513 | <SCRIPT type="text/javascript">
|
|---|
| 514 | <!--
|
|---|
| 515 | if(window==top) {
|
|---|
| 516 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|---|
| 517 | }
|
|---|
| 518 | //-->
|
|---|
| 519 | </SCRIPT>
|
|---|
| 520 | <NOSCRIPT>
|
|---|
| 521 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|---|
| 522 | </NOSCRIPT>
|
|---|
| 523 |
|
|---|
| 524 |
|
|---|
| 525 | </FONT></TD>
|
|---|
| 526 | </TR>
|
|---|
| 527 | <TR>
|
|---|
| 528 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 529 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|---|
| 530 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|---|
| 531 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|---|
| 532 | </TR>
|
|---|
| 533 | </TABLE>
|
|---|
| 534 | <A NAME="skip-navbar_bottom"></A>
|
|---|
| 535 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|---|
| 536 |
|
|---|
| 537 | <HR>
|
|---|
| 538 |
|
|---|
| 539 | </BODY>
|
|---|
| 540 | </HTML>
|
|---|
