001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2003 Jcorporate Ltd. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * 3. The end-user documentation included with the redistribution,
019: * if any, must include the following acknowledgment:
020: * "This product includes software developed by Jcorporate Ltd.
021: * (http://www.jcorporate.com/)."
022: * Alternately, this acknowledgment may appear in the software itself,
023: * if and wherever such third-party acknowledgments normally appear.
024: *
025: * 4. "Jcorporate" and product names such as "Expresso" must
026: * not be used to endorse or promote products derived from this
027: * software without prior written permission. For written permission,
028: * please contact info@jcorporate.com.
029: *
030: * 5. Products derived from this software may not be called "Expresso",
031: * or other Jcorporate product names; nor may "Expresso" or other
032: * Jcorporate product names appear in their name, without prior
033: * written permission of Jcorporate Ltd.
034: *
035: * 6. No product derived from this software may compete in the same
036: * market space, i.e. framework, without prior written permission
037: * of Jcorporate Ltd. For written permission, please contact
038: * partners@jcorporate.com.
039: *
040: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
041: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
042: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
043: * DISCLAIMED. IN NO EVENT SHALL JCORPORATE LTD OR ITS CONTRIBUTORS
044: * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
045: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
046: * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
047: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
048: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
049: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
050: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
051: * SUCH DAMAGE.
052: * ====================================================================
053: *
054: * This software consists of voluntary contributions made by many
055: * individuals on behalf of the Jcorporate Ltd. Contributions back
056: * to the project(s) are encouraged when you make modifications.
057: * Please send them to support@jcorporate.com. For more information
058: * on Jcorporate Ltd. and its products, please see
059: * <http://www.jcorporate.com/>.
060: *
061: * Portions of this software are based upon other open source
062: * products and are subject to their respective licenses.
063: */
064: package com.jcorporate.expresso.core.dataobjects;
065:
066: import com.jcorporate.expresso.core.db.DBException;
067: import org.apache.oro.text.regex.Pattern;
068:
069: import java.util.Iterator;
070:
071: /**
072: * A base class that provides some functionality for all Data Objects
073: *
074: * @author Michael Rimov
075: */
076:
077: abstract public class BaseDataObject implements DataObject,
078: java.io.Serializable {
079:
080: /**
081: * Default constructed status
082: */
083: protected String currentStatus = BaseDataObject.STATUS_NEW;
084:
085: protected Pattern globalMask = null;
086:
087: public BaseDataObject() {
088: }
089:
090: /**
091: * Set the current status of a record
092: *
093: * @param newStatus <p>NEW: Record is new</p>
094: * <p>CURRENT: Record is synchronized with the database </p>
095: * <p>DELETED: Record has been deleted</p>
096: * <p>UPDATED: Record has been updated since it was last written
097: * to the database </p>
098: */
099: public void setStatus(String newStatus) {
100: if (newStatus.equalsIgnoreCase(DataObject.STATUS_NEW)
101: || newStatus
102: .equalsIgnoreCase(DataObject.STATUS_CURRENT)
103: || newStatus
104: .equalsIgnoreCase(DataObject.STATUS_UPDATED)
105: || newStatus
106: .equalsIgnoreCase(DataObject.STATUS_DELETED)) {
107: currentStatus = newStatus;
108: } else {
109: throw new IllegalArgumentException("Unknown status '"
110: + newStatus + "'");
111: }
112: }
113:
114: /* setStatus(String) */
115:
116: /**
117: * Get the status of this record.
118: *
119: * @return String
120: */
121: public String getStatus() {
122: return currentStatus;
123: }
124:
125: /* getStatus() */
126:
127: /**
128: * Set a regular expression "mask" for this base data object that specifies it's
129: * valid values. The mask should already be compiled by the regular
130: * expression compiler
131: *
132: * @param newMask The compiled regular expression mask
133: * <p/>
134: * <p/>
135: * author Yves Henri AMAIZO <amy_amaizo@compuserve.com>
136: */
137: public void setGlobalMask(Pattern newMask) {
138: globalMask = newMask;
139: }
140:
141: /**
142: * Get the compiled regular expression for this base data object.
143: *
144: * @return the precompiled regular expression mask
145: * <p/>
146: * author Yves Henri AMAIZO <amy_amaizo@compuserve.com>
147: */
148: public Pattern getGlobalMask() {
149: return globalMask;
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:
163: /* isMasked() */
164:
165: /**
166: * {@inheritDoc}
167: *
168: * @throws DataException upon setField error.
169: */
170: public void setFieldsWithDefaults() throws DataException {
171:
172: DataObjectMetaData metadata = this .getMetaData();
173: for (Iterator it = metadata.getFieldListArray().iterator(); it
174: .hasNext();) {
175: String fieldname = (String) it.next();
176: String fieldValue = null;
177: try {
178: fieldValue = this .getField(fieldname);
179: } catch (DBException ex) {
180: throw new DataException(
181: "Error getting field current value.", ex);
182: }
183:
184: if ((fieldValue == null) || (fieldValue.length() == 0)) {
185: fieldValue = metadata.getDefaultValue(fieldname);
186: if (fieldValue != null) {
187: this.set(fieldname, fieldValue);
188: }
189: }
190:
191: }
192: }
193:
194: }
|