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.core.dbobj;
066:
067: import com.jcorporate.expresso.core.db.DBException;
068: import com.jcorporate.expresso.core.i18n.Messages;
069:
070: import java.io.IOException;
071: import java.io.ObjectInputStream;
072: import java.io.ObjectOutputStream;
073: import java.io.Serializable;
074:
075: /**
076: * Bean class that describes a database index. Kept internally for DBObject
077: *
078: * @author Michael Rimov
079: */
080: public class DBIndex implements Serializable {
081:
082: /**
083: * The name of the index.
084: */
085: private String indexName;
086:
087: /**
088: * A comma delimited list of fieldNames that belong in the Index.
089: */
090: private String fieldNames;
091:
092: /**
093: * Specifies whether or not the index is supposed to have unique entries
094: * or not. If specified unique, if a duplicate value is entered in the
095: * index, an exception will be thrown when the DBObject is written to the
096: * database.
097: */
098: private boolean unique;
099: private String tableName;
100:
101: /**
102: * Default Constructor - Sets everything to null
103: */
104: public DBIndex() {
105: indexName = null;
106: fieldNames = null;
107: tableName = null;
108: unique = false;
109: }
110:
111: /**
112: * All in one constructor
113: *
114: * @param theIndexName The name you're going to call the index
115: * @param theTableName The name of the table this index is attached to
116: * @param theFieldNames A comma delimited list of fields in the table
117: * @param isItUnique Set it to true if you wish for the index to not have
118: * duplicate entries
119: */
120: public DBIndex(String theIndexName, String theTableName,
121: String theFieldNames, boolean isItUnique) {
122: indexName = theIndexName;
123: tableName = theTableName;
124: fieldNames = theFieldNames;
125: unique = isItUnique;
126: }
127:
128: public String getIndexName() {
129: return indexName;
130: }
131:
132: public void setIndexName(String newIndexName) {
133: indexName = newIndexName;
134: }
135:
136: public String getFieldNames() {
137: return fieldNames;
138: }
139:
140: public boolean isUnique() {
141: return unique;
142: }
143:
144: public void setFieldNames(String newFieldNames) {
145: fieldNames = newFieldNames;
146: }
147:
148: public void setUnique(boolean newUnique) {
149: unique = newUnique;
150: }
151:
152: /**
153: * Constructs a SQL CREATE INDEX statement for use in the
154: * DBCreate sequence
155: *
156: * @return The constructed SQL string.
157: * @throws DBException if there was an error constructing the sql or if
158: * there is a bad argument
159: */
160: public String constructSQL() throws DBException {
161:
162: //Check state
163: if (indexName == null) {
164: throw new DBException(Messages
165: .getString("DBIndex_ConstructSQL_IllegalArgument"));
166: }
167: if (tableName == null) {
168: throw new DBException(
169: "DBIndex_ConstructSQL_IllegalArgument)");
170: }
171: if (fieldNames == null) {
172: throw new DBException(
173: "DBIndex_ConstructSQL_IllegalArgument");
174: }
175:
176: StringBuffer statement = new StringBuffer(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 oos) throws IOException {
196: oos.defaultWriteObject();
197: }
198:
199: private void readObject(ObjectInputStream ois)
200: throws ClassNotFoundException, IOException {
201: ois.defaultReadObject();
202: }
203:
204: public void setTableName(String newTableName) {
205: tableName = newTableName;
206: }
207:
208: public String getTableName() {
209: return tableName;
210: }
211: }
|