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