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

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

Updated docs significantly
File size: 13.2 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>
7CollectionData.PluginData
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.data.CollectionData.PluginData 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.PluginData";
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.MetaData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.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.PluginData.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="CollectionData.PluginData.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.PluginData</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.data.CollectionData.PluginData</B>
93</PRE>
94<DL>
95<DT><B>Enclosing class:</B><DD><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html" title="class in org.greenstone.gs3client.data">CollectionData</A></DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public static class <B>CollectionData.PluginData</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103PluginData inner class of CollectionData, represents the data stored in
104 a &lt;plugin&gt;&lt;/plugin&gt; element. This class just stores the
105 Plugin's name, as well as option subelements (in variable optionnames).
106<P>
107
108<P>
109<HR>
110
111<P>
112<!-- =========== FIELD SUMMARY =========== -->
113
114<A NAME="field_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
118<B>Field Summary</B></FONT></TH>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
123<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html#name">name</A></B></CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name of the plugin represented by this PluginData object</TD>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
131<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html#optionnames">optionnames</A></B></CODE>
132
133<BR>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A plugin's option subelements.</TD>
135</TR>
136</TABLE>
137&nbsp;
138<!-- ======== CONSTRUCTOR SUMMARY ======== -->
139
140<A NAME="constructor_summary"><!-- --></A>
141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
143<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
144<B>Constructor Summary</B></FONT></TH>
145</TR>
146<TR BGCOLOR="white" CLASS="TableRowColor">
147<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html#CollectionData.PluginData(org.w3c.dom.Element)">CollectionData.PluginData</A></B>(org.w3c.dom.Element&nbsp;pluginTag)</CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a &lt;plugin&gt;&lt;/plugin&gt; element and sets its members
151 using info extracted from it.</TD>
152</TR>
153</TABLE>
154&nbsp;
155<!-- ========== METHOD SUMMARY =========== -->
156
157<A NAME="method_summary"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
160<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
161<B>Method Summary</B></FONT></TH>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
166<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html#show()">show</A></B>()</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
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.PluginData.html#toString()">toString</A></B>()</CODE>
175
176<BR>
177&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Useful when adding PluginData objects to a JList or JCombobox.</TD>
178</TR>
179</TABLE>
180&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></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 java.lang.Object</B></TH>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
187</TR>
188</TABLE>
189&nbsp;
190<P>
191
192<!-- ============ FIELD DETAIL =========== -->
193
194<A NAME="field_detail"><!-- --></A>
195<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
196<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
197<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
198<B>Field Detail</B></FONT></TH>
199</TR>
200</TABLE>
201
202<A NAME="name"><!-- --></A><H3>
203name</H3>
204<PRE>
205public final java.lang.String <B>name</B></PRE>
206<DL>
207<DD>name of the plugin represented by this PluginData object
208<P>
209<DL>
210</DL>
211</DL>
212<HR>
213
214<A NAME="optionnames"><!-- --></A><H3>
215optionnames</H3>
216<PRE>
217public final java.lang.String[] <B>optionnames</B></PRE>
218<DL>
219<DD>A plugin's option subelements. Variable optionnames can be empty
220 (it's an optional variable).
221<P>
222<DL>
223</DL>
224</DL>
225
226<!-- ========= CONSTRUCTOR DETAIL ======== -->
227
228<A NAME="constructor_detail"><!-- --></A>
229<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
230<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
231<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
232<B>Constructor Detail</B></FONT></TH>
233</TR>
234</TABLE>
235
236<A NAME="CollectionData.PluginData(org.w3c.dom.Element)"><!-- --></A><H3>
237CollectionData.PluginData</H3>
238<PRE>
239public <B>CollectionData.PluginData</B>(org.w3c.dom.Element&nbsp;pluginTag)</PRE>
240<DL>
241<DD>Gets a &lt;plugin&gt;&lt;/plugin&gt; element and sets its members
242 using info extracted from it.
243<P>
244<DL>
245<DT><B>Parameters:</B><DD><CODE>pluginTag</CODE> - is the the &lt;plugin&gt;&lt;/plugin&gt; element
246 whose data is used to construct this PluginData object.</DL>
247</DL>
248
249<!-- ============ METHOD DETAIL ========== -->
250
251<A NAME="method_detail"><!-- --></A>
252<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
253<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
254<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
255<B>Method Detail</B></FONT></TH>
256</TR>
257</TABLE>
258
259<A NAME="toString()"><!-- --></A><H3>
260toString</H3>
261<PRE>
262public java.lang.String <B>toString</B>()</PRE>
263<DL>
264<DD>Useful when adding PluginData objects to a JList or JCombobox.
265<P>
266<DD><DL>
267<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
268</DD>
269<DD><DL>
270
271<DT><B>Returns:</B><DD>the name of the plugin represented by this PluginData object.</DL>
272</DD>
273</DL>
274<HR>
275
276<A NAME="show()"><!-- --></A><H3>
277show</H3>
278<PRE>
279public java.lang.String <B>show</B>()</PRE>
280<DL>
281<DD><DL>
282
283<DT><B>Returns:</B><DD>a String displaying the contents of this PluginData object.
284 Useful for debugging purposes.</DL>
285</DD>
286</DL>
287<!-- ========= END OF CLASS DATA ========= -->
288<HR>
289
290
291<!-- ======= START OF BOTTOM NAVBAR ====== -->
292<A NAME="navbar_bottom"><!-- --></A>
293<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
294<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
295<TR>
296<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
297<A NAME="navbar_bottom_firstrow"><!-- --></A>
298<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
299 <TR ALIGN="center" VALIGN="top">
300 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
301 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
302 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
303 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
304 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
305 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
306 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
307 </TR>
308</TABLE>
309</TD>
310<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
311</EM>
312</TD>
313</TR>
314
315<TR>
316<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
317&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>&nbsp;
318&nbsp;<A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data"><B>NEXT CLASS</B></A></FONT></TD>
319<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
320 <A HREF="../../../../index.html?org/greenstone/gs3client/data/CollectionData.PluginData.html" target="_top"><B>FRAMES</B></A> &nbsp;
321&nbsp;<A HREF="CollectionData.PluginData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
322&nbsp;<SCRIPT type="text/javascript">
323 <!--
324 if(window==top) {
325 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
326 }
327 //-->
328</SCRIPT>
329<NOSCRIPT>
330 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
331</NOSCRIPT>
332
333
334</FONT></TD>
335</TR>
336<TR>
337<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
338 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>
339<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
340DETAIL:&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>
341</TR>
342</TABLE>
343<A NAME="skip-navbar_bottom"></A>
344<!-- ======== END OF BOTTOM NAVBAR ======= -->
345
346<HR>
347
348</BODY>
349</HTML>
Note: See TracBrowser for help on using the repository browser.