KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jcorporate > expresso > core > dbobj > DBIndex


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.core.dbobj;
66
67 import com.jcorporate.expresso.core.db.DBException;
68 import com.jcorporate.expresso.core.i18n.Messages;
69
70 import java.io.IOException JavaDoc;
71 import java.io.ObjectInputStream JavaDoc;
72 import java.io.ObjectOutputStream JavaDoc;
73 import java.io.Serializable JavaDoc;
74
75
76 /**
77  * Bean class that describes a database index. Kept internally for DBObject
78  *
79  * @author Michael Rimov
80  */
81 public class DBIndex
82         implements Serializable JavaDoc {
83
84     /**
85      * The name of the index.
86      */
87     private String JavaDoc indexName;
88
89     /**
90      * A comma delimited list of fieldNames that belong in the Index.
91      */
92     private String JavaDoc fieldNames;
93
94     /**
95      * Specifies whether or not the index is supposed to have unique entries
96      * or not. If specified unique, if a duplicate value is entered in the
97      * index, an exception will be thrown when the DBObject is written to the
98      * database.
99      */
100     private boolean unique;
101     private String JavaDoc tableName;
102
103     /**
104      * Default Constructor - Sets everything to null
105      */
106     public DBIndex() {
107         indexName = null;
108         fieldNames = null;
109         tableName = null;
110         unique = false;
111     }
112
113     /**
114      * All in one constructor
115      *
116      * @param theIndexName The name you're going to call the index
117      * @param theTableName The name of the table this index is attached to
118      * @param theFieldNames A comma delimited list of fields in the table
119      * @param isItUnique Set it to true if you wish for the index to not have
120      * duplicate entries
121      */
122     public DBIndex(String JavaDoc theIndexName, String JavaDoc theTableName,
123                    String JavaDoc theFieldNames, boolean isItUnique) {
124         indexName = theIndexName;
125         tableName = theTableName;
126         fieldNames = theFieldNames;
127         unique = isItUnique;
128     }
129
130     public String JavaDoc getIndexName() {
131         return indexName;
132     }
133
134     public void setIndexName(String JavaDoc newIndexName) {
135         indexName = newIndexName;
136     }
137
138     public String JavaDoc getFieldNames() {
139         return fieldNames;
140     }
141
142     public boolean isUnique() {
143         return unique;
144     }
145
146     public void setFieldNames(String JavaDoc newFieldNames) {
147         fieldNames = newFieldNames;
148     }
149
150     public void setUnique(boolean newUnique) {
151         unique = newUnique;
152     }
153
154     /**
155      * Constructs a SQL CREATE INDEX statement for use in the
156      * DBCreate sequence
157      *
158      * @return The constructed SQL string.
159      * @throws DBException if there was an error constructing the sql or if
160      * there is a bad argument
161      */
162     public String JavaDoc constructSQL()
163             throws DBException {
164
165         //Check state
166 if (indexName == null) {
167             throw new DBException(Messages.getString("DBIndex_ConstructSQL_IllegalArgument"));
168         }
169         if (tableName == null) {
170             throw new DBException("DBIndex_ConstructSQL_IllegalArgument)");
171         }
172         if (fieldNames == null) {
173             throw new DBException("DBIndex_ConstructSQL_IllegalArgument");
174         }
175
176         StringBuffer JavaDoc statement = new StringBuffer JavaDoc(100);
177         statement.append("CREATE ");
178
179         if (isUnique() == true) {
180             statement.append("UNIQUE ");
181         }
182
183         statement.append("INDEX ");
184         statement.append(indexName);
185         statement.append(" ON ");
186         statement.append(tableName);
187         statement.append("(");
188         statement.append(fieldNames);
189         statement.append(")");
190
191         return statement.toString();
192     }
193
194     /* ************ Serialization Functions *********************** */
195     private void writeObject(ObjectOutputStream JavaDoc oos)
196             throws IOException JavaDoc {
197         oos.defaultWriteObject();
198     }
199
200     private void readObject(ObjectInputStream JavaDoc ois)
201             throws ClassNotFoundException JavaDoc, IOException JavaDoc {
202         ois.defaultReadObject();
203     }
204
205     public void setTableName(String JavaDoc newTableName) {
206         tableName = newTableName;
207     }
208
209     public String JavaDoc getTableName() {
210         return tableName;
211     }
212 }
Popular Tags