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

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

Greenstone3 web services demo-clientadded to GS3's other-projects
File size: 14.0 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 Sun Apr 27 20:47:19 NZST 2008 -->
6<TITLE>
7CollectionData.MetaData
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.data.CollectionData.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="CollectionData.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/CollectionData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.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/CollectionData.MetaData.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="CollectionData.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 CollectionData.MetaData</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html" title="class in org.greenstone.gs3client.data">org.greenstone.gs3client.data.MetaData</A>
93 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.data.CollectionData.MetaData</B>
94</PRE>
95<DL>
96<DT><B>Enclosing class:</B><DD><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html" title="class in org.greenstone.gs3client.data">CollectionData</A></DD>
97</DL>
98<HR>
99<DL>
100<DT><PRE>public static class <B>CollectionData.MetaData</B><DT>extends <A HREF="../../../../org/greenstone/gs3client/data/MetaData.html" title="class in org.greenstone.gs3client.data">MetaData</A></DL>
101</PRE>
102
103<P>
104Static inner class MetaData: can import it into other files as
105 "import gs3client.CollectionData.MetaData;"
106 In this way, can use it as if it were a regular class (a.o.t. an inner
107 class). That is, don't need to prepend the outer-classname if imported
108 like this.
109 gs3client.MetaData, from which this class inherits, has name, value and
110 bodyText fields. This class adds an additional language field that is
111 sometimes present in a Collection's metadata information. So we include
112 the language as a member variable here in case we ever need it.
113<P>
114
115<P>
116<HR>
117
118<P>
119<!-- =========== FIELD SUMMARY =========== -->
120
121<A NAME="field_summary"><!-- --></A>
122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
125<B>Field Summary</B></FONT></TH>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
129<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
130<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html#language">language</A></B></CODE>
131
132<BR>
133&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
134</TR>
135</TABLE>
136&nbsp;<A NAME="fields_inherited_from_class_org.greenstone.gs3client.data.MetaData"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
139<TH ALIGN="left"><B>Fields inherited from class org.greenstone.gs3client.data.<A HREF="../../../../org/greenstone/gs3client/data/MetaData.html" title="class in org.greenstone.gs3client.data">MetaData</A></B></TH>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD><CODE><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#bodyText">bodyText</A>, <A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#name">name</A>, <A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#value">value</A></CODE></TD>
143</TR>
144</TABLE>
145&nbsp;
146<!-- ======== CONSTRUCTOR SUMMARY ======== -->
147
148<A NAME="constructor_summary"><!-- --></A>
149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
150<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
151<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
152<B>Constructor Summary</B></FONT></TH>
153</TR>
154<TR BGCOLOR="white" CLASS="TableRowColor">
155<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html#CollectionData.MetaData(org.w3c.dom.Element)">CollectionData.MetaData</A></B>(org.w3c.dom.Element&nbsp;metadataTag)</CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given a &lt;metadata&gt;&lt;/metadata&gt; element, constructs a
159 CollectionData sets its members using info extracted from it</TD>
160</TR>
161</TABLE>
162&nbsp;
163<!-- ========== METHOD SUMMARY =========== -->
164
165<A NAME="method_summary"><!-- --></A>
166<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
167<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
168<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
169<B>Method Summary</B></FONT></TH>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
173<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
174<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html#show()">show</A></B>()</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
178</TR>
179</TABLE>
180&nbsp;<A NAME="methods_inherited_from_class_org.greenstone.gs3client.data.MetaData"><!-- --></A>
181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
182<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
183<TH ALIGN="left"><B>Methods inherited from class org.greenstone.gs3client.data.<A HREF="../../../../org/greenstone/gs3client/data/MetaData.html" title="class in org.greenstone.gs3client.data">MetaData</A></B></TH>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD><CODE><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#toString()">toString</A></CODE></TD>
187</TR>
188</TABLE>
189&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
190<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
191<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
192<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
193</TR>
194<TR BGCOLOR="white" CLASS="TableRowColor">
195<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
196</TR>
197</TABLE>
198&nbsp;
199<P>
200
201<!-- ============ FIELD DETAIL =========== -->
202
203<A NAME="field_detail"><!-- --></A>
204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
206<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
207<B>Field Detail</B></FONT></TH>
208</TR>
209</TABLE>
210
211<A NAME="language"><!-- --></A><H3>
212language</H3>
213<PRE>
214public final java.lang.String <B>language</B></PRE>
215<DL>
216<DL>
217</DL>
218</DL>
219
220<!-- ========= CONSTRUCTOR DETAIL ======== -->
221
222<A NAME="constructor_detail"><!-- --></A>
223<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
224<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
225<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
226<B>Constructor Detail</B></FONT></TH>
227</TR>
228</TABLE>
229
230<A NAME="CollectionData.MetaData(org.w3c.dom.Element)"><!-- --></A><H3>
231CollectionData.MetaData</H3>
232<PRE>
233public <B>CollectionData.MetaData</B>(org.w3c.dom.Element&nbsp;metadataTag)</PRE>
234<DL>
235<DD>Given a &lt;metadata&gt;&lt;/metadata&gt; element, constructs a
236 CollectionData sets its members using info extracted from it
237<P>
238<DL>
239<DT><B>Parameters:</B><DD><CODE>metadataTag</CODE> - is the the &lt;metadata&gt;&lt;/metadata&gt; element
240 whose data is used to construct this MetaData object.</DL>
241</DL>
242
243<!-- ============ METHOD DETAIL ========== -->
244
245<A NAME="method_detail"><!-- --></A>
246<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
247<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
248<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
249<B>Method Detail</B></FONT></TH>
250</TR>
251</TABLE>
252
253<A NAME="show()"><!-- --></A><H3>
254show</H3>
255<PRE>
256public java.lang.String <B>show</B>()</PRE>
257<DL>
258<DD><DL>
259<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html#show()">show</A></CODE> in class <CODE><A HREF="../../../../org/greenstone/gs3client/data/MetaData.html" title="class in org.greenstone.gs3client.data">MetaData</A></CODE></DL>
260</DD>
261<DD><DL>
262
263<DT><B>Returns:</B><DD>a String displaying the contents of this MetaData object.
264 Useful for debugging purposes.</DL>
265</DD>
266</DL>
267<!-- ========= END OF CLASS DATA ========= -->
268<HR>
269
270
271<!-- ======= START OF BOTTOM NAVBAR ====== -->
272<A NAME="navbar_bottom"><!-- --></A>
273<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
274<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
275<TR>
276<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
277<A NAME="navbar_bottom_firstrow"><!-- --></A>
278<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
279 <TR ALIGN="center" VALIGN="top">
280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
281 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
282 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
287 </TR>
288</TABLE>
289</TD>
290<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
291</EM>
292</TD>
293</TR>
294
295<TR>
296<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
297&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>&nbsp;
298&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html" title="class in org.greenstone.gs3client.data"><B>NEXT CLASS</B></A></FONT></TD>
299<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
300 <A HREF="../../../../index.html?org/greenstone/gs3client/data/CollectionData.MetaData.html" target="_top"><B>FRAMES</B></A> &nbsp;
301&nbsp;<A HREF="CollectionData.MetaData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
302&nbsp;<SCRIPT type="text/javascript">
303 <!--
304 if(window==top) {
305 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
306 }
307 //-->
308</SCRIPT>
309<NOSCRIPT>
310 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
311</NOSCRIPT>
312
313
314</FONT></TD>
315</TR>
316<TR>
317<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
318 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>
319<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
320DETAIL:&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>
321</TR>
322</TABLE>
323<A NAME="skip-navbar_bottom"></A>
324<!-- ======== END OF BOTTOM NAVBAR ======= -->
325
326<HR>
327
328</BODY>
329</HTML>
Note: See TracBrowser for help on using the repository browser.