Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

source: other-projects/trunk/gs3-webservices-democlient/docs/GS3DemoClient/org/greenstone/gs3client/data/CollectionData.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: 28.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>
7	CollectionData
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.greenstone.gs3client.data.CollectionData 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="CollectionData";
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/ClassifierNodeData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
55	<A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.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.html" target="_top"><B>FRAMES</B></A>
58	<A HREF="CollectionData.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: <A HREF="#nested_class_summary">NESTED</A> \| <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 CollectionData</H2>
90	<PRE>
91	java.lang.Object
92	<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.data.CollectionData</B>
93	</PRE>
94	<HR>
95	<DL>
96	<DT><PRE>public class <B>CollectionData</B><DT>extends java.lang.Object</DL>
97	</PRE>
98
99	<P>
100	CollectionData represents a Greenstone 3 collection and contains the data
101	stored in a <collection></collection> element returned from a
102	MessageRouter's desribe response XML and a Collection describe response XML.
103	A CollectionData object can therefore contain services (represented by
104	ServiceData), a list of collection-level metadata (represented by MetaData)
105	and a list of plugins (represented by PluginData).
106
107	ServiceData and PluginData are static inner classes of CollectionData.
108	To declare variables of these inner class types in other java files/classes,
109	import each one: e.g. "import gs3client.CollectionData.ServiceData".
110	Then they can be used without the outerclass' name for qualification:
111	i.e. can then use Servicedata sv = new ServiceData(...)
112	instead of CollectionData.ServiceData sv = new
113	CollectionData.ServiceData(...).
114	<P>
115
116	<P>
117	<DL>
118	<DT><B>Author:</B></DT>
119	<DD>ak19</DD>
120	</DL>
121	<HR>
122
123	<P>
124	<!-- ======== NESTED CLASS SUMMARY ======== -->
125
126	<A NAME="nested_class_summary"><!-- --></A>
127	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
130	<B>Nested Class Summary</B></FONT></TH>
131	</TR>
132	<TR BGCOLOR="white" CLASS="TableRowColor">
133	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134	<CODE>static class</CODE></FONT></TD>
135	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data">CollectionData.MetaData</A></B></CODE>
136
137	<BR>
138	Static inner class MetaData: can import it into other files as
139	"import gs3client.CollectionData.MetaData;"
140	In this way, can use it as if it were a regular class (a.o.t.</TD>
141	</TR>
142	<TR BGCOLOR="white" CLASS="TableRowColor">
143	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144	<CODE>static class</CODE></FONT></TD>
145	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html" title="class in org.greenstone.gs3client.data">CollectionData.PluginData</A></B></CODE>
146
147	<BR>
148	PluginData inner class of CollectionData, represents the data stored in
149	a <plugin></plugin> element.</TD>
150	</TR>
151	<TR BGCOLOR="white" CLASS="TableRowColor">
152	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153	<CODE>static class</CODE></FONT></TD>
154	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data">CollectionData.ServiceData</A></B></CODE>
155
156	<BR>
157	Only the name and type of a <service></service> element is
158	stored, since this is all the service data available inside a collection's
159	response message to a describe request.</TD>
160	</TR>
161	</TABLE>
162	<!-- =========== FIELD SUMMARY =========== -->
163
164	<A NAME="field_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>Field Summary</B></FONT></TH>
169	</TR>
170	<TR BGCOLOR="white" CLASS="TableRowColor">
171	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172	<CODE>protected  java.lang.String</CODE></FONT></TD>
173	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#description">description</A></B></CODE>
174
175	<BR>
176	Description of the Greenstone collection represented by this
177	CollectionData</TD>
178	</TR>
179	<TR BGCOLOR="white" CLASS="TableRowColor">
180	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181	<CODE>protected  java.lang.String</CODE></FONT></TD>
182	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#displayName">displayName</A></B></CODE>
183
184	<BR>
185	Display name for the Greenstone collection represented by this
186	CollectionData</TD>
187	</TR>
188	<TR BGCOLOR="white" CLASS="TableRowColor">
189	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190	<CODE>protected  java.lang.String</CODE></FONT></TD>
191	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#icon">icon</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>protected  <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data">CollectionData.MetaData</A>[]</CODE></FONT></TD>
199	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#metadataList">metadataList</A></B></CODE>
200
201	<BR>
202	Collection level metadata</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/CollectionData.html#name">name</A></B></CODE>
208
209	<BR>
210	The basic field of a collection: the name of the collection.</TD>
211	</TR>
212	<TR BGCOLOR="white" CLASS="TableRowColor">
213	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
214	<CODE>protected  <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html" title="class in org.greenstone.gs3client.data">CollectionData.PluginData</A>[]</CODE></FONT></TD>
215	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#pluginList">pluginList</A></B></CODE>
216
217	<BR>
218	Greenstone plugins used to build this collection with</TD>
219	</TR>
220	<TR BGCOLOR="white" CLASS="TableRowColor">
221	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
222	<CODE>protected  <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data">CollectionData.ServiceData</A>[]</CODE></FONT></TD>
223	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#serviceList">serviceList</A></B></CODE>
224
225	<BR>
226	List of services supported by this collection</TD>
227	</TR>
228	<TR BGCOLOR="white" CLASS="TableRowColor">
229	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
230	<CODE>protected  java.lang.String</CODE></FONT></TD>
231	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#smallIcon">smallIcon</A></B></CODE>
232
233	<BR>
234	</TD>
235	</TR>
236	<TR BGCOLOR="white" CLASS="TableRowColor">
237	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238	<CODE>protected  java.lang.String</CODE></FONT></TD>
239	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#url">url</A></B></CODE>
240
241	<BR>
242	Stores the location of images and stuff.</TD>
243	</TR>
244	</TABLE>
245
246	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
247
248	<A NAME="constructor_summary"><!-- --></A>
249	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
250	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
251	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
252	<B>Constructor Summary</B></FONT></TH>
253	</TR>
254	<TR BGCOLOR="white" CLASS="TableRowColor">
255	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#CollectionData(org.w3c.dom.Element)">CollectionData</A></B>(org.w3c.dom.Element mrCollectionTag)</CODE>
256
257	<BR>
258	Gets a <collection></collection> element as returned by the
259	<b>MessageRouter's</b> describe response, with only the name field set.</TD>
260	</TR>
261	</TABLE>
262
263	<!-- ========== METHOD SUMMARY =========== -->
264
265	<A NAME="method_summary"><!-- --></A>
266	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
267	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
268	<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
269	<B>Method Summary</B></FONT></TH>
270	</TR>
271	<TR BGCOLOR="white" CLASS="TableRowColor">
272	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273	<CODE> java.lang.String</CODE></FONT></TD>
274	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getDescription()">getDescription</A></B>()</CODE>
275
276	<BR>
277	</TD>
278	</TR>
279	<TR BGCOLOR="white" CLASS="TableRowColor">
280	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
281	<CODE> java.lang.String</CODE></FONT></TD>
282	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getDisplayName()">getDisplayName</A></B>()</CODE>
283
284	<BR>
285	</TD>
286	</TR>
287	<TR BGCOLOR="white" CLASS="TableRowColor">
288	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
289	<CODE> java.lang.String</CODE></FONT></TD>
290	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getIcon()">getIcon</A></B>()</CODE>
291
292	<BR>
293	</TD>
294	</TR>
295	<TR BGCOLOR="white" CLASS="TableRowColor">
296	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
297	<CODE> <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data">CollectionData.MetaData</A>[]</CODE></FONT></TD>
298	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getMetadataList()">getMetadataList</A></B>()</CODE>
299
300	<BR>
301	</TD>
302	</TR>
303	<TR BGCOLOR="white" CLASS="TableRowColor">
304	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305	<CODE> java.lang.String</CODE></FONT></TD>
306	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getName()">getName</A></B>()</CODE>
307
308	<BR>
309	</TD>
310	</TR>
311	<TR BGCOLOR="white" CLASS="TableRowColor">
312	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
313	<CODE> <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html" title="class in org.greenstone.gs3client.data">CollectionData.PluginData</A>[]</CODE></FONT></TD>
314	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getPluginList()">getPluginList</A></B>()</CODE>
315
316	<BR>
317	</TD>
318	</TR>
319	<TR BGCOLOR="white" CLASS="TableRowColor">
320	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
321	<CODE> <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data">CollectionData.ServiceData</A>[]</CODE></FONT></TD>
322	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getServiceList(boolean)">getServiceList</A></B>(boolean executableServicesOnly)</CODE>
323
324	<BR>
325	</TD>
326	</TR>
327	<TR BGCOLOR="white" CLASS="TableRowColor">
328	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
329	<CODE> java.lang.String</CODE></FONT></TD>
330	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getSmallIcon()">getSmallIcon</A></B>()</CODE>
331
332	<BR>
333	</TD>
334	</TR>
335	<TR BGCOLOR="white" CLASS="TableRowColor">
336	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337	<CODE> java.lang.String</CODE></FONT></TD>
338	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#getUrl()">getUrl</A></B>()</CODE>
339
340	<BR>
341	</TD>
342	</TR>
343	<TR BGCOLOR="white" CLASS="TableRowColor">
344	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345	<CODE> java.lang.String</CODE></FONT></TD>
346	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#info()">info</A></B>()</CODE>
347
348	<BR>
349	</TD>
350	</TR>
351	<TR BGCOLOR="white" CLASS="TableRowColor">
352	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353	<CODE> void</CODE></FONT></TD>
354	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#setFields(org.w3c.dom.Element)">setFields</A></B>(org.w3c.dom.Element collectionTag)</CODE>
355
356	<BR>
357	Gets a <collection></collection> element - as returned by a
358	describe response from a <b>Collection</b> - and sets the member vars using
359	the data in there.</TD>
360	</TR>
361	<TR BGCOLOR="white" CLASS="TableRowColor">
362	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
363	<CODE> java.lang.String</CODE></FONT></TD>
364	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#show()">show</A></B>()</CODE>
365
366	<BR>
367	</TD>
368	</TR>
369	<TR BGCOLOR="white" CLASS="TableRowColor">
370	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
371	<CODE> java.lang.String</CODE></FONT></TD>
372	<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/data/CollectionData.html#toString()">toString</A></B>()</CODE>
373
374	<BR>
375	Useful when adding CollectionData objects to a JList or JCombobox.</TD>
376	</TR>
377	</TABLE>
378	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
379	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
380	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
381	<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
382	</TR>
383	<TR BGCOLOR="white" CLASS="TableRowColor">
384	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
385	</TR>
386	</TABLE>
387
388	<P>
389
390	<!-- ============ FIELD DETAIL =========== -->
391
392	<A NAME="field_detail"><!-- --></A>
393	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
394	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
395	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
396	<B>Field Detail</B></FONT></TH>
397	</TR>
398	</TABLE>
399
400	<A NAME="url"><!-- --></A><H3>
401	url</H3>
402	<PRE>
403	protected java.lang.String <B>url</B></PRE>
404	<DL>
405	<DD>Stores the location of images and stuff. Not really used at present
406	<P>
407	<DL>
408	</DL>
409	</DL>
410	<HR>
411
412	<A NAME="name"><!-- --></A><H3>
413	name</H3>
414	<PRE>
415	public final java.lang.String <B>name</B></PRE>
416	<DL>
417	<DD>The basic field of a collection: the name of the collection. This is
418	present for collection elements in all describe response messages,
419	whether sent from the MessageRouter or from Greenstone collections.
420	<P>
421	<DL>
422	</DL>
423	</DL>
424	<HR>
425
426	<A NAME="displayName"><!-- --></A><H3>
427	displayName</H3>
428	<PRE>
429	protected java.lang.String <B>displayName</B></PRE>
430	<DL>
431	<DD>Display name for the Greenstone collection represented by this
432	CollectionData
433	<P>
434	<DL>
435	</DL>
436	</DL>
437	<HR>
438
439	<A NAME="description"><!-- --></A><H3>
440	description</H3>
441	<PRE>
442	protected java.lang.String <B>description</B></PRE>
443	<DL>
444	<DD>Description of the Greenstone collection represented by this
445	CollectionData
446	<P>
447	<DL>
448	</DL>
449	</DL>
450	<HR>
451
452	<A NAME="smallIcon"><!-- --></A><H3>
453	smallIcon</H3>
454	<PRE>
455	protected java.lang.String <B>smallIcon</B></PRE>
456	<DL>
457	<DL>
458	</DL>
459	</DL>
460	<HR>
461
462	<A NAME="icon"><!-- --></A><H3>
463	icon</H3>
464	<PRE>
465	protected java.lang.String <B>icon</B></PRE>
466	<DL>
467	<DL>
468	</DL>
469	</DL>
470	<HR>
471
472	<A NAME="serviceList"><!-- --></A><H3>
473	serviceList</H3>
474	<PRE>
475	protected <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data">CollectionData.ServiceData</A>[] <B>serviceList</B></PRE>
476	<DL>
477	<DD>List of services supported by this collection
478	<P>
479	<DL>
480	</DL>
481	</DL>
482	<HR>
483
484	<A NAME="metadataList"><!-- --></A><H3>
485	metadataList</H3>
486	<PRE>
487	protected <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data">CollectionData.MetaData</A>[] <B>metadataList</B></PRE>
488	<DL>
489	<DD>Collection level metadata
490	<P>
491	<DL>
492	</DL>
493	</DL>
494	<HR>
495
496	<A NAME="pluginList"><!-- --></A><H3>
497	pluginList</H3>
498	<PRE>
499	protected <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html" title="class in org.greenstone.gs3client.data">CollectionData.PluginData</A>[] <B>pluginList</B></PRE>
500	<DL>
501	<DD>Greenstone plugins used to build this collection with
502	<P>
503	<DL>
504	</DL>
505	</DL>
506
507	<!-- ========= CONSTRUCTOR DETAIL ======== -->
508
509	<A NAME="constructor_detail"><!-- --></A>
510	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
511	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
512	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
513	<B>Constructor Detail</B></FONT></TH>
514	</TR>
515	</TABLE>
516
517	<A NAME="CollectionData(org.w3c.dom.Element)"><!-- --></A><H3>
518	CollectionData</H3>
519	<PRE>
520	public <B>CollectionData</B>(org.w3c.dom.Element mrCollectionTag)</PRE>
521	<DL>
522	<DD>Gets a <collection></collection> element as returned by the
523	<b>MessageRouter's</b> describe response, with only the name field set.
524	<P>
525	<DL>
526	<DT><B>Parameters:</B><DD><CODE>mrCollectionTag</CODE> - the <collection></collection> element
527	as returned by a describe response from the <b>MessageRouter</b>.</DL>
528	</DL>
529
530	<!-- ============ METHOD DETAIL ========== -->
531
532	<A NAME="method_detail"><!-- --></A>
533	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
534	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
535	<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
536	<B>Method Detail</B></FONT></TH>
537	</TR>
538	</TABLE>
539
540	<A NAME="setFields(org.w3c.dom.Element)"><!-- --></A><H3>
541	setFields</H3>
542	<PRE>
543	public void <B>setFields</B>(org.w3c.dom.Element collectionTag)</PRE>
544	<DL>
545	<DD>Gets a <collection></collection> element - as returned by a
546	describe response from a <b>Collection</b> - and sets the member vars using
547	the data in there.
548	<P>
549	<DD><DL>
550	<DT><B>Parameters:</B><DD><CODE>collectionTag</CODE> - is the <collection></collection> element
551	as returned by a describe response from a <b>Collection</b>.</DL>
552	</DD>
553	</DL>
554	<HR>
555
556	<A NAME="toString()"><!-- --></A><H3>
557	toString</H3>
558	<PRE>
559	public java.lang.String <B>toString</B>()</PRE>
560	<DL>
561	<DD>Useful when adding CollectionData objects to a JList or JCombobox.
562	<P>
563	<DD><DL>
564	<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
565	</DD>
566	<DD><DL>
567
568	<DT><B>Returns:</B><DD>the name of the collection represented by this CollectionData</DL>
569	</DD>
570	</DL>
571	<HR>
572
573	<A NAME="show()"><!-- --></A><H3>
574	show</H3>
575	<PRE>
576	public java.lang.String <B>show</B>()</PRE>
577	<DL>
578	<DD><DL>
579
580	<DT><B>Returns:</B><DD>a String displaying the contents of this CollectionData object.
581	Useful for debugging purposes.</DL>
582	</DD>
583	</DL>
584	<HR>
585
586	<A NAME="info()"><!-- --></A><H3>
587	info</H3>
588	<PRE>
589	public java.lang.String <B>info</B>()</PRE>
590	<DL>
591	<DD><DL>
592
593	<DT><B>Returns:</B><DD>the Info string for the collection reprsented by this
594	CollectionData object.</DL>
595	</DD>
596	</DL>
597	<HR>
598
599	<A NAME="getName()"><!-- --></A><H3>
600	getName</H3>
601	<PRE>
602	public java.lang.String <B>getName</B>()</PRE>
603	<DL>
604	<DD><DL>
605	</DL>
606	</DD>
607	</DL>
608	<HR>
609
610	<A NAME="getDisplayName()"><!-- --></A><H3>
611	getDisplayName</H3>
612	<PRE>
613	public java.lang.String <B>getDisplayName</B>()</PRE>
614	<DL>
615	<DD><DL>
616	</DL>
617	</DD>
618	</DL>
619	<HR>
620
621	<A NAME="getDescription()"><!-- --></A><H3>
622	getDescription</H3>
623	<PRE>
624	public java.lang.String <B>getDescription</B>()</PRE>
625	<DL>
626	<DD><DL>
627	</DL>
628	</DD>
629	</DL>
630	<HR>
631
632	<A NAME="getSmallIcon()"><!-- --></A><H3>
633	getSmallIcon</H3>
634	<PRE>
635	public java.lang.String <B>getSmallIcon</B>()</PRE>
636	<DL>
637	<DD><DL>
638	</DL>
639	</DD>
640	</DL>
641	<HR>
642
643	<A NAME="getIcon()"><!-- --></A><H3>
644	getIcon</H3>
645	<PRE>
646	public java.lang.String <B>getIcon</B>()</PRE>
647	<DL>
648	<DD><DL>
649	</DL>
650	</DD>
651	</DL>
652	<HR>
653
654	<A NAME="getUrl()"><!-- --></A><H3>
655	getUrl</H3>
656	<PRE>
657	public java.lang.String <B>getUrl</B>()</PRE>
658	<DL>
659	<DD><DL>
660	</DL>
661	</DD>
662	</DL>
663	<HR>
664
665	<A NAME="getMetadataList()"><!-- --></A><H3>
666	getMetadataList</H3>
667	<PRE>
668	public <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data">CollectionData.MetaData</A>[] <B>getMetadataList</B>()</PRE>
669	<DL>
670	<DD><DL>
671	</DL>
672	</DD>
673	</DL>
674	<HR>
675
676	<A NAME="getPluginList()"><!-- --></A><H3>
677	getPluginList</H3>
678	<PRE>
679	public <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.PluginData.html" title="class in org.greenstone.gs3client.data">CollectionData.PluginData</A>[] <B>getPluginList</B>()</PRE>
680	<DL>
681	<DD><DL>
682	</DL>
683	</DD>
684	</DL>
685	<HR>
686
687	<A NAME="getServiceList(boolean)"><!-- --></A><H3>
688	getServiceList</H3>
689	<PRE>
690	public <A HREF="../../../../org/greenstone/gs3client/data/CollectionData.ServiceData.html" title="class in org.greenstone.gs3client.data">CollectionData.ServiceData</A>[] <B>getServiceList</B>(boolean executableServicesOnly)</PRE>
691	<DL>
692	<DD><DL>
693	<DT><B>Parameters:</B><DD><CODE>executableServicesOnly</CODE> - - if true, only the list of supported query
694	and browse services are returned. Otherwise, all the services in the
695	collection are returned.
696	<DT><B>Returns:</B><DD>the list of services supported by this collection.</DL>
697	</DD>
698	</DL>
699	<!-- ========= END OF CLASS DATA ========= -->
700	<HR>
701
702
703	<!-- ======= START OF BOTTOM NAVBAR ====== -->
704	<A NAME="navbar_bottom"><!-- --></A>
705	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
706	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
707	<TR>
708	<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
709	<A NAME="navbar_bottom_firstrow"><!-- --></A>
710	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
711	<TR ALIGN="center" VALIGN="top">
712	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
713	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
714	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
715	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
716	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
717	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
718	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
719	</TR>
720	</TABLE>
721	</TD>
722	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
723	</EM>
724	</TD>
725	</TR>
726
727	<TR>
728	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
729	<A HREF="../../../../org/greenstone/gs3client/data/ClassifierNodeData.html" title="class in org.greenstone.gs3client.data"><B>PREV CLASS</B></A>
730	<A HREF="../../../../org/greenstone/gs3client/data/CollectionData.MetaData.html" title="class in org.greenstone.gs3client.data"><B>NEXT CLASS</B></A></FONT></TD>
731	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
732	<A HREF="../../../../index.html?org/greenstone/gs3client/data/CollectionData.html" target="_top"><B>FRAMES</B></A>
733	<A HREF="CollectionData.html" target="_top"><B>NO FRAMES</B></A>
734	<SCRIPT type="text/javascript">
735	<!--
736	if(window==top) {
737	document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
738	}
739	//-->
740	</SCRIPT>
741	<NOSCRIPT>
742	<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
743	</NOSCRIPT>
744
745
746	</FONT></TD>
747	</TR>
748	<TR>
749	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
750	SUMMARY: <A HREF="#nested_class_summary">NESTED</A> \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
751	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
752	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
753	</TR>
754	</TABLE>
755	<A NAME="skip-navbar_bottom"></A>
756	<!-- ======== END OF BOTTOM NAVBAR ======= -->
757
758	<HR>
759
760	</BODY>
761	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: