KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > util > CayenneMap


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.util;
57
58 import java.util.Comparator JavaDoc;
59 import java.util.Iterator JavaDoc;
60 import java.util.Map JavaDoc;
61 import java.util.SortedMap JavaDoc;
62
63 import org.apache.commons.collections.FastTreeMap;
64
65 /**
66  * A <code>CayenneMap</code> is a specialized double-linked
67  * ordered map class. Attempts to add objects using
68  * an already existing keys will result in
69  * IllegalArgumentExceptions.
70  *
71  * <p>Normally CayenneMap is not subclassed directly,
72  * but is rather used as an instance variable within
73  * another class. Enclosing instance would set itself
74  * as a parent of this map.</p>
75  *
76  *
77  * @author Andrei Adamchik
78  */

79 public class CayenneMap extends FastTreeMap {
80     protected Object JavaDoc parent;
81
82     /**
83      * Constructor for CayenneMap.
84      */

85     public CayenneMap(Object JavaDoc parent) {
86         this.parent = parent;
87     }
88
89     /**
90      * Constructor for CayenneMap.
91      * @param c
92      */

93     public CayenneMap(Object JavaDoc parent, Comparator JavaDoc c) {
94         super(c);
95         this.parent = parent;
96     }
97
98     /**
99      * Constructor for CayenneMap.
100      * @param m
101      */

102     public CayenneMap(Object JavaDoc parent, Map JavaDoc m) {
103         // !IMPORTANT - set parent before populating the map
104
this.parent = parent;
105         putAll(m);
106     }
107
108     /**
109      * Constructor for CayenneMap.
110      * @param m
111      */

112     public CayenneMap(Object JavaDoc parent, SortedMap JavaDoc m) {
113         // !IMPORTANT - set parent before populating the map
114
this.parent = parent;
115         putAll(m);
116     }
117
118     /**
119      * Maps specified key-value pair. If value is a
120      * CayenneMapEntry, sets its parent to this map.
121      *
122      * @see java.util.Map#put(Object, Object)
123      */

124     public Object JavaDoc put(Object JavaDoc key, Object JavaDoc value) {
125
126         if (containsKey(key) && get(key) != value) {
127             // build descriptive failure message
128
StringBuffer JavaDoc message = new StringBuffer JavaDoc();
129             message.append("Attempt to insert duplicate key. [key '");
130             message.append(key);
131             message.append("'");
132
133             if (parent instanceof CayenneMapEntry) {
134                 message.append(", parent '").append(
135                     ((CayenneMapEntry) parent).getName()).append(
136                     "'");
137             }
138
139             if (value instanceof CayenneMapEntry) {
140                 message.append(", child '").append(
141                     ((CayenneMapEntry) value).getName()).append(
142                     "'");
143             }
144             message.append("]");
145
146             throw new IllegalArgumentException JavaDoc(message.toString());
147         }
148
149         if (value instanceof CayenneMapEntry) {
150             ((CayenneMapEntry) value).setParent(parent);
151         }
152
153         super.put(key, value);
154         return null;
155     }
156
157     /**
158      * @see java.util.Map#putAll(Map)
159      */

160     public void putAll(Map JavaDoc t) {
161         Iterator JavaDoc it = t.keySet().iterator();
162         while (it.hasNext()) {
163             Object JavaDoc key = it.next();
164             put(key, t.get(key));
165         }
166     }
167
168     /**
169      * Returns the parent.
170      * @return Object
171      */

172     public Object JavaDoc getParent() {
173         return parent;
174     }
175
176     public void setParent(Object JavaDoc mapParent) {
177         this.parent = mapParent;
178     }
179 }
180
Popular Tags