001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.sql.framework.model;
042:
043: import java.util.List;
044: import java.util.Map;
045:
046: import org.netbeans.modules.etl.model.ETLObject;
047: import com.sun.sql.framework.exception.BaseException;
048:
049: /**
050: * Extension of DBModel
051: *
052: * @author Jonathan Giron
053: * @version $Revision$
054: */
055:
056: public interface SQLDBModel extends DatabaseModel, SQLObject {
057:
058: /** Constant for DatabaseModel metadata name tag. */
059: public static final String MODEL_TAG = "dbModel";
060: /** String constant for model name tag. */
061: public static final String NAME = "name";
062: /** String constant for absolute path to owning project */
063: public static final String PROJECTPATH = "projectPath";
064: /** String constant for reference ID. */
065: public static final String REFID = "refId";
066: /** String constant for Database reference key ID. */
067: public static final String REFKEY = "refKey";
068: /** String constant indicating source type */
069: public static final String STRTYPE_SOURCE = "source";
070: /** String constant indicating source type */
071: public static final String STRTYPE_TARGET = "target";
072:
073: /**
074: * Adds table to this instance.
075: *
076: * @param table new table to add
077: * @throws IllegalStateException if unable to add table
078: */
079: public void addTable(SQLDBTable table) throws IllegalStateException;
080:
081: public void clearOverride(boolean clearCatalogOverride,
082: boolean clearSchemaOverride);
083:
084: /**
085: * Clones this object.
086: *
087: * @return shallow copy of this SQLDataSource
088: */
089: public Object clone();
090:
091: /**
092: * check if a table exists This will check if a table is in database model,
093: */
094: public boolean containsTable(SQLDBTable table);
095:
096: /**
097: * Copies member values to those contained in the given DatabaseModel instance.
098: *
099: * @param src DatabaseModel whose contents are to be copied into this instance
100: */
101: public void copyFrom(DatabaseModel src);
102:
103: /**
104: * Copies member values to those contained in the given DatabaseModel instance, using
105: * the given value for object type.
106: *
107: * @param src DatabaseModel whose contents are to be copied into this instance
108: * @param objType type of object (SOURCE_DBMODEL or TARGET_DBMODEL)
109: */
110: public void copyFrom(DatabaseModel src, int objType);
111:
112: /**
113: * Create DBTable instance with the given table, schema, and catalog names.
114: *
115: * @param tableName table name of new table
116: * @param schemaName schema name of new table
117: * @param catalogName catalog name of new table
118: * @return an instance of SQLTable if successful, null if failed.
119: */
120: public DBTable createTable(String tableName, String schemaName,
121: String catalogName);
122:
123: /**
124: * Deletes all tables associated with this data source.
125: *
126: * @return true if all tables were deleted successfully, false otherwise.
127: */
128: public boolean deleteAllTables();
129:
130: /**
131: * Delete table from the SQLDataSource
132: *
133: * @param fqTableName fully qualified name of table to be deleted.
134: * @return true if successful. false if failed.
135: */
136: public boolean deleteTable(String fqTableName);
137:
138: /**
139: * @see java.lang.Object#equals
140: */
141: public boolean equals(Object refObj);
142:
143: /**
144: * Gets the allTables attribute of the SQLDataSource object
145: *
146: * @return The allTables value
147: */
148: public Map getAllSQLTables();
149:
150: /**
151: * get a list of tables based on table name, schema name and catalog name since we
152: * allow duplicate tables this will return a list of tables
153: */
154: public List getAllTables(String tableName, String schemaName,
155: String catalogName);
156:
157: /**
158: * Gets SQLDBConnectionDefinition of the SQLDataSource object
159: *
160: * @return ConnectionDefinition of the SQLDataSource object
161: */
162: public DBConnectionDefinition getETLDBConnectionDefinition()
163: throws BaseException;
164:
165: /**
166: * Gets SQLObject, if any, having the given object ID.
167: *
168: * @param objectId ID of SQLObject being sought
169: * @return SQLObject associated with objectID, or null if no such object exists.
170: */
171: public SQLObject getObject(String objectId);
172:
173: public String getRefKey();
174:
175: /**
176: * Gets a read-only Map of table names to available DBTable instances in this model.
177: *
178: * @return readonly Map of table names to DBTable instances
179: */
180: public Map getTableMap();
181:
182: /**
183: * Overrides default implementation to compute hashCode value for those members used
184: * in equals() for comparison.
185: *
186: * @return hash code for this object
187: * @see java.lang.Object#hashCode
188: */
189: public int hashCode();
190:
191: public void overrideCatalogNames(Map catalogOverride);
192:
193: public void overrideSchemaNames(Map schemaOverride);
194:
195: public void setConnectionDefinition(
196: DBConnectionDefinition dbConnectionDef);
197:
198: /**
199: * Sets the description string of this DatabaseModel
200: *
201: * @param newDesc new description string
202: */
203: public void setDescription(String newDesc);
204:
205: /**
206: * @see org.netbeans.modules.model.database.DatabaseModel#getModelName
207: */
208: public void setModelName(String theName);
209:
210: public void setRefKey(String aKey);
211:
212: /**
213: * Sets repository object, if any, providing underlying data for this DatabaseModel
214: * implementation.
215: *
216: * @param obj Object hosting this object's metadata, or null if data are not
217: * held by a ETLObject.
218: */
219: public void setSource(ETLObject obj);
220:
221: public void setSQLFrameworkParentObject(
222: SQLFrameworkParentObject aParent);
223:
224: }
|