SQLDatabaseMetaData.java
| Index Score | ||
|---|---|---|
 |
 |
net.sourceforge.squirrel_sql.fw.sql |
 |
 |
Squirrel SQL |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| RETURNS | Number of return points from functions |  |
| INTERFACE_COMPLEXITY | Interface complexity | |
| JAVA0143 | JAVA0143 Synchronized method | |
| SIZE | Size of the file in bytes | |
| DECL_COMMENTS | Comments in declarations | |
| LOC | Lines of code | |
| OPERATORS | Number of operators | |
| ELOC | Effective lines of code | |
| PROGRAM_LENGTH | Halstead program length | |
| LINES | Number of lines in the source file | |
| EXITS | Procedure exits | |
| BLOCKS | Number of blocks | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| CYCLOMATIC | Cyclomatic complexity | |
| UNIQUE_OPERANDS | Number of unique operands | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| FUNCTIONS | Number of function declarations | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| COMPARISONS | Number of comparison operators | |
| COMMENTS | Comment lines | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| BLOCK_COMMENT | Number of block comment lines | |
| LOOPS | Number of loops | |
| LINE_COMMENT | Number of line comments | |
| PARAMS | Number of formal parameter declarations | |
| EXEC_COMMENTS | Comments in executable code | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0076 | JAVA0076 Use of magic number | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0020 | JAVA0020 Field name does not have required form | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| JAVA0283 | JAVA0283 Control variable not updated in loop body | |
| NEST_DEPTH | Maximum nesting depth | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0171 | JAVA0171 Unused local variable | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
package net.sourceforge.squirrel_sql.fw.sql;
/*
* Copyright (C) 2002-2003 Colin Bell
* colbell@users.sourceforge.net
*
* 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.sql.DatabaseMetaData;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TreeMap;
import java.util.TreeSet;
import net.sourceforge.squirrel_sql.fw.datasetviewer.DataSetException;
import net.sourceforge.squirrel_sql.fw.datasetviewer.DatabaseTypesDataSet;
import net.sourceforge.squirrel_sql.fw.datasetviewer.IDataSet;
import net.sourceforge.squirrel_sql.fw.datasetviewer.ResultSetDataSet;
import net.sourceforge.squirrel_sql.fw.dialects.DialectFactory;
import net.sourceforge.squirrel_sql.fw.dialects.DialectType;
import net.sourceforge.squirrel_sql.fw.sql.dbobj.BestRowIdentifier;
import net.sourceforge.squirrel_sql.fw.util.log.ILogger;
import net.sourceforge.squirrel_sql.fw.util.log.LoggerController;
/**
* This class represents the metadata for a database. It is essentially
* a wrapper around <TT>java.sql.DatabaseMetaData</TT>.
*
* <P>Some data can be cached on the first retrieval in order to speed up
* subsequent retrievals. To clear this cache call <TT>clearCache()</TT>.
*
* <P>From the JavaDoc for <TT>java.sql.DatabaseMetaData</TT>. "Some
* methods take arguments that are String patterns. These arguments all
* have names such as fooPattern. Within a pattern String, "%" means match any
* substring of 0 or more characters, and "_" means match any one character. Only
* metadata entries matching the search pattern are returned. If a search pattern
* argument is set to null, that argument's criterion will be dropped from the
* search."
*
* <P>Additionally, it should be noted that some JDBC drivers (like Oracle) do
* not handle multi-threaded access to methods that return ResultSets very well.
* It is therefore highly recommended that methods in this class that return
* a ResultSet, should not be called outside of this class where this class'
* monitor has no jurisdiction. Furthermore, methods that are meant to be
* called externally that create a ResultSet should package the data in some
* container object structure for use by the caller, and should always be
* synchronized on this class' monitor.
*
*
* @author <A HREF="mailto:colbell@users.sourceforge.net">Colin Bell</A>
*/
public class SQLDatabaseMetaData implements ISQLDatabaseMetaData
{
/** Logger for this class. */
private final static ILogger s_log =
LoggerController.createLogger(SQLDatabaseMetaData.class);
/**
* Full or partial names of various JDBC driivers that can be matched
* to <tt>getDriverName()</tt>.
*/
private interface IDriverNames
{
String AS400 = "AS/400 Toolbox for Java JDBC Driver";
/* work-around for bug which means we must use "dbo" for schema */
String FREE_TDS = "InternetCDS Type 4 JDBC driver for MS SQLServer";
String OPTA2000 = "i-net OPTA 2000";
}
public static class DriverMatch
{
private static final String COM_HTTX_DRIVER_PREFIX = "com.hxtt.sql.";
public static boolean isComHttxDriver(ISQLConnection con)
{
if(null == con)
{
return false;
}
return con.getSQLDriver().getDriverClassName().startsWith(COM_HTTX_DRIVER_PREFIX);
}
}
/** Connection to database this class is supplying information for. */
private ISQLConnection _conn;
/**
* Cache of commonly accessed metadata properties keyed by the method
* name that attempts to retrieve them.
* Note, this cache should only be used for metadata that are not
* likely to be changed during an open Session.
* Meta data that is likely to be changed should be kept in SchemaInfo.
*/
private Map<String, Object> _cache =
Collections.synchronizedMap(new HashMap<String, Object>());
/**
* If previous attempts to getSuperTables fail, then this will be set to
* false, and prevent further attempts.
*/
private boolean supportsSuperTables = true;
/**
* ctor specifying the connection that we are retrieving metadata for.
*
* @param conn Connection to database.
*
* @throws IllegalArgumentException
* Thrown if null SQLConnection passed.
*/
SQLDatabaseMetaData(ISQLConnection conn)
{
super();
if (conn == null)
{
throw new IllegalArgumentException("SQLDatabaseMetaData == null");
}
_conn = conn;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getUserName()
*/
public synchronized String getUserName() throws SQLException
{
final String key = "getUserName";
String value = (String)_cache.get(key);
if (value == null)
{
value = privateGetJDBCMetaData().getUserName();
_cache.put(key, value);
}
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getDatabaseProductName()
*/
public synchronized String getDatabaseProductName()
throws SQLException
{
final String key = "getDatabaseProductName";
String value = (String)_cache.get(key);
if (value == null)
{
value = privateGetJDBCMetaData().getDatabaseProductName();
_cache.put(key, value);
}
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getDatabaseProductVersion()
*/
public synchronized String getDatabaseProductVersion()
throws SQLException
{
final String key = "getDatabaseProductVersion";
String value = (String)_cache.get(key);
if (value == null)
{
value = privateGetJDBCMetaData().getDatabaseProductVersion();
_cache.put(key, value);
}
return value;
}
public synchronized int getDatabaseMajorVersion()
throws SQLException
{
final String key = "getDatabaseMajorVersion";
Integer value = (Integer)_cache.get(key);
if (value == null)
{
value = privateGetJDBCMetaData().getDatabaseMajorVersion();
_cache.put(key, value);
}
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getDriverName()
*/
public synchronized String getDriverName() throws SQLException
{
final String key = "getDriverName";
String value = (String)_cache.get(key);
if (value == null)
{
value = privateGetJDBCMetaData().getDriverName();
_cache.put(key, value);
}
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getJDBCVersion()
*/
public int getJDBCVersion() throws SQLException
{
final String key = "getJDBCVersion";
Integer value = (Integer)_cache.get(key);
if (value == null)
{
DatabaseMetaData md = privateGetJDBCMetaData();
int major = md.getJDBCMajorVersion();
int minor = md.getJDBCMinorVersion();
int vers = (major * 100) + minor;
value = Integer.valueOf(vers);
_cache.put(key, value);
}
return value.intValue();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getIdentifierQuoteString()
*/
public synchronized String getIdentifierQuoteString() throws SQLException
{
final String key = "getIdentifierQuoteString";
String value = (String)_cache.get(key);
if (value == null)
{
value = privateGetJDBCMetaData().getIdentifierQuoteString();
if (value == null) {
value = "";
}
_cache.put(key, value);
}
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getCascadeClause()
*/
public synchronized String getCascadeClause() throws SQLException {
final String key = "getCascadeClause";
String value = (String)_cache.get(key);
if (value == null)
{
if (DialectFactory.isDB2(this) || DialectFactory.isOracle(this))
{
value = "CASCADE";
}
else
{
value = "";
}
_cache.put(key, value);
}
return value;
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getSchemas()
*/
public synchronized String[] getSchemas() throws SQLException {
boolean hasGuest = false;
boolean hasSysFun = false;
final boolean isMSSQLorSYBASE = DialectFactory.isSyBase(this)
|| DialectFactory.isMSSQLServer(this);
final boolean isDB2 = DialectFactory.isDB2(this);
final ArrayList<String> list = new ArrayList<String>();
ResultSet rs = privateGetJDBCMetaData().getSchemas();
try {
if (rs != null) {
DialectType dialectType = DialectFactory.getDialectType(this);
final ResultSetReader rdr = new ResultSetReader(rs, dialectType);
Object[] row = null;
while ((row = rdr.readRow()) != null) {
if (isMSSQLorSYBASE && row[0].equals("guest")) {
hasGuest = true;
}
if (isDB2 && row[0].equals("SYSFUN")) {
hasSysFun = true;
}
list.add((String) row[0]);
}
}
} finally {
close(rs);
}
// Some drivers for both MS SQL and Sybase don't return guest as
// a schema name.
if (isMSSQLorSYBASE && !hasGuest) {
list.add("guest");
}
// Some drivers for DB2 don't return SYSFUN as a schema name. A
// number of system stored procs are kept in this schema.
if (isDB2 && !hasSysFun) {
list.add("SYSFUN");
}
return list.toArray(new String[list.size()]);
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsSchemas()
*/
public boolean supportsSchemas() throws SQLException
{
return supportsSchemasInDataManipulation()
|| supportsSchemasInTableDefinitions();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsSchemasInDataManipulation()
*/
public synchronized boolean supportsSchemasInDataManipulation()
throws SQLException
{
final String key = "supportsSchemasInDataManipulation";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
try
{
value = Boolean.valueOf(privateGetJDBCMetaData().supportsSchemasInDataManipulation());
}
catch (SQLException ex)
{
boolean isSQLServer =
DialectFactory.isSyBase(this) || DialectFactory.isMSSQLServer(this);
if (isSQLServer)
{
value = Boolean.TRUE;
_cache.put(key, value);
}
throw ex;
}
_cache.put(key, value);
return value.booleanValue();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsSchemasInTableDefinitions()
*/
public synchronized boolean supportsSchemasInTableDefinitions()
throws SQLException
{
final String key = "supportsSchemasInTableDefinitions";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
try
{
value = Boolean.valueOf(privateGetJDBCMetaData().supportsSchemasInTableDefinitions());
}
catch (SQLException ex)
{
boolean isSQLServer =
DialectFactory.isSyBase(this) || DialectFactory.isMSSQLServer(this);
if (isSQLServer)
{
value = Boolean.TRUE;
_cache.put(key, value);
}
throw ex;
}
_cache.put(key, value);
return value.booleanValue();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsStoredProcedures()
*/
public synchronized boolean supportsStoredProcedures() throws SQLException
{
final String key = "supportsStoredProcedures";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
// PostgreSQL (at least 7.3.2) returns false for
// supportsStoredProcedures() even though it does support them.
if (DialectFactory.isPostgreSQL(this))
{
value = Boolean.TRUE;
}
else
{
value = Boolean.valueOf(privateGetJDBCMetaData().supportsStoredProcedures());
}
_cache.put(key, value);
return value.booleanValue();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsSavepoints()
*/
public synchronized boolean supportsSavepoints() throws SQLException {
final String key = "supportsSavepoints";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
value = Boolean.valueOf(privateGetJDBCMetaData().supportsSavepoints());
_cache.put(key, value);
return value.booleanValue();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsResultSetType(int)
*/
public synchronized boolean supportsResultSetType(int type)
throws SQLException
{
final String key = "supportsResultSetType";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
value = Boolean.valueOf(privateGetJDBCMetaData().supportsResultSetType(type));
_cache.put(key, value);
return value.booleanValue();
}
/* Not cached.
* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getCatalogs()
*/
public synchronized String[] getCatalogs() throws SQLException
{
final ArrayList<String> list = new ArrayList<String>();
ResultSet rs = privateGetJDBCMetaData().getCatalogs();
try
{
if (rs != null) {
DialectType dialectType = DialectFactory.getDialectType(this);
final ResultSetReader rdr = new ResultSetReader(rs, dialectType);
Object[] row = null;
while ((row = rdr.readRow()) != null)
{
if (row != null && row[0] != null) {
list.add(row[0].toString());
}
}
}
}
finally
{
close(rs);
}
return list.toArray(new String[list.size()]);
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getURL()
*/
public synchronized String getURL() throws SQLException {
final String key = "getURL";
String value = (String)_cache.get(key);
if (value != null) {
return value;
}
value = privateGetJDBCMetaData().getURL();
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getCatalogTerm()
*/
public synchronized String getCatalogTerm() throws SQLException {
final String key = "getCatalogTerm";
String value = (String)_cache.get(key);
if (value != null) {
return value;
}
value = privateGetJDBCMetaData().getCatalogTerm();
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getSchemaTerm()
*/
public synchronized String getSchemaTerm() throws SQLException {
final String key = "getSchemaTerm";
String value = (String)_cache.get(key);
if (value != null) {
return value;
}
value = privateGetJDBCMetaData().getSchemaTerm();
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getProcedureTerm()
*/
public synchronized String getProcedureTerm() throws SQLException {
final String key = "getProcedureTerm";
String value = (String)_cache.get(key);
if (value != null) {
return value;
}
value = privateGetJDBCMetaData().getProcedureTerm();
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getCatalogSeparator()
*/
public synchronized String getCatalogSeparator() throws SQLException
{
final String key = "getCatalogSeparator";
String value = (String)_cache.get(key);
if (value != null)
{
return value;
}
value = privateGetJDBCMetaData().getCatalogSeparator();
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsCatalogs()
*/
public boolean supportsCatalogs() throws SQLException
{
return supportsCatalogsInTableDefinitions()
|| supportsCatalogsInDataManipulation()
|| supportsCatalogsInProcedureCalls();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsCatalogsInTableDefinitions()
*/
public synchronized boolean supportsCatalogsInTableDefinitions() throws SQLException
{
final String key = "supportsCatalogsInTableDefinitions";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
try
{
value = Boolean.valueOf(privateGetJDBCMetaData().supportsCatalogsInTableDefinitions());
}
catch (SQLException ex)
{
boolean isSQLServer =
DialectFactory.isSyBase(this) || DialectFactory.isMSSQLServer(this);
if (isSQLServer)
{
value = Boolean.TRUE;
_cache.put(key, value);
}
throw ex;
}
_cache.put(key, value);
return value.booleanValue();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsCatalogsInDataManipulation()
*/
public synchronized boolean supportsCatalogsInDataManipulation() throws SQLException
{
final String key = "supportsCatalogsInDataManipulation";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
try
{
value = Boolean.valueOf(privateGetJDBCMetaData().supportsCatalogsInDataManipulation());
}
catch (SQLException ex)
{
boolean isSQLServer =
DialectFactory.isSyBase(this) || DialectFactory.isMSSQLServer(this);
if (isSQLServer)
{
value = Boolean.TRUE;
_cache.put(key, value);
}
throw ex;
}
_cache.put(key, value);
return value.booleanValue();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsCatalogsInProcedureCalls()
*/
public synchronized boolean supportsCatalogsInProcedureCalls() throws SQLException
{
final String key = "supportsCatalogsInProcedureCalls";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
try
{
value = Boolean.valueOf(privateGetJDBCMetaData().supportsCatalogsInProcedureCalls());
}
catch (SQLException ex)
{
boolean isSQLServer =
DialectFactory.isSyBase(this) || DialectFactory.isMSSQLServer(this);
if (isSQLServer)
{
value = Boolean.TRUE;
_cache.put(key, value);
}
throw ex;
}
_cache.put(key, value);
return value.booleanValue();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getJDBCMetaData()
*/
public synchronized DatabaseMetaData getJDBCMetaData() throws SQLException
{
return privateGetJDBCMetaData();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getMetaDataSet()
*/
public synchronized IDataSet getMetaDataSet() throws SQLException {
return new MetaDataDataSet(privateGetJDBCMetaData());
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getTypeInfo()
*
* @deprecated Replaced by getDataTypes
*/
public ResultSet getTypeInfo() throws SQLException
{
return privateGetJDBCMetaData().getTypeInfo();
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getTypesDataSet()
*/
public synchronized IDataSet getTypesDataSet() throws DataSetException {
ResultSet rs = null;
try {
rs = privateGetJDBCMetaData().getTypeInfo();
return (new DatabaseTypesDataSet(rs));
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getDataTypes()
*/
public synchronized DataTypeInfo[] getDataTypes()
throws SQLException
{
final DatabaseMetaData md = privateGetJDBCMetaData();
final ArrayList<DataTypeInfo> list = new ArrayList<DataTypeInfo>();
final ResultSet rs = md.getTypeInfo();
try
{
ResultSetColumnReader rdr = new ResultSetColumnReader(rs);
while (rdr.next())
{
final String typeName = rdr.getString(1);
final int dataType = rdr.getLong(2).intValue();
final int precis = rdr.getLong(3).intValue();
final String literalPrefix = rdr.getString(4);
final String literalSuffix = rdr.getString(5);
final String createParams = rdr.getString(6);
final int nullable = rdr.getLong(7).intValue();
final boolean caseSens = rdr.getBoolean(8).booleanValue();
final int searchable = rdr.getLong(9).intValue();
final boolean unsigned = rdr.getBoolean(10).booleanValue();
final boolean canBeMoney = rdr.getBoolean(11).booleanValue();
final boolean canBeAutoInc = rdr.getBoolean(12).booleanValue();
final String localTypeName = rdr.getString(13);
final int min = rdr.getLong(14).intValue();
final int max = rdr.getLong(15).intValue();
final int radix = rdr.getLong(18).intValue();
list.add(new DataTypeInfo(typeName, dataType, precis,
literalPrefix, literalSuffix,
createParams, nullable, caseSens,
searchable, unsigned, canBeMoney,
canBeAutoInc, localTypeName,
min, max, radix,
this));
}
}
finally
{
close(rs);
}
return list.toArray(new DataTypeInfo[list.size()]);
}
private void close(ResultSet rs)
{
try
{
if (rs != null)
{
rs.close();
}
}
catch (Exception e)
{
s_log.info("closing resultset failed", e);
}
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getProcedures(java.lang.String, java.lang.String, java.lang.String, net.sourceforge.squirrel_sql.fw.sql.ProgressCallBack)
*/
public synchronized IProcedureInfo[] getProcedures(String catalog,
String schemaPattern,
String procedureNamePattern,
ProgressCallBack progressCallBack)
throws SQLException
{
DatabaseMetaData md = privateGetJDBCMetaData();
ArrayList<ProcedureInfo> list = new ArrayList<ProcedureInfo>();
ResultSet rs = md.getProcedures(catalog, schemaPattern, procedureNamePattern);
if (rs != null) {
int count = 0;
try
{
final int[] cols = new int[]{1, 2, 3, 7, 8};
DialectType dialectType = DialectFactory.getDialectType(this);
final ResultSetReader rdr = new ResultSetReader(rs, cols, dialectType);
Object[] row = null;
while ((row = rdr.readRow()) != null)
{
final int type = ((Number) row[4]).intValue();
ProcedureInfo pi = new ProcedureInfo(getAsString(row[0]), getAsString(row[1]),
getAsString(row[2]), getAsString(row[3]), type, this);
list.add(pi);
if (null != progressCallBack)
{
if(0 == count++ % 200 )
{
progressCallBack.currentlyLoading(pi.getSimpleName());
}
}
}
}
finally
{
close(rs);
}
}
return list.toArray(new IProcedureInfo[list.size()]);
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getTableTypes()
*/
public synchronized String[] getTableTypes() throws SQLException
{
final String key = "getTableTypes";
String[] value = (String[])_cache.get(key);
if (value != null)
{
return value;
}
final DatabaseMetaData md = privateGetJDBCMetaData();
// Use a set rather than a list as some combinations of MS SQL and the
// JDBC/ODBC return multiple copies of each table type.
final Set<String> tableTypes = new TreeSet<String>();
final ResultSet rs = md.getTableTypes();
if (rs != null)
{
try
{
while (rs.next())
{
tableTypes.add(rs.getString(1).trim());
}
}
finally
{
close(rs);
}
}
final String dbProductName = getDatabaseProductName();
final int nbrTableTypes = tableTypes.size();
// InstantDB (at least version 3.13) only returns "TABLES"
// for getTableTypes(). If you try to use this in a call to
// DatabaseMetaData.getTables() no tables will be found. For the
// moment hard code the types for InstantDB.
if (nbrTableTypes == 1 && dbProductName.equals("InstantDB"))
{
tableTypes.clear();
tableTypes.add("TABLE");
tableTypes.add("SYSTEM TABLE");
}
// At least one version of PostgreSQL through the JDBC/ODBC
// bridge returns an empty result set for the list of table
// types. Another version of PostgreSQL returns 6 entries
// of "SYSTEM TABLE" (which we have already filtered back to one).
else if (dbProductName.equals("PostgreSQL"))
{
if (nbrTableTypes == 0 || nbrTableTypes == 1)
{
if (s_log.isDebugEnabled()) {
s_log.debug("Detected PostgreSQL and "+nbrTableTypes+
" table types - overriding to 4 table types");
}
tableTypes.clear();
tableTypes.add("TABLE");
tableTypes.add("SYSTEM TABLE");
tableTypes.add("VIEW");
tableTypes.add("SYSTEM VIEW");
}
// Treating indexes as tables interferes with the operation of the
// PostgreSQL plugin
if (tableTypes.contains("INDEX")) {
tableTypes.remove("INDEX");
}
// Treating sequences as tables interferes with the operation of the
// PostgreSQL plugin
if (tableTypes.contains("SEQUENCE")) {
tableTypes.remove("SEQUENCE");
}
// There are many of these "tables", that PostgreSQL throws
// SQLExceptions for whenever a table-like operation is attempted.
if (tableTypes.contains("SYSTEM INDEX")) {
tableTypes.remove("SYSTEM INDEX");
}
}
// Informix: when no database is given in the connect url, then no table types are returned. The
// catalog can be changed which will select a database, but by that time it is too late.
else if (DialectFactory.getDialectType(this) == DialectType.INFORMIX) {
if (nbrTableTypes == 0) {
if (s_log.isDebugEnabled()) {
s_log.debug("Detected Informix with no table types returned. Defaulting to "
+ "TABLE | SYSTEM TABLE | VIEW");
}
tableTypes.add("TABLE");
tableTypes.add("SYSTEM TABLE");
tableTypes.add("VIEW");
}
}
value = tableTypes.toArray(new String[tableTypes.size()]);
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getTables(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], net.sourceforge.squirrel_sql.fw.sql.ProgressCallBack)
*/
public synchronized ITableInfo[] getTables(String catalog,
String schemaPattern,
String tableNamePattern,
String[] types,
ProgressCallBack progressCallBack)
throws SQLException
{
final DatabaseMetaData md = privateGetJDBCMetaData();
final String dbDriverName = getDriverName();
Set<ITableInfo> list = new TreeSet<ITableInfo>();
/* work-around for this driver, which must have "dbo" for schema. The
* JConnect family of drivers appears to not be affected and can accept a
* null schema, which is necessary to find tables in other schemas, within
* the same catalog. Similarly, jTDS 1.2.2 doesn't require this, yet it
* doesn't return non-dbo schema tables, unfortunately.
*/
if (dbDriverName.equals(IDriverNames.FREE_TDS) && schemaPattern == null)
{
schemaPattern = "dbo";
}
if (dbDriverName.equals(IDriverNames.AS400) && schemaPattern == null)
{
schemaPattern = "*ALLUSR";
}
//Add begin
if (catalog == null && DriverMatch.isComHttxDriver(_conn))
{
String[] catalogs=getCatalogs();
if (catalogs != null) {
for (int i = 0; i < catalogs.length; i++) {
ITableInfo[] tables = getTables(catalogs[i],
schemaPattern,
tableNamePattern,
types,
progressCallBack);
for(int j=0;j<tables.length;j++){
list.add(tables[j]);
}
}
return list.toArray(new ITableInfo[list.size()]);
}
}
//Add end
Map<String, ITableInfo> nameMap = null;
ResultSet superTabResult = null;
ResultSet tabResult = null;
try
{
if (supportsSuperTables) {
try
{
superTabResult = md.getSuperTables(catalog,
schemaPattern,
tableNamePattern);
// create a mapping of names if we have supertable info, since
// we need to find the ITableInfo again for re-ordering.
if (superTabResult != null && superTabResult.next())
{
nameMap = new HashMap<String, ITableInfo>();
}
}
catch (Throwable th)
{
s_log.debug("DBMS/Driver doesn't support getSupertables(): "+
th.getMessage());
supportsSuperTables = false;
}
}
// store all plain table info we have.
tabResult = md.getTables(catalog, schemaPattern, tableNamePattern, types);
int count = 0;
while (tabResult != null && tabResult.next())
{
ITableInfo tabInfo = new TableInfo(tabResult.getString(1),
tabResult.getString(2), tabResult.getString(3),
tabResult.getString(4), tabResult.getString(5),
this);
if (nameMap != null)
{
nameMap.put(tabInfo.getSimpleName(), tabInfo);
}
list.add(tabInfo);
if (null != progressCallBack)
{
if (0 == count++ % 100)
{
progressCallBack.currentlyLoading(tabInfo.getSimpleName());
}
}
}
// re-order nodes if the tables are stored hierachically
if (nameMap != null)
{
do
{
String tabName = superTabResult.getString(3);
TableInfo tabInfo = (TableInfo) nameMap.get(tabName);
if (tabInfo == null)
continue;
String superTabName = superTabResult.getString(4);
if (superTabName == null)
continue;
TableInfo superInfo = (TableInfo) nameMap.get(superTabName);
if (superInfo == null)
continue;
superInfo.addChild(tabInfo);
list.remove(tabInfo); // remove from toplevel.
if (null != progressCallBack)
{
if (0 == count++ % 20)
{
progressCallBack.currentlyLoading(tabInfo.getSimpleName());
}
}
}
while (superTabResult.next());
}
}
finally
{
close(tabResult);
close(superTabResult);
}
return list.toArray(new ITableInfo[list.size()]);
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getUDTs(java.lang.String, java.lang.String, java.lang.String, int[])
*/
public synchronized IUDTInfo[] getUDTs(String catalog, String schemaPattern,
String typeNamePattern, int[] types)
throws SQLException
{
DatabaseMetaData md = privateGetJDBCMetaData();
ArrayList<UDTInfo> list = new ArrayList<UDTInfo>();
checkForInformix(catalog);
ResultSet rs = md.getUDTs(catalog, schemaPattern, typeNamePattern, types);
try
{
final int[] cols = new int[] {1, 2, 3, 4, 5, 6};
DialectType dialectType = DialectFactory.getDialectType(this);
final ResultSetReader rdr = new ResultSetReader(rs, cols, dialectType);
Object[] row = null;
while ((row = rdr.readRow()) != null)
{
list.add(new UDTInfo(getAsString(row[0]), getAsString(row[1]), getAsString(row[2]),
getAsString(row[3]), getAsString(row[4]), getAsString(row[5]),
this));
}
}
finally
{
close(rs);
}
return list.toArray(new IUDTInfo[list.size()]);
}
/**
* If we are connected to Informix, then we may need to cleanup
* @param catalogName
*/
private void checkForInformix(String catalogName)
{
if (DialectFactory.getDialectType(this) != DialectType.INFORMIX) {
return;
}
Statement stmt = null;
String sql = "DATABASE " + catalogName;
try
{
stmt = _conn.createStatement();
stmt.execute("Drop procedure mode_decode");
} catch (SQLException e)
{
// The mode_decode routine may or may not be there. We don't care if it is not there, but log an
// info if we failed to drop it for some other reason.
s_log.info("setInformixCatalog: unable to drop procedure mode_decode: " + e.getMessage(), e);
} finally
{
SQLUtilities.closeStatement(stmt);
}
}
private String getAsString(Object val)
{
if(null == val)
{
return null;
}
else
{
if (val instanceof String) {
return (String)val;
} else {
return "" + val;
}
}
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getNumericFunctions()
*/
public synchronized String[] getNumericFunctions() throws SQLException
{
final String key = "getNumericFunctions";
String[] value = (String[])_cache.get(key);
if (value != null)
{
return value;
}
value = makeArray(privateGetJDBCMetaData().getNumericFunctions());
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getStringFunctions()
*/
public synchronized String[] getStringFunctions() throws SQLException
{
final String key = "getStringFunctions";
String[] value = (String[])_cache.get(key);
if (value != null)
{
return value;
}
value = makeArray(privateGetJDBCMetaData().getStringFunctions());
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getSystemFunctions()
*/
public synchronized String[] getSystemFunctions() throws SQLException
{
final String key = "getSystemFunctions";
String[] value = (String[])_cache.get(key);
if (value != null)
{
return value;
}
value = makeArray(privateGetJDBCMetaData().getSystemFunctions());
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getTimeDateFunctions()
*/
public synchronized String[] getTimeDateFunctions() throws SQLException
{
final String key = "getTimeDateFunctions";
String[] value = (String[])_cache.get(key);
if (value != null)
{
return value;
}
value = makeArray(privateGetJDBCMetaData().getTimeDateFunctions());
_cache.put(key, value);
return value;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getSQLKeywords()
*/
public synchronized String[] getSQLKeywords() throws SQLException
{
final String key = "getSQLKeywords";
String[] value = (String[])_cache.get(key);
if (value != null)
{
return value;
}
value = makeArray(privateGetJDBCMetaData().getSQLKeywords());
_cache.put(key, value);
return value;
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getBestRowIdentifier(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*/
public synchronized BestRowIdentifier[] getBestRowIdentifier(ITableInfo ti)
throws SQLException
{
final List<BestRowIdentifier> results =
new ArrayList<BestRowIdentifier>();
ResultSet rs = null;
try
{
rs = privateGetJDBCMetaData().getBestRowIdentifier(
ti.getCatalogName(), ti.getSchemaName(),
ti.getSimpleName(),
DatabaseMetaData.bestRowTransaction, true);
final String catalog = ti.getCatalogName();
final String schema = ti.getSchemaName();
final String table = ti.getSimpleName();
final ResultSetColumnReader rdr = new ResultSetColumnReader(rs);
while (rdr.next())
{
final BestRowIdentifier rid = new BestRowIdentifier(catalog,
schema, table, rdr.getLong(1).intValue(),
rdr.getString(2), rdr.getLong(3).shortValue(),
rdr.getString(4), rdr.getLong(5).intValue(),
rdr.getLong(7).shortValue(),
rdr.getLong(8).shortValue(), this);
results.add(rid);
}
}
finally
{
SQLUtilities.closeResultSet(rs);
}
final BestRowIdentifier[] ar = new BestRowIdentifier[results.size()];
return results.toArray(ar);
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getColumnPrivileges(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*
* @deprecated use getColumnPrivilegesDataSet instead.
*/
public ResultSet getColumnPrivileges(ITableInfo ti) throws SQLException {
// MM-MYSQL driver doesnt support null for column name.
final String columns = DialectFactory.isMySQL(this) ? "%" : null;
return privateGetJDBCMetaData().getColumnPrivileges(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName(),
columns);
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getColumnPrivilegesDataSet(net.sourceforge.squirrel_sql.fw.sql.ITableInfo,
* int[], boolean)
*/
public synchronized IDataSet getColumnPrivilegesDataSet(ITableInfo ti,
int[] columnIndices, boolean computeWidths) throws DataSetException {
ResultSet rs = null;
try {
DatabaseMetaData md = privateGetJDBCMetaData();
final String columns = DialectFactory.isMySQL(this) ? "%" : null;
rs = md.getColumnPrivileges(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName(),
columns);
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs,
columnIndices,
computeWidths,
DialectFactory.getDialectType(this));
return rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getExportedKeys(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*
* @deprecated. Replaced by getExportedKeysInfo
*/
public ResultSet getExportedKeys(ITableInfo ti) throws SQLException {
return privateGetJDBCMetaData().getExportedKeys(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getExportedKeysDataSet(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*/
public synchronized IDataSet getExportedKeysDataSet(ITableInfo ti)
throws DataSetException
{
ResultSet rs = null;
try {
rs = privateGetJDBCMetaData().getExportedKeys(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs, null, true, DialectFactory.getDialectType(this));
return rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getImportedKeys(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*
* @deprecated. Replaced by getImportedKeysInfo
*/
public ResultSet getImportedKeys(ITableInfo ti)
throws SQLException
{
return privateGetJDBCMetaData().getImportedKeys(
ti.getCatalogName(), ti.getSchemaName(),
ti.getSimpleName());
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getImportedKeysInfo(java.lang.String, java.lang.String, java.lang.String)
*/
public synchronized ForeignKeyInfo[] getImportedKeysInfo(String catalog,
String schema,
String tableName)
throws SQLException
{
ResultSet rs =
privateGetJDBCMetaData().getImportedKeys(catalog, schema, tableName);
return getForeignKeyInfo(rs);
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getImportedKeysInfo(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*/
public synchronized ForeignKeyInfo[] getImportedKeysInfo(ITableInfo ti)
throws SQLException
{
return getForeignKeyInfo(privateGetJDBCMetaData().getImportedKeys(ti.getCatalogName(),
ti.getSchemaName(), ti.getSimpleName()));
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getImportedKeysDataSet(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*/
public synchronized IDataSet getImportedKeysDataSet(ITableInfo ti)
throws DataSetException {
ResultSet rs = null;
try {
rs = privateGetJDBCMetaData().getImportedKeys(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs, null, true, DialectFactory.getDialectType(this));
return rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
/**
*
*
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getExportedKeysInfo(java.lang.String,
* java.lang.String, java.lang.String)
*/
public synchronized ForeignKeyInfo[] getExportedKeysInfo(String catalog,
String schema, String tableName) throws SQLException {
ResultSet rs = privateGetJDBCMetaData().getExportedKeys(catalog,
schema,
tableName);
return getForeignKeyInfo(rs);
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getExportedKeysInfo(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*/
public synchronized ForeignKeyInfo[] getExportedKeysInfo(ITableInfo ti)
throws SQLException
{
return getForeignKeyInfo(privateGetJDBCMetaData().getExportedKeys(ti.getCatalogName(),
ti.getSchemaName(), ti.getSimpleName()));
}
private ForeignKeyInfo[] getForeignKeyInfo(ResultSet rs)
throws SQLException
{
final Map<String, ForeignKeyInfo> keys =
new HashMap<String, ForeignKeyInfo>();
final Map<String, ArrayList<ForeignKeyColumnInfo>> columns =
new HashMap<String, ArrayList<ForeignKeyColumnInfo>>();
try
{
final ResultSetColumnReader rdr = new ResultSetColumnReader(rs);
while (rdr.next())
{
final ForeignKeyInfo fki = new ForeignKeyInfo(rdr.getString(1),
rdr.getString(2), rdr.getString(3), rdr.getString(4),
rdr.getString(5),rdr.getString(6), rdr.getString(7),
rdr.getString(8),
rdr.getLong(10).intValue(), rdr.getLong(11).intValue(),
rdr.getString(12), rdr.getString(13),
rdr.getLong(14).intValue(), null, this);
final String key = createForeignKeyInfoKey(fki);
if (!keys.containsKey(key))
{
keys.put(key, fki);
columns.put(key, new ArrayList<ForeignKeyColumnInfo>());
}
ForeignKeyColumnInfo fkiCol = new ForeignKeyColumnInfo(rdr.getString(8),
rdr.getString(8),
rdr.getLong(9).intValue());
columns.get(key).add(fkiCol);
}
}
finally
{
close(rs);
}
final ForeignKeyInfo[] results = new ForeignKeyInfo[keys.size()];
Iterator<ForeignKeyInfo> it = keys.values().iterator();
int idx = 0;
while (it.hasNext())
{
final ForeignKeyInfo fki = it.next();
final String key = createForeignKeyInfoKey(fki);
final List<ForeignKeyColumnInfo> colsList = columns.get(key);
final ForeignKeyColumnInfo[] fkiCol =
colsList.toArray(new ForeignKeyColumnInfo[colsList.size()]);
fki.setForeignKeyColumnInfo(fkiCol);
results[idx++] = fki;
}
return results;
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getIndexInfo(net.sourceforge.squirrel_sql.fw.sql.ITableInfo,
* int[], boolean)
*/
public synchronized ResultSetDataSet getIndexInfo(ITableInfo ti,
int[] columnIndices, boolean computeWidths) throws DataSetException {
ResultSet rs = null;
try {
rs = privateGetJDBCMetaData().getIndexInfo(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName(),
false,
true);
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs,
columnIndices,
computeWidths,
DialectFactory.getDialectType(this));
return rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
/**
* Returns a list of IndexInfos describing indexes for the specified table.
*
* @param ti the table to find all index information for.
* @return a list of IndexInfos
* @throws SQLException
*/
public List<IndexInfo> getIndexInfo(ITableInfo ti) throws SQLException {
List<IndexInfo> result = new ArrayList<IndexInfo>();
ResultSet rs = null;
try {
rs = privateGetJDBCMetaData().getIndexInfo(
ti.getCatalogName(), ti.getSchemaName(),
ti.getSimpleName(), false, true);
while (rs.next()) {
String catalog = rs.getString(1);
String schema = rs.getString(2);
String table = rs.getString(3);
boolean nonunique = rs.getBoolean(4);
String indexQualifier = rs.getString(5);
String indexName = rs.getString(6);
IndexInfo.IndexType indexType =
JDBCTypeMapper.getIndexType(rs.getShort(7));
short ordinalPosition = rs.getShort(8);
String column = rs.getString(9);
IndexInfo.SortOrder sortOrder =
JDBCTypeMapper.getIndexSortOrder(rs.getString(10));
int cardinality = rs.getInt(11);
int pages = rs.getInt(12);
String filterCondition = rs.getString(13);
IndexInfo indexInfo = new IndexInfo(catalog,
schema,
indexName,
table,
column,
nonunique,
indexQualifier,
indexType,
ordinalPosition,
sortOrder,
cardinality,
pages,
filterCondition,
this);
result.add(indexInfo);
}
} catch (SQLException e) {
} finally {
SQLUtilities.closeResultSet(rs);
}
return result;
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getPrimaryKeys(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*
* @deprecated use getPrimaryKey instead
*/
public ResultSet getPrimaryKeys(ITableInfo ti)
throws SQLException
{
return privateGetJDBCMetaData().getPrimaryKeys(
ti.getCatalogName(), ti.getSchemaName(),
ti.getSimpleName());
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getPrimaryKey(net.sourceforge.squirrel_sql.fw.sql.ITableInfo,
* int[], boolean)
*/
public synchronized IDataSet getPrimaryKey(ITableInfo ti,
int[] columnIndices, boolean computeWidths) throws DataSetException {
ResultSet rs = null;
try {
rs = privateGetJDBCMetaData().getPrimaryKeys(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs,
columnIndices,
computeWidths,
DialectFactory.getDialectType(this));
return rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
/*
* (non-Javadoc)
*
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getPrimaryKey(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*/
public synchronized PrimaryKeyInfo[] getPrimaryKey(ITableInfo ti)
throws SQLException
{
return getPrimaryKey(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getPrimaryKey(java.lang.String, java.lang.String, java.lang.String)
*/
public synchronized PrimaryKeyInfo[] getPrimaryKey(String catalog,
String schema,
String table)
throws SQLException
{
final List<PrimaryKeyInfo> results = new ArrayList<PrimaryKeyInfo>();
ResultSet rs = null;
try {
rs = privateGetJDBCMetaData().getPrimaryKeys(catalog, schema,table);
while (rs.next()) {
PrimaryKeyInfo pkInfo =
new PrimaryKeyInfo(rs.getString(1), // catalog
rs.getString(2), // schema
rs.getString(3), // tableName
rs.getString(4), // columnName
rs.getShort(5), // keySequence
rs.getString(6), // pkName
this);
results.add(pkInfo);
}
}finally {
SQLUtilities.closeResultSet(rs);
}
final PrimaryKeyInfo[] ar = new PrimaryKeyInfo[results.size()];
return results.toArray(ar);
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getProcedureColumns(net.sourceforge.squirrel_sql.fw.sql.IProcedureInfo)
*
* @deprecated use getProcedureColumnsDataSet instead
*/
public ResultSet getProcedureColumns(IProcedureInfo ti)
throws SQLException
{
return privateGetJDBCMetaData().getProcedureColumns(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName(),
"%");
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getProcedureColumnsDataSet(net.sourceforge.squirrel_sql.fw.sql.IProcedureInfo)
*/
public synchronized IDataSet getProcedureColumnsDataSet(IProcedureInfo ti)
throws DataSetException {
ResultSet rs = null;
try {
DatabaseMetaData md = privateGetJDBCMetaData();
rs = md.getProcedureColumns(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName(),
"%");
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs, DialectFactory.getDialectType(this));
return rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
/*
* (non-Javadoc)
*
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getTablePrivileges(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*
* @deprecated use getTablePrivilegesDataSet instead
*/
public ResultSet getTablePrivileges(ITableInfo ti)
throws SQLException
{
return privateGetJDBCMetaData().getTablePrivileges(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getTablePrivilegesDataSet(net.sourceforge.squirrel_sql.fw.sql.ITableInfo,
* int[], boolean)
*/
public synchronized IDataSet getTablePrivilegesDataSet(ITableInfo ti,
int[] columnIndices, boolean computeWidths) throws DataSetException {
ResultSet rs = null;
try {
DatabaseMetaData md = privateGetJDBCMetaData();
rs = md.getTablePrivileges(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs,
columnIndices,
computeWidths,
DialectFactory.getDialectType(this));
return rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
/*
* (non-Javadoc)
*
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getVersionColumns(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*
* @deprecated use getVersionColumnsDataSet instead
*/
public ResultSet getVersionColumns(ITableInfo ti)
throws SQLException
{
return privateGetJDBCMetaData().getVersionColumns(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getVersionColumnsDataSet(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*/
public synchronized IDataSet getVersionColumnsDataSet(ITableInfo ti)
throws DataSetException
{
ResultSet rs = null;
try {
DatabaseMetaData md = privateGetJDBCMetaData();
rs = md.getVersionColumns(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName());
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs, DialectFactory.getDialectType(this));
return rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
}
private ResultSet getColumns(ITableInfo ti)
throws SQLException
{
return privateGetJDBCMetaData().getColumns(ti.getCatalogName(),
ti.getSchemaName(),
ti.getSimpleName(), "%");
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getColumns(net.sourceforge.squirrel_sql.fw.sql.ITableInfo, int[], boolean)
*/
public synchronized IDataSet getColumns(ITableInfo ti, int[] columnIndices,
boolean computeWidths) throws DataSetException {
IDataSet result = null;
ResultSet rs = null;
try {
rs = getColumns(ti);
ResultSetDataSet rsds = new ResultSetDataSet();
rsds.setResultSet(rs,
columnIndices,
computeWidths,
DialectFactory.getDialectType(this));
result = rsds;
} catch (SQLException e) {
throw new DataSetException(e);
} finally {
SQLUtilities.closeResultSet(rs);
}
return result;
}
/*
* (non-Javadoc)
*
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getColumnInfo(java.lang.String,
* java.lang.String, java.lang.String)
*/
public synchronized TableColumnInfo[] getColumnInfo(String catalog,
String schema,
String table)
throws SQLException
{
ResultSet rs = null;
try
{
final Map<Integer, TableColumnInfo> columns =
new TreeMap<Integer, TableColumnInfo>();
DatabaseMetaData md = privateGetJDBCMetaData();
rs = md.getColumns(catalog, schema, table, "%");
final ResultSetColumnReader rdr = new ResultSetColumnReader(rs);
int index = 0;
while (rdr.next())
{
final TableColumnInfo tci =
new TableColumnInfo(rdr.getString(1), // TABLE_CAT
rdr.getString(2), // TABLE_SCHEM
rdr.getString(3), // TABLE_NAME
rdr.getString(4), // COLUMN_NAME
rdr.getLong(5).intValue(), // DATA_TYPE
rdr.getString(6), // TYPE_NAME
rdr.getLong(7).intValue(), // COLUMN_SIZE
rdr.getLong(9).intValue(), // DECIMAL_DIGITS
rdr.getLong(10).intValue(), // NUM_PREC_RADIX
rdr.getLong(11).intValue(), // NULLABLE
rdr.getString(12), // REMARKS
rdr.getString(13), // COLUMN_DEF
rdr.getLong(16).intValue(), // CHAR_OCTET_LENGTH
rdr.getLong(17).intValue(), // ORDINAL_POSITION
rdr.getString(18), // IS_NULLABLE
this);
////////////////////////////////////////////////////////////////////////////////////////////
// The index is needed in case this method is called with schema = null, catalog = null
// and two tables with the same name in different schemas/catalogs.
// Without the index the same ordinal position could only occur once.
++index;
//
////////////////////////////////////////////////////////////////////////////////////////////
columns.put(Integer.valueOf(10000 * tci.getOrdinalPosition() + index), tci);
}
return columns.values().toArray(new TableColumnInfo[columns.size()]);
}
finally
{
SQLUtilities.closeResultSet(rs);
}
}
/* (non-Javadoc)
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#getColumnInfo(net.sourceforge.squirrel_sql.fw.sql.ITableInfo)
*/
public synchronized TableColumnInfo[] getColumnInfo(ITableInfo ti)
throws SQLException
{
return getColumnInfo(ti.getCatalogName(), ti.getSchemaName(), ti.getSimpleName());
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#correctlySupportsSetMaxRows()
*/
public boolean correctlySupportsSetMaxRows() throws SQLException
{
return !IDriverNames.OPTA2000.equals(getDriverName());
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#supportsMultipleResultSets()
*/
public synchronized boolean supportsMultipleResultSets()
throws SQLException
{
final String key = "supportsMultipleResultSets";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
value = Boolean.valueOf(privateGetJDBCMetaData().supportsMultipleResultSets());
_cache.put(key, value);
return value.booleanValue();
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#storesUpperCaseIdentifiers()
*/
public synchronized boolean storesUpperCaseIdentifiers()
throws SQLException
{
final String key = "storesUpperCaseIdentifiers";
Boolean value = (Boolean)_cache.get(key);
if (value != null)
{
return value.booleanValue();
}
value = Boolean.valueOf(privateGetJDBCMetaData().storesUpperCaseIdentifiers());
_cache.put(key, value);
return value.booleanValue();
}
/**
* @see net.sourceforge.squirrel_sql.fw.sql.ISQLDatabaseMetaData#clearCache()
*/
public void clearCache()
{
_cache.clear();
}
/**
* Make a String array of the passed string. Commas separate the elements
* in the input string. The array is sorted.
*
* @param data Data to be split into the array.
*
* @return data as an array.
*/
private static String[] makeArray(String data)
{
if (data == null)
{
data = "";
}
final List<String> list = new ArrayList<String>();
final StringTokenizer st = new StringTokenizer(data, ",");
while (st.hasMoreTokens())
{
list.add(st.nextToken());
}
Collections.sort(list);
return list.toArray(new String[list.size()]);
}
/**
* Return the <TT>DatabaseMetaData</TT> object for this connection.
*
* @return The <TT>DatabaseMetaData</TT> object for this connection.
*
* @throws SQLException Thrown if an SQL error occurs.
*/
private DatabaseMetaData privateGetJDBCMetaData() throws SQLException
{
checkThread();
return _conn.getConnection().getMetaData();
}
/**
*
* @param fki
* @return
*/
private String createForeignKeyInfoKey(ForeignKeyInfo fki)
{
final StringBuffer buf = new StringBuffer();
buf.append(fki.getForeignKeyCatalogName())
.append(fki.getForeignKeySchemaName())
.append(fki.getForeignKeyTableName())
.append(fki.getForeignKeyName())
.append(fki.getPrimaryKeyCatalogName())
.append(fki.getPrimaryKeySchemaName())
.append(fki.getPrimaryKeyTableName())
.append(fki.getPrimaryKeyName());
return buf.toString();
}
/**
* Check the thread of the caller to see if it is the event dispatch thread
* and if we are debugging print a debug log message with the call trace.
*/
private void checkThread() {
/* This is extremely useful when trying to track down Swing UI freezing.
* However, it currently fills the log which obscures other debug
* messages even though UI performance is acceptable, so it is commented
* out until it is needed later.
if (s_log.isDebugEnabled() && SwingUtilities.isEventDispatchThread()) {
try {
throw new Exception("GUI Thread is doing database work");
} catch (Exception e) {
s_log.debug(e.getMessage(), e);
}
}
*/
}
}
The table below shows all metrics for SQLDatabaseMetaData.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 251.00 | Number of blocks | |
| BLOCK_COMMENT | 195.00 | Number of block comment lines | |
| COMMENTS | 397.00 | Comment lines | |
| COMMENT_DENSITY | 0.39 | Comment density | |
| COMPARISONS | 120.00 | Number of comparison operators | |
| CYCLOMATIC | 219.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 82.00 | Comments in declarations | |
| DOC_COMMENT | 163.00 | Number of javadoc comment lines | |
| ELOC | 1022.00 | Effective lines of code | |
| EXEC_COMMENTS | 21.00 | Comments in executable code | |
| EXITS | 189.00 | Procedure exits | |
| FUNCTIONS | 80.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 109.76 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 383.00 | Interface complexity | |
| JAVA0001 | 1.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 0.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 1.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 2.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 3.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 2.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 1.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 1.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 14.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 3.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 20.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 20.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 3.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 6.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 3.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 55.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 19.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 1764.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 2.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 1.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 1.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 1.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 1.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 2.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 1.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 3.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 2002.00 | Number of lines in the source file | |
| LINE_COMMENT | 39.00 | Number of line comments | |
| LOC | 1415.00 | Lines of code | |
| LOGICAL_LINES | 558.00 | Number of statements | |
| LOOPS | 17.00 | Number of loops | |
| NEST_DEPTH | 6.00 | Maximum nesting depth | |
| OPERANDS | 2873.00 | Number of operands | |
| OPERATORS | 5495.00 | Number of operators | |
| PARAMS | 67.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 8368.00 | Halstead program length | |
| PROGRAM_VOCAB | 803.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 316.00 | Number of return points from functions | |
| SIZE | 66960.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 746.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 57.00 | Number of unique operators | |
| WHITESPACE | 190.00 | Number of whitespace lines | |