KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > services > dbobj > DBMessage


1 /* ====================================================================
2  * The Jcorporate Apache Style Software License, Version 1.2 05-07-2002
3  *
4  * Copyright (c) 1995-2002 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
65 package com.jcorporate.expresso.services.dbobj;
66
67 import com.jcorporate.expresso.core.controller.ControllerRequest;
68 import com.jcorporate.expresso.core.db.DBException;
69 import com.jcorporate.expresso.core.dbobj.SecuredDBObject;
70
71
72 /**
73  * A DBMessage is a string that is intercepted coming from the
74  * DBMS as an error or warning message. The DBMS usually doesn't speak
75  * very good english, so we translate from the DBMS message into
76  * a user-friendly message.
77  *
78  * @author Michael Nash
79  * @version $Revision: 1.10 $ $Date: 2004/11/17 20:48:18 $
80  */
81 public class DBMessage
82         extends SecuredDBObject {
83     /**
84      * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#SecuredDBObject
85      */
86     public DBMessage()
87             throws DBException {
88         super();
89     } /* DBMessage() */
90
91
92     /**
93      * @param uid The integer uid
94      * @throws DBException upon initialization error
95      */
96     public DBMessage(int uid)
97             throws DBException {
98         super(uid);
99     }
100
101     /**
102      * For using DBObjects within Controllers. Initializes based upon the current
103      * user and the requested db. [Of course this can be modified later]
104      *
105      * @param request - The controller request handed to you by the framework.
106      * @throws DBException upon initialization error
107      */
108     public DBMessage(ControllerRequest request)
109             throws DBException {
110         super(request);
111     }
112
113     /**
114      * @see com.jcorporate.expresso.core.dbobj.SecuredDBObject#setupFields
115      */
116     public void setupFields()
117             throws DBException {
118         setTargetTable("DBMESSAGE");
119         setDescription("DBmessageMappings");
120         setCharset("ISO-8859-1");
121         addField("MessageNumber", "auto-inc", 0, false, "messageNumber");
122         addField("InputString", "varchar", 255, false, "messageFromDB");
123         addField("OutputString", "varchar", 80, false, "messageForUser");
124         setStringFilter("InputString", "stripFilter");
125
126         //Default of standard filter is ok for OutputString
127 addKey("MessageNumber");
128         setReadOnly("MessageNumber");
129     } /*setupFields() */
130
131
132 } /* DBMessage */
133
134 /* DBMessage */
Popular Tags