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

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

Updated docs significantly

File size: 14.1 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:15 NZST 2008 -->
6<TITLE>
7BrowseDisplay.ClassifierData
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.BrowseDisplay.ClassifierData 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="BrowseDisplay.ClassifierData";
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/BrowseDisplay.ClassifierButton.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../org/greenstone/gs3client/ColourCombo.html" title="class in org.greenstone.gs3client"><B>NEXT CLASS</B></A></FONT></TD>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../index.html?org/greenstone/gs3client/BrowseDisplay.ClassifierData.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="BrowseDisplay.ClassifierData.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</FONT>
88<BR>
89Class BrowseDisplay.ClassifierData</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.BrowseDisplay.ClassifierData</B>
93</PRE>
94<DL>
95<DT><B>Enclosing class:</B><DD><A HREF="../../../org/greenstone/gs3client/BrowseDisplay.html" title="class in org.greenstone.gs3client">BrowseDisplay</A></DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public static class <B>BrowseDisplay.ClassifierData</B><DT>extends java.lang.Object</DL>
100</PRE>
101
102<P>
103Static inner class that represents the data in a &lt;classifier&gt;
104 element - itself nested inside a list (&lt;classifierList&gt;) of them.
105 These elements are to be found in the response returned for a describe
106 request sent to a collection's BrowseService.
107<P>
108
109<P>
110<HR>
111
112<P>
113<!-- =========== FIELD SUMMARY =========== -->
114
115<A NAME="field_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
119<B>Field Summary</B></FONT></TH>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
124<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html#content">content</A></B></CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The content attribute of the &lt;classifier&gt;</TD>
128</TR>
129<TR BGCOLOR="white" CLASS="TableRowColor">
130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
131<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
132<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html#displayDescription">displayDescription</A></B></CODE>
133
134<BR>
135&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The description attribute of the &lt;classifier&gt;</TD>
136</TR>
137<TR BGCOLOR="white" CLASS="TableRowColor">
138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
140<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html#displayName">displayName</A></B></CODE>
141
142<BR>
143&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The display name attribute of the &lt;classifier&gt;</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
147<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
148<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html#name">name</A></B></CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name attribute of the &lt;classifier&gt;</TD>
152</TR>
153</TABLE>
154&nbsp;
155<!-- ======== CONSTRUCTOR SUMMARY ======== -->
156
157<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html#BrowseDisplay.ClassifierData(org.w3c.dom.Element)">BrowseDisplay.ClassifierData</A></B>(org.w3c.dom.Element&nbsp;classifierTag)</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
168</TR>
169</TABLE>
170&nbsp;
171<!-- ========== METHOD SUMMARY =========== -->
172
173<A NAME="method_summary"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
176<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
177<B>Method Summary</B></FONT></TH>
178</TR>
179<TR BGCOLOR="white" CLASS="TableRowColor">
180<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
181<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
182<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html#show()">show</A></B>()</CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierData.html#toString()">toString</A></B>()</CODE>
191
192<BR>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The displayName can be used as a label in any widget.</TD>
194</TR>
195</TABLE>
196&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
199<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
200</TR>
201<TR BGCOLOR="white" CLASS="TableRowColor">
202<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
203</TR>
204</TABLE>
205&nbsp;
206<P>
207
208<!-- ============ FIELD DETAIL =========== -->
209
210<A NAME="field_detail"><!-- --></A>
211<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
214<B>Field Detail</B></FONT></TH>
215</TR>
216</TABLE>
217
218<A NAME="content"><!-- --></A><H3>
219content</H3>
220<PRE>
221public final java.lang.String <B>content</B></PRE>
222<DL>
223<DD>The content attribute of the &lt;classifier&gt;
224<P>
225<DL>
226</DL>
227</DL>
228<HR>
229
230<A NAME="name"><!-- --></A><H3>
231name</H3>
232<PRE>
233public final java.lang.String <B>name</B></PRE>
234<DL>
235<DD>The name attribute of the &lt;classifier&gt;
236<P>
237<DL>
238</DL>
239</DL>
240<HR>
241
242<A NAME="displayName"><!-- --></A><H3>
243displayName</H3>
244<PRE>
245public final java.lang.String <B>displayName</B></PRE>
246<DL>
247<DD>The display name attribute of the &lt;classifier&gt;
248<P>
249<DL>
250</DL>
251</DL>
252<HR>
253
254<A NAME="displayDescription"><!-- --></A><H3>
255displayDescription</H3>
256<PRE>
257public final java.lang.String <B>displayDescription</B></PRE>
258<DL>
259<DD>The description attribute of the &lt;classifier&gt;
260<P>
261<DL>
262</DL>
263</DL>
264
265<!-- ========= CONSTRUCTOR DETAIL ======== -->
266
267<A NAME="constructor_detail"><!-- --></A>
268<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
269<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
270<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
271<B>Constructor Detail</B></FONT></TH>
272</TR>
273</TABLE>
274
275<A NAME="BrowseDisplay.ClassifierData(org.w3c.dom.Element)"><!-- --></A><H3>
276BrowseDisplay.ClassifierData</H3>
277<PRE>
278public <B>BrowseDisplay.ClassifierData</B>(org.w3c.dom.Element&nbsp;classifierTag)</PRE>
279<DL>
280<DD>Constructor.
281<P>
282<DL>
283<DT><B>Parameters:</B><DD><CODE>classifierTag</CODE> - - creates a ClassifierData object from the
284 data stored in a &lt;classifier&gt; element</DL>
285</DL>
286
287<!-- ============ METHOD DETAIL ========== -->
288
289<A NAME="method_detail"><!-- --></A>
290<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
291<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
292<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
293<B>Method Detail</B></FONT></TH>
294</TR>
295</TABLE>
296
297<A NAME="toString()"><!-- --></A><H3>
298toString</H3>
299<PRE>
300public java.lang.String <B>toString</B>()</PRE>
301<DL>
302<DD>The displayName can be used as a label in any widget.
303<P>
304<DD><DL>
305<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
306</DD>
307<DD><DL>
308
309<DT><B>Returns:</B><DD>the displayName of this ClassifierData object</DL>
310</DD>
311</DL>
312<HR>
313
314<A NAME="show()"><!-- --></A><H3>
315show</H3>
316<PRE>
317public java.lang.String <B>show</B>()</PRE>
318<DL>
319<DD><DL>
320
321<DT><B>Returns:</B><DD>a display String with the data stored in this ClassifierData
322 object. Useful for debugging purposes.</DL>
323</DD>
324</DL>
325<!-- ========= END OF CLASS DATA ========= -->
326<HR>
327
328
329<!-- ======= START OF BOTTOM NAVBAR ====== -->
330<A NAME="navbar_bottom"><!-- --></A>
331<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
332<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
333<TR>
334<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
335<A NAME="navbar_bottom_firstrow"><!-- --></A>
336<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
337 <TR ALIGN="center" VALIGN="top">
338 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
339 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
340 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
341 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
342 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
343 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
344 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
345 </TR>
346</TABLE>
347</TD>
348<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
349</EM>
350</TD>
351</TR>
352
353<TR>
354<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
355&nbsp;<A HREF="../../../org/greenstone/gs3client/BrowseDisplay.ClassifierButton.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>&nbsp;
356&nbsp;<A HREF="../../../org/greenstone/gs3client/ColourCombo.html" title="class in org.greenstone.gs3client"><B>NEXT CLASS</B></A></FONT></TD>
357<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
358 <A HREF="../../../index.html?org/greenstone/gs3client/BrowseDisplay.ClassifierData.html" target="_top"><B>FRAMES</B></A> &nbsp;
359&nbsp;<A HREF="BrowseDisplay.ClassifierData.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
360&nbsp;<SCRIPT type="text/javascript">
361 <!--
362 if(window==top) {
363 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
364 }
365 //-->
366</SCRIPT>
367<NOSCRIPT>
368 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
369</NOSCRIPT>
370
371
372</FONT></TD>
373</TR>
374<TR>
375<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
376 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>
377<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
378DETAIL:&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>
379</TR>
380</TABLE>
381<A NAME="skip-navbar_bottom"></A>
382<!-- ======== END OF BOTTOM NAVBAR ======= -->
383
384<HR>
385
386</BODY>
387</HTML>
Note: See TracBrowser for help on using the repository browser.