KickJava   Java API By Example, From Geeks To Geeks.

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


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.Arrays JavaDoc;
59 import java.util.Collection JavaDoc;
60 import java.util.Collections JavaDoc;
61 import java.util.HashMap JavaDoc;
62 import java.util.Iterator JavaDoc;
63 import java.util.Map JavaDoc;
64
65 import javax.swing.event.TreeModelListener JavaDoc;
66 import javax.swing.tree.TreeModel JavaDoc;
67 import javax.swing.tree.TreePath JavaDoc;
68
69 import org.objectstyle.cayenne.map.Attribute;
70 import org.objectstyle.cayenne.map.Entity;
71 import org.objectstyle.cayenne.map.Relationship;
72
73 /**
74  * Swing TreeModel for Entity attributes and relationships
75  *
76  * @since 1.1
77  * @author Andrei Adamchik
78  */

79 public class EntityTreeModel implements TreeModel JavaDoc {
80     protected Entity root;
81     protected Map JavaDoc sortedChildren;
82
83     // TODO: in the future replace with a more generic filter
84
// to allow arbitrary tree customization
85
protected boolean hideAttributes;
86
87     public EntityTreeModel(Entity root) {
88         this.root = root;
89         sortedChildren = Collections.synchronizedMap(new HashMap JavaDoc());
90     }
91
92     public Object JavaDoc getRoot() {
93         return root;
94     }
95
96     public boolean isHideAttributes() {
97         return hideAttributes;
98     }
99
100     public void setHideAttributes(boolean hideAttributes) {
101         this.hideAttributes = hideAttributes;
102     }
103
104     public Object JavaDoc getChild(Object JavaDoc node, int index) {
105         return sortedChildren(node)[index];
106     }
107
108     public int getChildCount(Object JavaDoc node) {
109         return (node instanceof Attribute) ? 0 : sortedChildren(node).length;
110     }
111
112     public boolean isLeaf(Object JavaDoc node) {
113         return getChildCount(node) == 0;
114     }
115
116     public void valueForPathChanged(TreePath JavaDoc arg0, Object JavaDoc arg1) {
117         // do nothing...
118
}
119
120     public int getIndexOfChild(Object JavaDoc node, Object JavaDoc child) {
121         if (node instanceof Attribute) {
122             return -1;
123         }
124
125         // wonder if linear search will be faster, considering that
126
// this comparator uses reflection?
127
return Arrays.binarySearch(
128             sortedChildren(node),
129             child,
130             Comparators.getNamedObjectComparator());
131     }
132
133     public void addTreeModelListener(TreeModelListener JavaDoc listener) {
134         // do nothing...
135
}
136
137     public void removeTreeModelListener(TreeModelListener JavaDoc listener) {
138         // do nothing...
139
}
140
141     private Object JavaDoc[] sortedChildren(Object JavaDoc node) {
142         Entity entity = entityForNonLeafNode(node);
143         
144         // may happen in incomplete relationships
145
if(entity == null) {
146             return new Object JavaDoc[0];
147         }
148
149         synchronized (sortedChildren) {
150             String JavaDoc key = entity.getName();
151             Object JavaDoc[] sortedForNode = (Object JavaDoc[]) sortedChildren.get(key);
152
153             if (sortedForNode == null) {
154                 Collection JavaDoc attributes = entity.getAttributes();
155                 Collection JavaDoc relationships = entity.getRelationships();
156
157                 // combine two collections in an array
158
int alen = (hideAttributes) ? 0 : attributes.size();
159                 int rlen = relationships.size();
160                 sortedForNode = new Object JavaDoc[alen + rlen];
161
162                 if (!hideAttributes) {
163                     Iterator JavaDoc ait = attributes.iterator();
164                     for (int i = 0; i < alen; i++) {
165                         sortedForNode[i] = ait.next();
166                     }
167                 }
168
169                 Iterator JavaDoc rit = relationships.iterator();
170                 for (int i = 0; i < rlen; i++) {
171                     sortedForNode[alen + i] = rit.next();
172                 }
173
174                 Arrays.sort(sortedForNode, Comparators.getEntityChildrenComparator());
175                 sortedChildren.put(key, sortedForNode);
176             }
177
178             return sortedForNode;
179         }
180     }
181
182     private Entity entityForNonLeafNode(Object JavaDoc node) {
183         if (node instanceof Entity) {
184             return (Entity) node;
185         }
186         else if (node instanceof Relationship) {
187             return ((Relationship) node).getTargetEntity();
188         }
189
190         String JavaDoc className = (node != null) ? node.getClass().getName() : "null";
191         throw new IllegalArgumentException JavaDoc("Unexpected non-leaf node: " + className);
192     }
193 }
194
Popular Tags