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.Map;
044: import java.util.Properties;
045:
046: /**
047: * Interface to determine overwritten database catalog and
048: * schema names
049: *
050: * @author Sherry Weng
051: * @version $Revision$
052: */
053:
054: public interface DBRuntimeEnvAccessor {
055:
056: /** Returns a flag indicating if the user wants to overwrite the catalog name
057: *
058: * @return flag indicating if the user wants to overwrite the catalog name
059: */
060: public boolean isCatalogNameOverwritten();
061:
062: /** Gets the map of catalog names to be replaced with
063: * In the map, key will have the old name, and value will
064: * be the new name
065: *
066: * @return the Map of overwritten catalog names
067: */
068: public Map getOverwrittenCatalogNameMap();
069:
070: /** Returns a flag indicating if the user wants to overwrite schema names
071: *
072: * @return flag indicating if the user wants to overwrite the schema name
073: */
074: public boolean isSchemaNameOverwritten();
075:
076: /** Gets the map of schema names to be replaced with
077: * In the map, key will have the old name, and value will
078: * be the new name
079: *
080: * @return the Map of overwritten schema names
081: */
082: public Map getOverwrittenSchemaNameMap();
083:
084: /** Returns the driver class name for Driver Manager
085: *
086: * @return the driver class name
087: */
088: public String getDriverClassName();
089:
090: /** Returns the user ID
091: *
092: * @return the user ID
093: */
094: public String getUserId();
095:
096: /** Returns the password
097: *
098: * @return the password
099: */
100: public String getPassword();
101:
102: /** Returns a well formed database URL
103: *
104: * @return the well formed database URL
105: */
106: public String getUrl();
107:
108: /** Returns additional database driver properties
109: *
110: * @return the additional driver properties if any
111: */
112: public Properties getDriverProperties();
113:
114: }
|