KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > dataobjects > BaseDataObject


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  * notice, this list of conditions and the following disclaimer in
15  * the documentation and/or other materials provided with the
16  * distribution.
17  *
18  * 3. The end-user documentation included with the redistribution,
19  * if any, must include the following acknowledgment:
20  * "This product includes software developed by Jcorporate Ltd.
21  * (http://www.jcorporate.com/)."
22  * Alternately, this acknowledgment may appear in the software itself,
23  * if and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. "Jcorporate" and product names such as "Expresso" must
26  * not be used to endorse or promote products derived from this
27  * software without prior written permission. For written permission,
28  * please contact info@jcorporate.com.
29  *
30  * 5. Products derived from this software may not be called "Expresso",
31  * or other Jcorporate product names; nor may "Expresso" or other
32  * Jcorporate product names appear in their name, without prior
33  * written permission of Jcorporate Ltd.
34  *
35  * 6. No product derived from this software may compete in the same
36  * market space, i.e. framework, without prior written permission
37  * of Jcorporate Ltd. For written permission, please contact
38  * partners@jcorporate.com.
39  *
40  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
41  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
42  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43  * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
44  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
45  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
46  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
47  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
48  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
49  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
50  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * ====================================================================
53  *
54  * This software consists of voluntary contributions made by many
55  * individuals on behalf of the Jcorporate Ltd. Contributions back
56  * to the project(s) are encouraged when you make modifications.
57  * Please send them to support@jcorporate.com. For more information
58  * on Jcorporate Ltd. and its products, please see
59  * <http://www.jcorporate.com/>.
60  *
61  * Portions of this software are based upon other open source
62  * products and are subject to their respective licenses.
63  */
64 package com.jcorporate.expresso.core.dataobjects;
65
66 import com.jcorporate.expresso.core.db.DBException;
67 import org.apache.oro.text.regex.Pattern;
68
69 import java.util.Iterator JavaDoc;
70
71
72 /**
73  * A base class that provides some functionality for all Data Objects
74  *
75  * @author Michael Rimov
76  */
77
78 abstract public class BaseDataObject implements DataObject
79         , java.io.Serializable JavaDoc {
80
81
82     /**
83      * Default constructed status
84      */
85     protected String JavaDoc currentStatus = BaseDataObject.STATUS_NEW;
86
87     protected Pattern globalMask = null;
88
89     public BaseDataObject() {
90     }
91
92
93     /**
94      * Set the current status of a record
95      *
96      * @param newStatus <p>NEW: Record is new</p>
97      * <p>CURRENT: Record is synchronized with the database </p>
98      * <p>DELETED: Record has been deleted</p>
99      * <p>UPDATED: Record has been updated since it was last written
100      * to the database </p>
101      */
102     public void setStatus(String JavaDoc newStatus) {
103         if (newStatus.equalsIgnoreCase(DataObject.STATUS_NEW) ||
104                 newStatus.equalsIgnoreCase(DataObject.STATUS_CURRENT) ||
105                 newStatus.equalsIgnoreCase(DataObject.STATUS_UPDATED) ||
106                 newStatus.equalsIgnoreCase(DataObject.STATUS_DELETED)) {
107             currentStatus = newStatus;
108         } else {
109             throw new IllegalArgumentException JavaDoc("Unknown status '" + newStatus +
110                     "'");
111         }
112     }
113     /* setStatus(String) */
114
115
116     /**
117      * Get the status of this record.
118      *
119      * @return String
120      */
121     public String JavaDoc getStatus() {
122         return currentStatus;
123     }
124     /* getStatus() */
125
126     /**
127      * Set a regular expression "mask" for this base data object that specifies it's
128      * valid values. The mask should already be compiled by the regular
129      * expression compiler
130      *
131      * @param newMask The compiled regular expression mask
132      * <p/>
133      * <p/>
134      * author Yves Henri AMAIZO <amy_amaizo@compuserve.com>
135      */
136     public void setGlobalMask(Pattern newMask) {
137         globalMask = newMask;
138     }
139
140     /**
141      * Get the compiled regular expression for this base data object.
142      *
143      * @return the precompiled regular expression mask
144      * <p/>
145      * author Yves Henri AMAIZO <amy_amaizo@compuserve.com>
146      */
147     public Pattern getGlobalMask() {
148         return globalMask;
149     }
150
151
152     /**
153      * Return boolean if the data object has a mask set
154      *
155      * @return True if the data object mask is set, else false if it is not
156      * <p/>
157      * author Yves Henri AMAIZO <amy_amaizo@compuserve.com>
158      */
159     public boolean isGlobalMasked() {
160         return globalMask != null;
161     }
162     /* isMasked() */
163
164     /**
165      * {@inheritDoc}
166      *
167      * @throws DataException upon setField error.
168      */
169     public void setFieldsWithDefaults() throws DataException {
170
171         DataObjectMetaData metadata = this.getMetaData();
172         for (Iterator JavaDoc it = metadata.getFieldListArray()
173                 .iterator(); it.hasNext();) {
174             String JavaDoc fieldname = (String JavaDoc) it.next();
175             String JavaDoc fieldValue = null;
176             try {
177                 fieldValue = this.getField(fieldname);
178             } catch (DBException ex) {
179                 throw new DataException("Error getting field current value.", ex);
180             }
181
182             if ((fieldValue == null) || (fieldValue.length() == 0)) {
183                 fieldValue = metadata.getDefaultValue(fieldname);
184                 if (fieldValue != null) {
185                     this.set(fieldname, fieldValue);
186                 }
187             }
188
189         }
190     }
191
192 }
193
Popular Tags