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-2006 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:
042: package org.netbeans.lib.ddl;
043:
044: import java.sql.*;
045: import java.util.Set;
046: import org.netbeans.lib.ddl.*;
047:
048: /**
049: * The factory interface used for creating instances of DatabaseSpecification class.
050: * DatabaseSpecificationFactory collects information about available database
051: * description files. Then it's able to specify if system can control
052: * the database (specified by product name or live connection). It also
053: * provides a list of supported databases.
054: *
055: * @author Slavek Psenicka
056: */
057: public interface DatabaseSpecificationFactory {
058:
059: /** Returns array of database products supported by system. It returns
060: * string array only, not the DatabaseSpecification array.
061: */
062: public Set supportedDatabases();
063:
064: /** Returns true if database (specified by databaseProductName) is
065: * supported by system. Does not throw exception if it doesn't.
066: * @param databaseProductName Database product name as given from DatabaseMetaData
067: * @return True if database product is supported.
068: */
069: public boolean isDatabaseSupported(String databaseProductName);
070:
071: /** Creates instance of DatabaseSpecification class; a database-specification
072: * class. This object knows about used database and can be used as
073: * factory for db-manipulating commands. It connects to the database
074: * and reads database metadata. Throws DBException if database
075: * (obtained from database metadata) is not supported.
076: * @param connection Database connection used to obtain database product name
077: * directly from the database.
078: * @return Specification object.
079: */
080: public DatabaseSpecification createSpecification(
081: DBConnection connection, Connection c)
082: throws DatabaseProductNotFoundException, DDLException;
083:
084: /** Creates instance of DatabaseSpecification class; a database-specification
085: * class. This object knows about used database and can be used as
086: * factory for db-manipulating commands. It connects to database and
087: * reads metadata as createSpecification(DBConnection connection), but always
088: * uses specified databaseProductName. This is not recommended technique.
089: * @param connection Database connection (is NOT used to obtain database product name)
090: * @return Specification object.
091: */
092: public DatabaseSpecification createSpecification(
093: DBConnection connection, String databaseProductName,
094: Connection c) throws DatabaseProductNotFoundException;
095:
096: public DatabaseSpecification createSpecification(Connection c)
097: throws DatabaseProductNotFoundException, SQLException;
098:
099: /** Returns debug-mode flag
100: */
101: public boolean isDebugMode();
102:
103: /** Sets debug-mode flag
104: */
105: public void setDebugMode(boolean mode);
106: }
107:
108: /*
109: * <<Log>>
110: */
|