net.sf.jailer.modelbuilder

Class JDBCMetaDataBasedModelElementFinder

java.lang.Object

net.sf.jailer.modelbuilder.JDBCMetaDataBasedModelElementFinder

All Implemented Interfaces:

ModelElementFinder

public class JDBCMetaDataBasedModelElementFinder
extends java.lang.Object
implements ModelElementFinder

Finds associations and tables by analyzing the JDBC meta data.

Author:

Ralf Wisser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JDBCMetaDataBasedModelElementFinder.PrivilegedSessionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static JDBCMetaDataBasedModelElementFinder.PrivilegedSessionProvider	privilegedSessionProvider
static java.util.Set<java.lang.String>	TYPES_WITH_LENGTH Set of sql types (uppercase) not listed in Types which needs a length argument.

Constructor Summary

Constructors

Constructor and Description
JDBCMetaDataBasedModelElementFinder()

Method Summary

Modifier and Type	Method and Description
static int	filterLength(int length, int precision, java.lang.String typeName, int type, DBMS dbms, int origLength) Filters the length attribute of a column in a DBMS specific way.
static int	filterPrecision(int length, int precision, java.lang.String typeName, int type, DBMS dbms, int origLength) Filters the precision attribute of a column in a DBMS specific way.
static java.lang.String	filterType(java.lang.String sqlType, int length, java.lang.String typeName, int type, DBMS dbms, int origLength) Filters the type attribute of a column in a DBMS specific way.
java.util.Collection<Association>	findAssociations(DataModel dataModel, java.util.Map<Association,java.lang.String[]> namingSuggestion, Session session, ExecutionContext executionContext) Finds associations by reading the databases meta-data.
java.util.List<Column>	findColumns(Table table, Session session, ExecutionContext executionContext) Finds the Columns of a given Table.
static java.util.Set<java.lang.String>	findPartitions(Session session, java.lang.String introspectionSchema)
java.util.Set<Table>	findTables(Session session, ExecutionContext executionContext) Finds all tables in DB schema.
static java.util.List<java.lang.String>	getCatalogsWithSchemas(Session session) Finds all catalogs with all schemas in DB.
static java.sql.ResultSet	getColumns(Session session, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String columnNamePattern, boolean withCaching, boolean onlyIfCached, java.lang.String tableType) Calls DatabaseMetaData.getColumns(String, String, String, String).
java.util.Map<Pair<Table,Column>,java.lang.String>	getComments() Finds comments for all model elements.
static java.lang.String	getDefaultSchema(Session session, java.lang.String userName) Gets default schema of DB.
static java.lang.String	getDefaultSchema(Session session, java.lang.String userName, java.util.List<java.lang.String> schemaNames) Gets default schema of DB.
static java.sql.ResultSet	getExportedKeys(Session session, java.lang.String schema, java.lang.String table)
static java.sql.ResultSet	getImportedKeys(Session session, java.lang.String schema, java.lang.String table, boolean withCaching)
static java.sql.ResultSet	getIndexes(Session session, java.lang.String schemaPattern, java.lang.String tableNamePattern) Calls {@link DatabaseMetaData#getIndexInfo(String, String, String, boolean, boolean).
static java.sql.ResultSet	getPrimaryKeys(Session session, java.lang.String schema, java.lang.String table, boolean withCaching)
static java.sql.ResultSet	getProcedures(Session session, java.lang.String schemaPattern, java.lang.String functionPattern) Calls DatabaseMetaData.getProcedures(String, String, String).
static java.util.List<java.lang.String>	getSchemas(Session session, java.lang.String userName) Finds all schemas in DB.
static java.sql.ResultSet	getTables(Session session, java.lang.String schemaPattern, java.lang.String tableNamePattern, java.lang.String[] types)
static void	resetCaches(Session session)
static Column	toColumn(java.sql.ResultSetMetaData metaData, int i, Session session)
java.lang.String	toString() Gets description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPES_WITH_LENGTH

public static final java.util.Set<java.lang.String> TYPES_WITH_LENGTH

Set of sql types (uppercase) not listed in Types which needs a length argument.

privilegedSessionProvider

public static JDBCMetaDataBasedModelElementFinder.PrivilegedSessionProvider privilegedSessionProvider

Constructor Detail

JDBCMetaDataBasedModelElementFinder

public JDBCMetaDataBasedModelElementFinder()

Method Detail

findAssociations

public java.util.Collection<Association> findAssociations(DataModel dataModel,
                                                          java.util.Map<Association,java.lang.String[]> namingSuggestion,
                                                          Session session,
                                                          ExecutionContext executionContext)
                                                   throws java.lang.Exception

Finds associations by reading the databases meta-data.

Specified by:

findAssociations in interface ModelElementFinder

Parameters:

session - the statement executor for executing SQL-statements

dataModel - model containing already known elements

namingSuggestion - to put naming suggestions for associations into

Returns:

found associations

Throws:

java.lang.Exception - on each error

getImportedKeys

public static java.sql.ResultSet getImportedKeys(Session session,
                                                 java.lang.String schema,
                                                 java.lang.String table,
                                                 boolean withCaching)
                                          throws java.sql.SQLException

Throws:

java.sql.SQLException

getExportedKeys

public static java.sql.ResultSet getExportedKeys(Session session,
                                                 java.lang.String schema,
                                                 java.lang.String table)
                                          throws java.sql.SQLException

Throws:

java.sql.SQLException

findTables

public java.util.Set<Table> findTables(Session session,
                                       ExecutionContext executionContext)
                                throws java.lang.Exception

Finds all tables in DB schema.

Specified by:

findTables in interface ModelElementFinder

Parameters:

session - the statement executor for executing SQL-statements

Returns:

a set of Tables

Throws:

java.lang.Exception - on each error

findPartitions

public static java.util.Set<java.lang.String> findPartitions(Session session,
                                                             java.lang.String introspectionSchema)

getPrimaryKeys

public static java.sql.ResultSet getPrimaryKeys(Session session,
                                                java.lang.String schema,
                                                java.lang.String table,
                                                boolean withCaching)
                                         throws java.sql.SQLException

Throws:

java.sql.SQLException

getTables

public static java.sql.ResultSet getTables(Session session,
                                           java.lang.String schemaPattern,
                                           java.lang.String tableNamePattern,
                                           java.lang.String[] types)
                                    throws java.sql.SQLException

Throws:

java.sql.SQLException

getComments

public java.util.Map<Pair<Table,Column>,java.lang.String> getComments()

Finds comments for all model elements.

Specified by:

getComments in interface ModelElementFinder

Returns:

map from element (table, column) to the comment

getIndexes

public static java.sql.ResultSet getIndexes(Session session,
                                            java.lang.String schemaPattern,
                                            java.lang.String tableNamePattern)
                                     throws java.sql.SQLException

Calls {@link DatabaseMetaData#getIndexInfo(String, String, String, boolean, boolean). Uses schemaPattern as catalogPattern on MySQL.

Throws:

java.sql.SQLException

getColumns

public static java.sql.ResultSet getColumns(Session session,
                                            java.lang.String schemaPattern,
                                            java.lang.String tableNamePattern,
                                            java.lang.String columnNamePattern,
                                            boolean withCaching,
                                            boolean onlyIfCached,
                                            java.lang.String tableType)
                                     throws java.sql.SQLException

Calls DatabaseMetaData.getColumns(String, String, String, String). Uses schemaPattern as catalogPattern on MySQL.

Parameters:

withCaching -

Throws:

java.sql.SQLException

getProcedures

public static java.sql.ResultSet getProcedures(Session session,
                                               java.lang.String schemaPattern,
                                               java.lang.String functionPattern)
                                        throws java.sql.SQLException

Calls DatabaseMetaData.getProcedures(String, String, String). Uses schemaPattern as catalogPattern on MySQL.

Throws:

java.sql.SQLException

getSchemas

public static java.util.List<java.lang.String> getSchemas(Session session,
                                                          java.lang.String userName)

Finds all schemas in DB.

Parameters:

session - the statement executor for executing SQL-statements

userName - schema with this name may be empty

getCatalogsWithSchemas

public static java.util.List<java.lang.String> getCatalogsWithSchemas(Session session)

Finds all catalogs with all schemas in DB.

Parameters:

session - the statement executor for executing SQL-statements

getDefaultSchema

public static java.lang.String getDefaultSchema(Session session,
                                                java.lang.String userName)

Gets default schema of DB.

Parameters:

session - the statement executor for executing SQL-statements

userName - schema with this name may be empty

getDefaultSchema

public static java.lang.String getDefaultSchema(Session session,
                                                java.lang.String userName,
                                                java.util.List<java.lang.String> schemaNames)

Gets default schema of DB.

Parameters:

session - the statement executor for executing SQL-statements

userName - schema with this name may be empty

findColumns

public java.util.List<Column> findColumns(Table table,
                                          Session session,
                                          ExecutionContext executionContext)
                                   throws java.sql.SQLException

Finds the Columns of a given Table.

Specified by:

findColumns in interface ModelElementFinder

Parameters:

table - the table

session - the statement executor for executing SQL-statements

Throws:

java.lang.Exception - on each error

java.sql.SQLException

filterLength

public static int filterLength(int length,
                               int precision,
                               java.lang.String typeName,
                               int type,
                               DBMS dbms,
                               int origLength)

Filters the length attribute of a column in a DBMS specific way.

Parameters:

length - the length as given from driver

precision - the precision as given from driver

type - the sql type

dbms - the DBMS

Returns:

filtered length

filterPrecision

public static int filterPrecision(int length,
                                  int precision,
                                  java.lang.String typeName,
                                  int type,
                                  DBMS dbms,
                                  int origLength)

Filters the precision attribute of a column in a DBMS specific way.

Parameters:

length - the length as given from driver

precision -

type - the sql type

dbms - the DBMS

Returns:

filtered length

filterType

public static java.lang.String filterType(java.lang.String sqlType,
                                          int length,
                                          java.lang.String typeName,
                                          int type,
                                          DBMS dbms,
                                          int origLength)

Filters the type attribute of a column in a DBMS specific way.

Parameters:

length - the length as given from driver

type - the sql type

dbms - the DBMS

Returns:

filtered length

toColumn

public static Column toColumn(java.sql.ResultSetMetaData metaData,
                              int i,
                              Session session)
                       throws java.sql.SQLException

Throws:

java.sql.SQLException

resetCaches

public static void resetCaches(Session session)

toString

public java.lang.String toString()

Gets description.

Overrides:

toString in class java.lang.Object