KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > map > event > MapEvent


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.map.event;
57
58 import org.objectstyle.cayenne.event.CayenneEvent;
59 import org.objectstyle.cayenne.util.Util;
60
61 /**
62  * Superclass of CayenneModeler events.
63  *
64  * @author Andrei Adamchik
65  */

66 public abstract class MapEvent extends CayenneEvent {
67
68     /**
69      * A type that describes object modification events. CHANGE is a default type of new
70      * MapEvents, unless the type is specified explicitly.
71      */

72     public static final int CHANGE = 1;
73
74     /**
75      * A type that describes object creation events.
76      */

77     public static final int ADD = 2;
78
79     /**
80      * A type that describes object removal events.
81      */

82     public static final int REMOVE = 3;
83
84     protected int id = CHANGE;
85     protected String JavaDoc oldName;
86     protected boolean oldNameSet;
87
88     /**
89      * Constructor for MapEvent.
90      *
91      * @param source event source
92      */

93     public MapEvent(Object JavaDoc source) {
94         super(source);
95     }
96
97     /**
98      * Constructor for MapEvent.
99      *
100      * @param source event source
101      */

102     public MapEvent(Object JavaDoc source, String JavaDoc oldName) {
103         super(source);
104         setOldName(oldName);
105     }
106
107     public boolean isNameChange() {
108         return oldNameSet && !Util.nullSafeEquals(getOldName(), getNewName());
109     }
110
111     /**
112      * Returns the id.
113      *
114      * @return int
115      */

116     public int getId() {
117         return id;
118     }
119
120     /**
121      * Returns the newName of the object that caused this event.
122      */

123     public abstract String JavaDoc getNewName();
124
125     /**
126      * Returns the oldName.
127      */

128     public String JavaDoc getOldName() {
129         return oldName;
130     }
131
132     /**
133      * Sets the id.
134      */

135     public void setId(int id) {
136         this.id = id;
137     }
138
139     /**
140      * Sets the oldName.
141      */

142     public void setOldName(String JavaDoc oldName) {
143         this.oldName = oldName;
144         this.oldNameSet = true;
145     }
146 }
Popular Tags