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:
042: package org.netbeans.modules.db.sql.visualeditor.api;
043:
044: import java.sql.SQLException;
045: import java.util.List;
046:
047: /**
048: * Implements a cache for metadata that is supplied to the Visual SQL Editor
049: *
050: * @author Joel Brown, Jim Davidson
051: */
052: public interface VisualSQLEditorMetaData {
053:
054: /**
055: * Returns the schemas that are included in this DataSource/DatabaseConnection
056: * Used during Add Table and similar operations.
057: *
058: * @return the List of schema names
059: */
060: public List<String> getSchemas();
061:
062: /**
063: * Returns the tables (and views) in this DataSource/DatabaseConnection
064: *
065: * @return the List of tables/views, each in the form of a {@literal List<schema, table>}
066: */
067: // public List<List<String>> getTables(String schema) throws SQLException ;
068: public List<List<String>> getTables() throws SQLException;
069:
070: /**
071: * Returns the columns in the specified schema/table.
072: * @return a List of column names
073: */
074: public List<String> getColumns(String schema, String table)
075: throws SQLException;
076:
077: /****
078: * Returns the primary key columns for the given schema/table combination.
079: *
080: * @return the List of columns
081: */
082: public List<String> getPrimaryKeys(String schema, String table)
083: throws SQLException;
084:
085: /***
086: * Returns the imported keys for the given schema/table.
087: * @return the List of imported Keys. Each key is a List of the form
088: * <br> {@literal <foreign schema, foreign table, foreign column, primary schema, primary table, primary column>}
089: */
090: public List<List<String>> getImportedKeys(String schema,
091: String table) throws SQLException;
092:
093: /***
094: * Returns the exported keys for the given schema/table.
095: * @return the List of exported keys. Each key is a List of the form
096: * <br> {@literal <foreign schema, foreign table, foreign column, primary schema, primary table, primary column>}
097: */
098: public List<List<String>> getExportedKeys(String schema,
099: String table) throws SQLException;
100:
101: /***
102: * Returns the string used t quote SQL identifiers.
103: * @return the quoting string or a space if quoting is not supported
104: */
105: public String getIdentifierQuoteString() throws SQLException;
106: }
|