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

Last change on this file since 15490 was 15490, checked in by ak19, 16 years ago

Updated docs significantly
File size: 13.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.5.0_10) on Thu May 15 13:34:22 NZST 2008 -->
6<TITLE>
7MetaData
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.data.MetaData class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="MetaData";
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>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/NodeData.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/MetaData.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="MetaData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
87org.greenstone.gs3client.data</FONT>
88<BR>
89Class MetaData</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.data.MetaData</B>
93</PRE>
94<DL>
95<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data">CollectionData.MetaData</A></DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public class <B>MetaData</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103Stores the name, value and value of body textnode of a simple &lt;metadata&gt;
104 element. &lt;metadata name="str" value="str"&gt;bodyvalue&lt;/metadata&gt;
105<P>
106
107<P>
108<DL>
109<DT><B>Author:</B></DT>
110 <DD>ak19</DD>
111</DL>
112<HR>
113
114<P>
115<!-- =========== FIELD SUMMARY =========== -->
116
117<A NAME="field_summary"><!-- --></A>
118<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
119<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
120<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
121<B>Field Summary</B></FONT></TH>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#bodyText">bodyText</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Text node content of a &lt;metadata&gt; - the textnode may be empty, in
130 which case this will be set to ""</TD>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
135<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#name">name</A></B></CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Name attribute of a &lt;metadata&gt;</TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
143<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#value">value</A></B></CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value attribute of a &lt;metadata&gt; - this may or may not be there</TD>
147</TR>
148</TABLE>
149&nbsp;
150<!-- ======== CONSTRUCTOR SUMMARY ======== -->
151
152<A NAME="constructor_summary"><!-- --></A>
153<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
156<B>Constructor Summary</B></FONT></TH>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#MetaData(org.w3c.dom.Element)">MetaData</A></B>(org.w3c.dom.Element&nbsp;metadataTag)</CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that creates a MetaData object from a
163 &lt;metadata&gt;&lt;/metadata&gt; element by setting its members fields
164 using info extracted from the element.</TD>
165</TR>
166</TABLE>
167&nbsp;
168<!-- ========== METHOD SUMMARY =========== -->
169
170<A NAME="method_summary"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
173<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
174<B>Method Summary</B></FONT></TH>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#show()">show</A></B>()</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#toString()">toString</A></B>()</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
191</TR>
192</TABLE>
193&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
194<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
195<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
196<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
197</TR>
198<TR BGCOLOR="white" CLASS="TableRowColor">
199<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
200</TR>
201</TABLE>
202&nbsp;
203<P>
204
205<!-- ============ FIELD DETAIL =========== -->
206
207<A NAME="field_detail"><!-- --></A>
208<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
209<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
210<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
211<B>Field Detail</B></FONT></TH>
212</TR>
213</TABLE>
214
215<A NAME="name"><!-- --></A><H3>
216name</H3>
217<PRE>
218public final java.lang.String <B>name</B></PRE>
219<DL>
220<DD>Name attribute of a &lt;metadata&gt;
221<P>
222<DL>
223</DL>
224</DL>
225<HR>
226
227<A NAME="value"><!-- --></A><H3>
228value</H3>
229<PRE>
230public final java.lang.String <B>value</B></PRE>
231<DL>
232<DD>Value attribute of a &lt;metadata&gt; - this may or may not be there
233<P>
234<DL>
235</DL>
236</DL>
237<HR>
238
239<A NAME="bodyText"><!-- --></A><H3>
240bodyText</H3>
241<PRE>
242public final java.lang.String <B>bodyText</B></PRE>
243<DL>
244<DD>Text node content of a &lt;metadata&gt; - the textnode may be empty, in
245 which case this will be set to ""
246<P>
247<DL>
248</DL>
249</DL>
250
251<!-- ========= CONSTRUCTOR DETAIL ======== -->
252
253<A NAME="constructor_detail"><!-- --></A>
254<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
255<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
256<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
257<B>Constructor Detail</B></FONT></TH>
258</TR>
259</TABLE>
260
261<A NAME="MetaData(org.w3c.dom.Element)"><!-- --></A><H3>
262MetaData</H3>
263<PRE>
264public <B>MetaData</B>(org.w3c.dom.Element&nbsp;metadataTag)</PRE>
265<DL>
266<DD>Constructor that creates a MetaData object from a
267 &lt;metadata&gt;&lt;/metadata&gt; element by setting its members fields
268 using info extracted from the element.
269<P>
270<DL>
271<DT><B>Parameters:</B><DD><CODE>metadataTag</CODE> - is the &lt;metadata&gt; element whose data is used
272 to construct this MetaData object</DL>
273</DL>
274
275<!-- ============ METHOD DETAIL ========== -->
276
277<A NAME="method_detail"><!-- --></A>
278<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
279<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
280<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
281<B>Method Detail</B></FONT></TH>
282</TR>
283</TABLE>
284
285<A NAME="toString()"><!-- --></A><H3>
286toString</H3>
287<PRE>
288public java.lang.String <B>toString</B>()</PRE>
289<DL>
290<DD><DL>
291<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
292</DD>
293<DD><DL>
294
295<DT><B>Returns:</B><DD>the name of this Metadata object. Useful when adding MetaData
296 objects to a JList or JCombobox</DL>
297</DD>
298</DL>
299<HR>
300
301<A NAME="show()"><!-- --></A><H3>
302show</H3>
303<PRE>
304public java.lang.String <B>show</B>()</PRE>
305<DL>
306<DD><DL>
307
308<DT><B>Returns:</B><DD>a String displaying the contents of this MetaData object.
309 Useful for debugging purposes.</DL>
310</DD>
311</DL>
312<!-- ========= END OF CLASS DATA ========= -->
313<HR>
314
315
316<!-- ======= START OF BOTTOM NAVBAR ====== -->
317<A NAME="navbar_bottom"><!-- --></A>
318<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
319<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
320<TR>
321<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
322<A NAME="navbar_bottom_firstrow"><!-- --></A>
323<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
324 <TR ALIGN="center" VALIGN="top">
325 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
326 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
327 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
328 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
329 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
330 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
331 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
332 </TR>
333</TABLE>
334</TD>
335<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
336</EM>
337</TD>
338</TR>
339
340<TR>
341<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
342&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>&nbsp;
343&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/NodeData.html" title="class in org.greenstone.gs3client.data"><B>NEXT CLASS</B></A></FONT></TD>
344<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
345 <A HREF="../../../../index.html?org/greenstone/gs3client/data/MetaData.html" target="_top"><B>FRAMES</B></A> &nbsp;
346&nbsp;<A HREF="MetaData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
347&nbsp;<SCRIPT type="text/javascript">
348 <!--
349 if(window==top) {
350 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
351 }
352 //-->
353</SCRIPT>
354<NOSCRIPT>
355 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
356</NOSCRIPT>
357
358
359</FONT></TD>
360</TR>
361<TR>
362<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
363 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
364<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
365DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
366</TR>
367</TABLE>
368<A NAME="skip-navbar_bottom"></A>
369<!-- ======== END OF BOTTOM NAVBAR ======= -->
370
371<HR>
372
373</BODY>
374</HTML>
Note: See TracBrowser for help on using the repository browser.