001: /* ====================================================================
002: * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
003: *
004: * Copyright (c) 1995-2002 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:
065: package com.jcorporate.expresso.services.dbobj;
066:
067: import com.jcorporate.expresso.core.controller.ControllerRequest;
068: import com.jcorporate.expresso.core.db.DBException;
069: import com.jcorporate.expresso.core.servlet.CheckLogin;
070:
071: /**
072: * This object defines the available user preference definitions.
073: * The populateDefaultValues methods of various db objects can populate
074: * this table to "register" the fact that they are providing preference
075: * values that the user can set. The actual preferences are set in UserPreference
076: * and the valid values (if any are defined) are specified in UserPreferenceVal
077: *
078: * @author Michael Nash
079: */
080: public class UserPreferenceDef extends SecurityDBObject {
081:
082: public static final String PREF_CODE = UserPreference.PREF_CODE;
083: public static final String CLASS_NAME = UserPreference.CLASS_NAME;
084: public static final String DESCRIPTION = "Descrip";
085: public static final String DEFAULT_VALUE = "DefaultVal";
086:
087: /**
088: * constant for indicating that any class can use this preference; it is shared
089: */
090: public static final String ANY_CLASS = "*";
091: public static final String PRIMARY_GROUP_PREF = "PrimaryGroupPref";
092:
093: /**
094: * @throws DBException upon creation error.
095: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#SecuredDBObject
096: */
097: public UserPreferenceDef() throws DBException {
098: super ();
099: } /* UserPreferenceDef() */
100:
101: /**
102: * Use over (String) constructor. Initializes the object in the context
103: * of the user who's uid belongs to the parameter.
104: *
105: * @param uid the Uid of the user context
106: * @throws DBException if there's an initialization problem
107: */
108: public UserPreferenceDef(int uid) throws DBException {
109: super (uid);
110: }
111:
112: /**
113: * For using DBObjects within Controllers. Initializes based upon the current
114: * user and the requested db. [Of course this can be modified later]
115: *
116: * @param request - The controller request handed to you by the framework.
117: * @throws DBException if there's an initialization problem
118: */
119: public UserPreferenceDef(ControllerRequest request)
120: throws DBException {
121: super (request);
122: }
123:
124: /**
125: * @throws DBException upon initialization error
126: * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#setupFields
127: */
128: public void setupFields() throws DBException {
129: setTargetTable("USERPREFDEF");
130: setDescription("DBuserPrefDef");
131: setCharset("ISO-8859-1");
132: addField(CLASS_NAME, "varchar", 128, false, "className");
133: addField(PREF_CODE, "varchar", 30, false, "prefCode");
134: addField(DESCRIPTION, "varchar", 132, true, "description");
135: addField(DEFAULT_VALUE, "varchar", 80, true, "defaultValue");
136: setStringFilter(CLASS_NAME, "stripFilter");
137: setStringFilter(PREF_CODE, "stripFilter");
138: addKey(CLASS_NAME);
139: addKey(PREF_CODE);
140: addDetail(
141: "com.jcorporate.expresso.services.dbobj.UserPreferenceVal",
142: "ClassName|PrefCode", "ClassName|PrefCode");
143: addDetail(
144: "com.jcorporate.expresso.services.dbobj.UserPreference",
145: "ClassName|PrefCode", "ClassName|PrefCode");
146: } /* setupFields() */
147:
148: /**
149: * @throws DBException
150: */
151: public synchronized void populateDefaultValues() throws DBException {
152:
153: // add language pref
154: UserPreferenceDef oneDef = new UserPreferenceDef();
155: oneDef.setDataContext(getDataContext());
156: oneDef.setField(CLASS_NAME,
157: com.jcorporate.expresso.core.servlet.CheckLogin.class
158: .getName());
159: oneDef.setField(PREF_CODE, "language");
160:
161: if (!oneDef.find()) {
162: oneDef.setField(DEFAULT_VALUE, "Browser");
163: oneDef.setField(DESCRIPTION, "Language");
164: oneDef.add();
165: }
166:
167: // add valid values for language
168: UserPreferenceVal oneVal = new UserPreferenceVal();
169: oneVal.setDataContext(getDataContext());
170: oneVal.setField(CLASS_NAME, CheckLogin.class.getName());
171: oneVal.setField(PREF_CODE, "language");
172: oneVal.setField(UserPreference.PREF_VALUE, "Browser");
173: oneVal.setField(DESCRIPTION, "Browser Default");
174: oneVal.addIfNeeded();
175: oneVal.clear();
176: oneVal.setField(CLASS_NAME, CheckLogin.class.getName());
177: oneVal.setField(PREF_CODE, "language");
178: oneVal.setField(DESCRIPTION, "Spanish");
179: oneVal.setField(UserPreference.PREF_VALUE, "es");
180: oneVal.addIfNeeded();
181: oneVal.clear();
182: oneVal.setField(CLASS_NAME, CheckLogin.class.getName());
183: oneVal.setField(PREF_CODE, "language");
184: oneVal.setField(DESCRIPTION, "French");
185: oneVal.setField(UserPreference.PREF_VALUE, "fr");
186: oneVal.addIfNeeded();
187:
188: // define another possible pref for country
189: oneDef.clear();
190: oneDef.setField(CLASS_NAME, CheckLogin.class.getName());
191: oneDef.setField(PREF_CODE, "country");
192: oneDef.setField(DEFAULT_VALUE, "default");
193: oneDef.setField(DESCRIPTION, "Country");
194: oneDef.addIfNeeded();
195:
196: // add valid values for country
197: oneVal.clear();
198: oneVal.setField(CLASS_NAME, CheckLogin.class.getName());
199: oneVal.setField(PREF_CODE, "country");
200: oneVal.setField(DESCRIPTION, "Default");
201: oneVal.setField(UserPreference.PREF_VALUE, "default");
202: oneVal.addIfNeeded();
203:
204: // add pref for primary group; any class can access
205: oneDef.clear();
206: oneDef.setField(CLASS_NAME, ANY_CLASS);
207: oneDef.setField(PREF_CODE, PRIMARY_GROUP_PREF);
208: oneDef.setField(DESCRIPTION, "Primary Group");
209: oneDef.setField(DEFAULT_VALUE, UserGroup.DEMO_GROUP);
210: oneDef.addIfNeeded();
211:
212: } /* populateDefaultValues() */
213: }
|