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

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

Updated docs significantly
File size: 11.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>
7Displays.MetadataComparator
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.Displays.MetadataComparator 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="Displays.MetadataComparator";
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/Displays.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../org/greenstone/gs3client/Displays.PopupListener.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/Displays.MetadataComparator.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="Displays.MetadataComparator.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;FIELD&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;FIELD&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 Displays.MetadataComparator</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.Displays.MetadataComparator</B>
93</PRE>
94<DL>
95<DT><B>All Implemented Interfaces:</B> <DD>java.util.Comparator</DD>
96</DL>
97<DL>
98<DT><B>Enclosing class:</B><DD><A HREF="../../../org/greenstone/gs3client/Displays.html" title="class in org.greenstone.gs3client">Displays</A></DD>
99</DL>
100<HR>
101<DL>
102<DT><PRE>public static class <B>Displays.MetadataComparator</B><DT>extends java.lang.Object<DT>implements java.util.Comparator</DL>
103</PRE>
104
105<P>
106Static inner class MetadataComparator is a Comparator for the metadata
107 fields stored as a list of Pair objects (name, values).
108 We want to display them alphabetised, grouped by prefix (dls.title, dls.x;
109 dc.title; dc.creator; greenstone's ex metadata does not have a prefix)
110 and in order of alphabet BUT all those starting with capital letters come
111 first, then come those starting with lowercase letters.
112 Those with prefixes come first of all.
113 Comparators can be passed to a sort method (such as Collections.sort) to
114 allow precise control over the sort order. Comparators can also be used to
115 control the order of certain data structures (such as TreeSet or TreeMap).
116<P>
117
118<P>
119<DL>
120<DT><B>See Also:</B><DD><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Comparator.html">Comparator class</a></DL>
121<HR>
122
123<P>
124
125<!-- ======== CONSTRUCTOR SUMMARY ======== -->
126
127<A NAME="constructor_summary"><!-- --></A>
128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
131<B>Constructor Summary</B></FONT></TH>
132</TR>
133<TR BGCOLOR="white" CLASS="TableRowColor">
134<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/Displays.MetadataComparator.html#Displays.MetadataComparator()">Displays.MetadataComparator</A></B>()</CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
138</TR>
139</TABLE>
140&nbsp;
141<!-- ========== METHOD SUMMARY =========== -->
142
143<A NAME="method_summary"><!-- --></A>
144<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
145<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
146<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
147<B>Method Summary</B></FONT></TH>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>&nbsp;int</CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../org/greenstone/gs3client/Displays.MetadataComparator.html#compare(java.lang.Object, java.lang.Object)">compare</A></B>(java.lang.Object&nbsp;nodeID1,
153 java.lang.Object&nbsp;nodeID2)</CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
157</TR>
158</TABLE>
159&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
160<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
162<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
166</TR>
167</TABLE>
168&nbsp;<A NAME="methods_inherited_from_class_java.util.Comparator"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
171<TH ALIGN="left"><B>Methods inherited from interface java.util.Comparator</B></TH>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD><CODE>equals</CODE></TD>
175</TR>
176</TABLE>
177&nbsp;
178<P>
179
180<!-- ========= CONSTRUCTOR DETAIL ======== -->
181
182<A NAME="constructor_detail"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
186<B>Constructor Detail</B></FONT></TH>
187</TR>
188</TABLE>
189
190<A NAME="Displays.MetadataComparator()"><!-- --></A><H3>
191Displays.MetadataComparator</H3>
192<PRE>
193public <B>Displays.MetadataComparator</B>()</PRE>
194<DL>
195</DL>
196
197<!-- ============ METHOD DETAIL ========== -->
198
199<A NAME="method_detail"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
203<B>Method Detail</B></FONT></TH>
204</TR>
205</TABLE>
206
207<A NAME="compare(java.lang.Object, java.lang.Object)"><!-- --></A><H3>
208compare</H3>
209<PRE>
210public int <B>compare</B>(java.lang.Object&nbsp;nodeID1,
211 java.lang.Object&nbsp;nodeID2)</PRE>
212<DL>
213<DD><DL>
214<DT><B>Specified by:</B><DD><CODE>compare</CODE> in interface <CODE>java.util.Comparator</CODE></DL>
215</DD>
216<DD><DL>
217</DL>
218</DD>
219</DL>
220<!-- ========= END OF CLASS DATA ========= -->
221<HR>
222
223
224<!-- ======= START OF BOTTOM NAVBAR ====== -->
225<A NAME="navbar_bottom"><!-- --></A>
226<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
227<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
228<TR>
229<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
230<A NAME="navbar_bottom_firstrow"><!-- --></A>
231<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
232 <TR ALIGN="center" VALIGN="top">
233 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
234 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
235 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
236 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
237 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
238 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
239 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
240 </TR>
241</TABLE>
242</TD>
243<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
244</EM>
245</TD>
246</TR>
247
248<TR>
249<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
250&nbsp;<A HREF="../../../org/greenstone/gs3client/Displays.html" title="class in org.greenstone.gs3client"><B>PREV CLASS</B></A>&nbsp;
251&nbsp;<A HREF="../../../org/greenstone/gs3client/Displays.PopupListener.html" title="class in org.greenstone.gs3client"><B>NEXT CLASS</B></A></FONT></TD>
252<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
253 <A HREF="../../../index.html?org/greenstone/gs3client/Displays.MetadataComparator.html" target="_top"><B>FRAMES</B></A> &nbsp;
254&nbsp;<A HREF="Displays.MetadataComparator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
255&nbsp;<SCRIPT type="text/javascript">
256 <!--
257 if(window==top) {
258 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
259 }
260 //-->
261</SCRIPT>
262<NOSCRIPT>
263 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
264</NOSCRIPT>
265
266
267</FONT></TD>
268</TR>
269<TR>
270<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
271 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
272<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
273DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
274</TR>
275</TABLE>
276<A NAME="skip-navbar_bottom"></A>
277<!-- ======== END OF BOTTOM NAVBAR ======= -->
278
279<HR>
280
281</BODY>
282</HTML>
Note: See TracBrowser for help on using the repository browser.