KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > modeler > util > Comparators


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */

56 package org.objectstyle.cayenne.modeler.util;
57
58 import java.util.Comparator JavaDoc;
59
60 import org.objectstyle.cayenne.access.DataNode;
61 import org.objectstyle.cayenne.map.Attribute;
62 import org.objectstyle.cayenne.map.DataMap;
63 import org.objectstyle.cayenne.map.DbEntity;
64 import org.objectstyle.cayenne.map.Entity;
65 import org.objectstyle.cayenne.map.ObjEntity;
66 import org.objectstyle.cayenne.map.Procedure;
67 import org.objectstyle.cayenne.map.Relationship;
68 import org.objectstyle.cayenne.query.Query;
69
70 /**
71  * A collection of useful Comparators used by the modeler.
72  *
73  * @since 1.1
74  * @author Andrei Adamchik
75  */

76 public class Comparators {
77
78     private static final Comparator JavaDoc dataDomainChildrenComparator = new DataDomainChildrenComparator();
79
80     private static final Comparator JavaDoc dataMapChildrenComparator = new DataMapChildrenComparator();
81
82     private static final Comparator JavaDoc entityChildrenComparator = new EntityChildrenComparator();
83
84     private static final Comparator JavaDoc namedObjectComparator = new NamedObjectComparator();
85
86     /**
87      * Returns a comparator to order DataMap objects of mixed types. Objects of the same
88      * type are ordered based on "name" property. Objects of different types are ordered
89      * based on the following precedence: DataMap, DataNode.
90      */

91     public static Comparator JavaDoc getDataDomainChildrenComparator() {
92         return dataDomainChildrenComparator;
93     }
94
95     /**
96      * Returns a comparator to order DataMap objects of mixed types. Objects of the same
97      * type are ordered based on "name" property. Objects of different types are ordered
98      * based on the following precedence: DataMap, ObjEntity, DbEntity, Procedure and
99      * Query.
100      */

101     public static Comparator JavaDoc getDataMapChildrenComparator() {
102         return dataMapChildrenComparator;
103     }
104
105     /**
106      * Returns a comparator to order Entity properties such as Attributes and
107      * Relationships. Objects of the same type are ordered based on "name" property.
108      * Objects of different types are ordered based on the following precedence:
109      * Attribute, Relationship.
110      */

111     public static Comparator JavaDoc getEntityChildrenComparator() {
112         return entityChildrenComparator;
113     }
114
115     /**
116      * Returns a comparator to order java beans according to their "name" property.
117      */

118     public static Comparator JavaDoc getNamedObjectComparator() {
119         return namedObjectComparator;
120     }
121
122     static class NamedObjectComparator implements Comparator JavaDoc {
123
124         public int compare(Object JavaDoc o1, Object JavaDoc o2) {
125
126             String JavaDoc name1 = ModelerUtil.getObjectName(o1);
127             String JavaDoc name2 = ModelerUtil.getObjectName(o2);
128
129             if (name1 == null) {
130                 return (name2 != null) ? -1 : 0;
131             }
132             else if (name2 == null) {
133                 return 1;
134             }
135             else {
136                 return name1.compareTo(name2);
137             }
138         }
139     }
140
141     final static class DataDomainChildrenComparator extends NamedObjectComparator {
142
143         public int compare(Object JavaDoc o1, Object JavaDoc o2) {
144             int delta = getClassWeight(o1) - getClassWeight(o2);
145             if (delta != 0) {
146                 return delta;
147             }
148             else {
149                 return super.compare(o1, o2);
150             }
151         }
152
153         private static int getClassWeight(Object JavaDoc o) {
154             if (o instanceof DataMap) {
155                 return 1;
156             }
157             else if (o instanceof DataNode) {
158                 return 2;
159             }
160             else {
161                 // this should trap nulls among other things
162
return Integer.MAX_VALUE;
163             }
164         }
165     }
166
167     final static class DataMapChildrenComparator extends NamedObjectComparator {
168
169         public int compare(Object JavaDoc o1, Object JavaDoc o2) {
170             int delta = getClassWeight(o1) - getClassWeight(o2);
171             if (delta != 0) {
172                 return delta;
173             }
174             else {
175                 return super.compare(o1, o2);
176             }
177         }
178
179         private static int getClassWeight(Object JavaDoc o) {
180             if (o instanceof DataMap) {
181                 return 1;
182             }
183             else if (o instanceof ObjEntity) {
184                 return 2;
185             }
186             else if (o instanceof DbEntity) {
187                 return 3;
188             }
189             else if (o instanceof Procedure) {
190                 return 4;
191             }
192             else if (o instanceof Query) {
193                 return 5;
194             }
195             else {
196                 // this should trap nulls among other things
197
return Integer.MAX_VALUE;
198             }
199         }
200     }
201
202     final static class EntityChildrenComparator extends NamedObjectComparator {
203
204         public int compare(Object JavaDoc o1, Object JavaDoc o2) {
205             int delta = getClassWeight(o1) - getClassWeight(o2);
206             if (delta != 0) {
207                 return delta;
208             }
209             else {
210                 return super.compare(o1, o2);
211             }
212         }
213
214         private static int getClassWeight(Object JavaDoc o) {
215             if (o instanceof Entity) {
216                 return 1;
217             }
218             else if (o instanceof Attribute) {
219                 return 2;
220             }
221             else if (o instanceof Relationship) {
222                 return 3;
223             }
224             else {
225                 // this should trap nulls among other things
226
return Integer.MAX_VALUE;
227             }
228         }
229     }
230 }
Popular Tags