net.sourceforge.squirrel_sql.fw.sql.DatabaseObjectInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fw Show documentation
Show all versions of fw Show documentation
The framework library contains utility classes that are generic and useful for building applications
that introspect a database via JDBC. These are not intended to be SQuirreLSQL-specific and could be
used by other projects JDBC front-end applications. This project is guaranteed to have no code
dependencies on other SQuirreLSQL projects and could therefore be used when building a different
JDBC front-end application.
package net.sourceforge.squirrel_sql.fw.sql;
/*
* Copyright (C) 2001-2004 Colin Bell
* [email protected]
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
import java.io.Serializable;
import java.sql.SQLException;
import net.sourceforge.squirrel_sql.fw.dialects.DialectFactory;
import org.apache.commons.lang.StringUtils;
public class DatabaseObjectInfo implements IDatabaseObjectInfo, Serializable
{
/** Property names for this bean. */
public interface IPropertyNames
{
/** Catalog name. */
String CATALOG_NAME = "catalogName";
/** Schema name. */
String SCHEMA_NAME = "schemaName";
/** Simple name. */
String SIMPLE_NAME = "simpleName";
/** Qualified name. */
String QUALIFIED_NAME = "qualifiedName";
}
/** Catalog name. Can be null */
private final String _catalog;
/** Schema name. Can be null */
private final String _schema;
/** Simple object name. */
private final String _simpleName;
/** Fully qualified name for this object. */
private final String _qualifiedName;
/** Object type. @see DatabaseObjectType.*/
private DatabaseObjectType _dboType = DatabaseObjectType.OTHER;
public DatabaseObjectInfo(String catalog, String schema, String simpleName,
DatabaseObjectType dboType, ISQLDatabaseMetaData md)
{
super();
if (dboType == null)
{
throw new IllegalArgumentException("DatabaseObjectType == null");
}
if (md == null)
{
throw new IllegalArgumentException("SQLDatabaseMetaData == null");
}
_catalog = catalog;
_schema = schema;
_simpleName = simpleName;
_qualifiedName = generateQualifiedName(md);
_dboType = dboType;
}
/**
* Default constructor for using instances of this class to contain
* information about new objects that will be created soon.
*/
public DatabaseObjectInfo(String catalog, String schema, String simpleName) {
_catalog = catalog;
_schema = schema;
_simpleName = simpleName;
_qualifiedName = simpleName;
}
public String toString()
{
return getSimpleName();
}
public String getCatalogName()
{
return _catalog;
}
public String getSchemaName()
{
return _schema;
}
public String getSimpleName()
{
return _simpleName;
}
public String getQualifiedName()
{
return _qualifiedName;
}
public DatabaseObjectType getDatabaseObjectType()
{
return _dboType;
}
protected String generateQualifiedName(ISQLConnection conn)
{
return generateQualifiedName(conn.getSQLMetaData());
}
/**
* Informix represents database objects in catalogs *and* schemas. So a table
* called might be found in the catalog, which lives in
* the schema and is addressed as:
*
* :"".
*
* It may also be referred to as simply
*
* This method returns a qualifed name that meets this criteria.
*
* @return a valid Informix qualified name - if catalog *and* schema are not
* null/empty, this returns the database object name such as
* catalog:schema.simpleName. However, if either catalog or schema
* (or both) are null, this simply returns the simpleName
*/
private String getInformixQualifiedName() {
StringBuilder result = new StringBuilder();
if (_catalog != null && _schema != null) {
result.append(_catalog);
result.append(":");
result.append("\"");
result.append(_schema);
result.append("\"");
result.append(".");
}
result.append(_simpleName);
return result.toString();
}
private String getProgressQualifiedName() {
StringBuilder result = new StringBuilder();
if (_schema != null) {
result.append(_schema);
result.append(".");
}
result.append(_simpleName);
return result.toString();
}
/**
* Generates the qualified name (for example, "SCHEMA.SIMPLENAME"). This is highly database specific and
* should probably be moved into the dialects.
*
* @TODO Break out the dialect-specific logic into the dialects. Allow for the default parts of the
* algorithm below to be used when a dialect is unavailable.
*
* @param md
* @return
*/
protected String generateQualifiedName(final ISQLDatabaseMetaData md)
{
String catSep = null;
String identifierQuoteString = null;
boolean supportsSchemasInDataManipulation = false;
boolean supportsCatalogsInDataManipulation = false;
boolean supportsSchemasInTableDefinitions = false;
// check for Informix - it has very "special" qualified names
if (DialectFactory.isInformix(md)) {
return getInformixQualifiedName();
}
// Progress claims to support catalogs in data manip - but it actually doesn't honor that claim.
if (DialectFactory.isProgress(md)) {
return getProgressQualifiedName();
}
try
{
supportsSchemasInDataManipulation = md.supportsSchemasInDataManipulation();
}
catch (SQLException ignore)
{
// Ignore.
}
try
{
supportsCatalogsInDataManipulation = md.supportsCatalogsInDataManipulation();
}
catch (SQLException ignore)
{
// Ignore.
}
try
{
supportsSchemasInTableDefinitions = md.supportsSchemasInTableDefinitions();
} catch (SQLException ignore)
{
// Ignore.
}
try
{
catSep = md.getCatalogSeparator();
}
catch (SQLException ignore)
{
// Ignore.
}
if (StringUtils.isEmpty(catSep))
{
catSep = ".";
}
try
{
identifierQuoteString = md.getIdentifierQuoteString();
if (identifierQuoteString != null
&& identifierQuoteString.equals(" "))
{
identifierQuoteString = null;
}
}
catch (SQLException ignore)
{
// Ignore.
}
if (DialectFactory.isSyBase(md)) {
identifierQuoteString =
checkSybaseIdentifierQuoteString(md, identifierQuoteString);
}
StringBuilder buf = new StringBuilder();
if (supportsCatalogsInDataManipulation
&& !StringUtils.isEmpty(_catalog))
{
if (identifierQuoteString != null)
{
buf.append(identifierQuoteString);
}
buf.append(_catalog);
if (identifierQuoteString != null)
{
buf.append(identifierQuoteString);
}
buf.append(catSep);
}
if (shouldQualifyWithSchema(supportsSchemasInDataManipulation, supportsSchemasInTableDefinitions, md))
{
if (identifierQuoteString != null)
{
buf.append(identifierQuoteString);
}
buf.append(_schema);
if (identifierQuoteString != null)
{
buf.append(identifierQuoteString);
}
buf.append(catSep);
}
if (identifierQuoteString != null)
{
buf.append(identifierQuoteString);
}
String quoteExpandedName = SQLUtilities.quoteIdentifier(_simpleName);
buf.append(quoteExpandedName);
if (identifierQuoteString != null)
{
buf.append(identifierQuoteString);
}
return buf.toString();
}
private boolean shouldQualifyWithSchema(final boolean supportsSchemasInDataManipulation, final boolean supportsSchemasInTableDefinitions,
final ISQLDatabaseMetaData md) {
if (_schema == null || _schema.length() == 0) {
return false;
}
if (supportsSchemasInDataManipulation) {
return true;
}
if (this._dboType == DatabaseObjectType.TABLE) {
if (supportsSchemasInTableDefinitions) {
return true;
}
}
// Always qualify table name for HSQL - Bug 1596240 HSQLDB->Objects->Content. Cannot detect if table
// like above, since objects in HSQLDB's INFORMATION_SCHEMA under "SYSTEM TABLE" node have a database
// object type of "OTHER", instead of "TABLE".
//
if (DialectFactory.isHSQL(md)) {
return true;
}
return false;
}
/**
* Checks for the presence of Sybase 12.x and if found, sets the identifier
* quote string to empty string. See bug:
*
* [ 1848924 ] Sybase object browser contents not displayed
*
* for more details.
*
* @param md the database metadata
* @param quoteString the identifer quote string that the driver reported.
* @return the same identifier quote string specified if not 12.x; otherwise
* empty string is returned.
*/
private String checkSybaseIdentifierQuoteString(
final ISQLDatabaseMetaData md, final String quoteString)
{
String result = quoteString;
String productName = null;
CharSequence sybaseTwelveVersionId = "12.";
try {
productName = md.getDatabaseProductVersion();
} catch (SQLException e) {
// ignore
}
if (productName != null) {
if (productName.contains(sybaseTwelveVersionId)) {
result = "";
}
}
return result;
}
public boolean equals(Object obj)
{
if (obj == null) {
return false;
}
if (obj.getClass() == this.getClass())
{
DatabaseObjectInfo info = (DatabaseObjectInfo) obj;
if ((info._catalog == null && _catalog == null)
|| ((info._catalog != null && _catalog != null)
&& info._catalog.equals(_catalog)))
{
if ((info._qualifiedName == null && _qualifiedName == null)
|| ((info._qualifiedName != null && _qualifiedName != null)
&& info._qualifiedName.equals(_qualifiedName)))
{
if ((info._schema == null && _schema == null)
|| ((info._schema != null && _schema != null)
&& info._schema.equals(_schema)))
{
return (
(info._simpleName == null && _simpleName == null)
|| ((info._simpleName != null
&& _simpleName != null)
&& info._simpleName.equals(_simpleName)));
}
}
}
}
return false;
}
public int hashCode()
{
return _qualifiedName.hashCode();
}
public int compareTo(IDatabaseObjectInfo o)
{
return _qualifiedName.compareTo(o.getQualifiedName());
}
public void replaceDatabaseObjectTypeConstantObjectsByConstantObjectsOfThisVM(DatabaseObjectType type)
{
_dboType = type;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy