KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > PersistentObject


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;
57
58 import org.apache.commons.lang.builder.ToStringBuilder;
59
60 /**
61  * A base superclass for client-side Persistent objects.
62  *
63  * @since 1.2
64  * @author Andrus Adamchik
65  */
66 public abstract class PersistentObject implements Persistent {
67
68     protected Object JavaDoc oid;
69     protected int persistenceState;
70     protected transient ObjectContext objectContext;
71
72     public PersistentObject() {
73         this.persistenceState = PersistenceState.TRANSIENT;
74     }
75
76     /**
77      * Notifies parent ObjectContext that this object is about to access a property.
78      */
79     protected void willRead(String JavaDoc property) {
80         if (objectContext != null) {
81             objectContext.objectWillRead(this, property);
82         }
83     }
84
85     /**
86      * Notifies parent ObjectContext that this object is about to modify a property.
87      */
88     protected void willWrite(String JavaDoc property, Object JavaDoc oldValue, Object JavaDoc newValue) {
89         if (objectContext != null) {
90             objectContext.objectWillWrite(this, property, oldValue, newValue);
91         }
92     }
93
94     public int getPersistenceState() {
95         return persistenceState;
96     }
97
98     public void setPersistenceState(int persistenceState) {
99         this.persistenceState = persistenceState;
100
101         if (persistenceState == PersistenceState.TRANSIENT) {
102             this.objectContext = null;
103         }
104     }
105
106     public ObjectContext getObjectContext() {
107         return objectContext;
108     }
109
110     public void setObjectContext(ObjectContext objectContext) {
111         this.objectContext = objectContext;
112     }
113
114     public Object JavaDoc getOid() {
115         return oid;
116     }
117
118     public void setOid(Object JavaDoc oid) {
119         this.oid = oid;
120     }
121
122     public String JavaDoc toString() {
123         return ToStringBuilder.reflectionToString(this);
124     }
125 }
Popular Tags