com.toolsverse.etl.metadata.db2

Class Db2Metadata

Object

com.toolsverse.etl.metadata.BaseMetadata

com.toolsverse.etl.metadata.JdbcMetadata

com.toolsverse.etl.metadata.db2.Db2Metadata

All Implemented Interfaces:

Metadata, ExtensionModule, Comparable<ExtensionModule>

public class Db2Metadata
extends JdbcMetadata

The DB2 implementation of the Metadata interface.

Since:

2.0

Version:

2.0

Nested Class Summary

Nested classes/interfaces inherited from class com.toolsverse.etl.metadata.JdbcMetadata

JdbcMetadata.DbMetadata

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,String>	DB2_METADATA_METHODS The DB2 metadata methods.
protected static Map<String,String>	DB2_TYPE_SUPPORT_AS_TEXT The DB2 object types which support asText.
protected static Map<String,String>	DB2_TYPE_SUPPORT_EXECUTE_AS_TEXT The db2 type support execute as text map.
protected static Map<String,String>	DB2_TYPES_BY_PARENT The DB2 types by parent.

Fields inherited from class com.toolsverse.etl.metadata.JdbcMetadata

ALLOWED_FOR_SCHEMA_CATALOG, ALLOWED_FOR_TABLE, ALLOWED_TOP_LEVEL, METADATA_METHODS, TYPE_METHODS, TYPE_SUPPORT_AS_TEXT, TYPE_SUPPORT_DROP_AS_TEXT, TYPES_BY_PARENT

Fields inherited from class com.toolsverse.etl.metadata.BaseMetadata

TYPES_SUPPORT_REFRESH

Fields inherited from interface com.toolsverse.etl.metadata.Metadata

ALL_REFS, ALL_TYPES, BASE_CLASS_PATH, DB_DELIMITER, DEFAULT_METHOD, DEFAULT_TYPE, ID_FIELD, METADATA_DELIMITER, SYNONYMS_DATASET_TYPE, TABLE_PRIV, TABLE_PRIVS, TABLES_DATASET_TYPE, TYPE_ALIAS, TYPE_ALIASES, TYPE_ASSEMBLIES, TYPE_ASSEMBLY, TYPE_CATALOG, TYPE_CLASS, TYPE_COLUMN, TYPE_COLUMNS, TYPE_CONSTRAINTS, TYPE_DATA_SET, TYPE_DB_LINK, TYPE_DB_LINKS, TYPE_DBFUNCT, TYPE_DBFUNCTIONS, TYPE_DBINFO, TYPE_DBPROP, TYPE_DBPROPS, TYPE_DIRECTORIES, TYPE_DIRECTORY, TYPE_EK, TYPE_EK_COLUMN, TYPE_EK_COLUMNS, TYPE_EKS, TYPE_EXEC_METHOD, TYPE_EXEC_METHODS, TYPE_FILE, TYPE_FK, TYPE_FK_COLUMN, TYPE_FK_COLUMNS, TYPE_FKS, TYPE_FUNCT, TYPE_FUNCT_PARAMETERS, TYPE_FUNCTS, TYPE_GLOBAL_TEMPORARIES, TYPE_INDEX, TYPE_INDEX_COLUMN, TYPE_INDEX_COLUMNS, TYPE_INDEXES, TYPE_JAVA_CLASSES, TYPE_LOCAL_TEMPORARIES, TYPE_NICKNAME, TYPE_PACKAGE, TYPE_PACKAGE_BODY, TYPE_PACKAGES, TYPE_PARAMETER, TYPE_PARAMETERS, TYPE_PK, TYPE_PK_COLUMN, TYPE_PK_COLUMNS, TYPE_PKS, TYPE_PROC, TYPE_PROC_PARAMETERS, TYPE_PROCS, TYPE_PROCS_FUNCS, TYPE_QUEUE, TYPE_QUEUE_TABLE, TYPE_QUEUE_TABLES, TYPE_QUEUES, TYPE_RECYCLE_BIN, TYPE_RECYCLE_BIN_ITEM, TYPE_SCHEMA, TYPE_SEQUENCE, TYPE_SEQUENCES, TYPE_SYNONYM, TYPE_SYNONYMS, TYPE_SYSTEM_TABLES, TYPE_SYSTEM_VIEWS, TYPE_TABLE, TYPE_TABLES, TYPE_TEMPORARY_TABLES, TYPE_TEMPORARY_VIEWS, TYPE_TRIGGER, TYPE_TRIGGERS, TYPE_TYPE, TYPE_TYPES, TYPE_USER_TYPE, TYPE_USER_TYPES, TYPE_VIEW, TYPE_VIEWS, TYPE_WORKSHEET, TYPE_WORKSHEETS, TYPE_XML_SCHEMA, TYPE_XML_SCHEMAS, VIEWS_DATASET_TYPE

Fields inherited from interface com.toolsverse.ext.ExtensionModule

APP, COMMAND, ETL_DRIVER, FORMATTER, IDE_NODE, NO_RANK, WIDGET

Constructor Summary

Constructors

Constructor and Description
Db2Metadata()

Method Summary

Modifier and Type	Method and Description
String	asTextMethod(String type) asText method name for the type.
String	executeAsText(String catalog, String schema, String pattern, String type, String metadataId) Shows object execute SQL.
DataSet	getConstraints(String catalog, String schema, String pattern, String type) Gets table constraints.
static String	getConstraintType(Object type) Gets the constraint type.
List<String>	getDbObjectTypes() Gets the database object types.
String	getDropFunctionAsText(String catalog, String schema, String pattern, String type) Gets the drop function SQL.
String	getDropPackageAsText(String catalog, String schema, String pattern, String type) Gets the drop package SQL.
String	getDropProcAsText(String catalog, String schema, String pattern, String type) Gets the drop procedure SQL.
DataSet	getFunctParameters(String catalog, String schema, String pattern, String type) Gets the function parameters.
DataSet	getFuncts(String catalog, String schema, String pattern, String type) Gets the functions.
DataSet	getIndexColumns(String catalog, String schema, String pattern, String type) Gets the index columns.
String	getLicensePropertyName() Gets the name of the license property.
Map<String,String>	getMetadataMethods() Gets the metadata methods.
String	getName() Gets the name.
KeyValue[]	getObjectTypes() Gets the object types.
String	getPackageAsText(String catalog, String schema, String pattern, String type) Gets the package as text.
DataSet	getPackages(String catalog, String schema, String pattern, String type) Gets the packages.
String	getProcAsText(String catalog, String schema, String pattern, String type) Gets the procedure as text.
DataSet	getProcParameters(String catalog, String schema, String pattern, String type) Gets the procedure parameters.
DataSet	getProcs(String catalog, String schema, String pattern, String type) Gets the procedures.
DataSet	getSequences(String catalog, String schema, String pattern, String type) Gets the sequences.
DataSet	getTableIndexes(String catalog, String schema, String pattern, String type) Gets the table indexes.
List<String>	getTableMetadataTypes() Gets the table metadata types.
DataSet	getTablesByType(String catalog, String schema, String pattern, String type) Gets the tables by type.
String	getTriggerAsText(String catalog, String schema, String pattern, String type) Gets the trigger as text.
DataSet	getTriggers(String catalog, String schema, String pattern, String type) Gets the triggers.
Map<String,String>	getTypesByParent() Gets the types by parent.
DataSet	getUserTypes(String catalog, String schema, String pattern, String type) Gets the user defined types.
String	getViewAsText(String catalog, String schema, String pattern, String type) Gets the view as text.
DataSet	getXmlSchemas(String catalog, String schema, String pattern, String type) Gets the xml schemas.
DataSet	searchDatabase(DatabaseFilter filter) Search database objects.
boolean	supportsAsText(String type) Checks if metadata driver supports asText method for the type.
boolean	supportsExecute(String type) Checks if metadata driver supports executeAsText method for the type.
boolean	supportsSearchDatabase() Checks if metadata driver supports search database.

Methods inherited from class com.toolsverse.etl.metadata.JdbcMetadata

allowNotDefault, asText, chooseBestIndex, createAsText, discoverDatabaseTypes, dropAsText, dropAsTextMethod, free, getAllowedSchema, getAllRefs, getCatalogs, getCatalogSchemaAndPattern, getCatalogSchemaMetadataAllowed, getDbFunctions, getDbInfoObjects, getDbMetadata, getDbObjectsByWildcard, getDbProps, getDeleteRule, getDropAliasAsText, getDropAssemblyAsText, getDropDbLinkAsText, getDropIndexAsText, getDropSequenceAsText, getDropSynonymAsText, getDropTableAsText, getDropTriggerAsText, getDropTypeAsText, getDropViewAsText, getEKColumns, getEKMetadataTypes, getFKColumns, getFkDefinitionAsText, getFKMetadataTypes, getFksAsText, getFuncParamNameForNull, getFuncParamType, getFuncRetType, getFunctMetadataTypes, getIndexDefinitionAsText, getIndexesAsText, getIndexMetadataTypes, getOwners, getParameters, getPkAsText, getPKColumns, getPKMetadataTypes, getProcMetadataTypes, getProcsRetType, getSchemas, getSuggestedKeyFields, getTableAsText, getTableColumns, getTableEKs, getTableEKs, getTableFKs, getTableMetadataAllowed, getTableNameAsText, getTablePKs, getTablePrivs, getTableTypes, getTopLevelAllowed, getTopLevelDbObjects, getTransIsolation, getTypeByTypeFieldValue, getTypeField, getTypeMethods, getTypes, getUpdateRule, getVendor, getVersion, getViewMetadataTypes, isOutParam, isUnique, needToPopulate, populateTables, supportsDrop

Methods inherited from class com.toolsverse.etl.metadata.BaseMetadata

compareTo, getColumns, getConfigFileName, getConnectionFactory, getConnectionParamsProvider, getCurrentDatabase, getDefaultColumns, getDisplayName, getDriver, getExtensionRank, getFullObjectName, getIconPath, getLocalUnitClassPath, getMetadataByType, getMetadataByTypePreserveException, getMetadataTypeByParentType, getMetadataTypes, getObjectName, getObjectOwnerName, getType, getXmlConfigFileName, hasCatalogs, hasMetadataTypes, hasSchemas, init, isDatabaseCurrent, setCurrentDatabase, setHasCatalogs, setHasSchemas, supportsRefresh

Methods inherited from class Object

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

Field Detail

DB2_METADATA_METHODS

protected static Map<String,String> DB2_METADATA_METHODS

The DB2 metadata methods.

DB2_TYPES_BY_PARENT

protected static Map<String,String> DB2_TYPES_BY_PARENT

The DB2 types by parent.

DB2_TYPE_SUPPORT_AS_TEXT

protected static Map<String,String> DB2_TYPE_SUPPORT_AS_TEXT

The DB2 object types which support asText.

DB2_TYPE_SUPPORT_EXECUTE_AS_TEXT

protected static Map<String,String> DB2_TYPE_SUPPORT_EXECUTE_AS_TEXT

The db2 type support execute as text map.

Constructor Detail

Db2Metadata

public Db2Metadata()

Method Detail

getConstraintType

public static String getConstraintType(Object type)

Gets the constraint type.

Parameters:

type - the type

Returns:

the constraint type

asTextMethod

public String asTextMethod(String type)

Description copied from class: JdbcMetadata

asText method name for the type.

Overrides:

asTextMethod in class JdbcMetadata

Parameters:

type - the type

Returns:

the string

executeAsText

public String executeAsText(String catalog,
                            String schema,
                            String pattern,
                            String type,
                            String metadataId)
                     throws Exception

Description copied from interface: Metadata

Shows object execute SQL.

Specified by:

executeAsText in interface Metadata

Overrides:

executeAsText in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

metadataId - the metadata id

Returns:

the string

Throws:

Exception - in case of any error

getConstraints

public DataSet getConstraints(String catalog,
                              String schema,
                              String pattern,
                              String type)
                       throws Exception

Gets table constraints.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the constraints

Throws:

Exception - the exception

getDbObjectTypes

public List<String> getDbObjectTypes()
                              throws Exception

Description copied from class: JdbcMetadata

Gets the database object types.

Overrides:

getDbObjectTypes in class JdbcMetadata

Returns:

the database object types

Throws:

Exception - in case of any error

getDropFunctionAsText

public String getDropFunctionAsText(String catalog,
                                    String schema,
                                    String pattern,
                                    String type)
                             throws Exception

Description copied from class: JdbcMetadata

Gets the drop function SQL.

Overrides:

getDropFunctionAsText in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the SQL

Throws:

Exception - the exception

getDropPackageAsText

public String getDropPackageAsText(String catalog,
                                   String schema,
                                   String pattern,
                                   String type)
                            throws Exception

Description copied from class: JdbcMetadata

Gets the drop package SQL.

Overrides:

getDropPackageAsText in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the SQL

Throws:

Exception - the exception

getDropProcAsText

public String getDropProcAsText(String catalog,
                                String schema,
                                String pattern,
                                String type)
                         throws Exception

Description copied from class: JdbcMetadata

Gets the drop procedure SQL.

Overrides:

getDropProcAsText in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the SQL

Throws:

Exception - the exception

getFunctParameters

public DataSet getFunctParameters(String catalog,
                                  String schema,
                                  String pattern,
                                  String type)
                           throws Exception

Description copied from class: JdbcMetadata

Gets the function parameters.

Overrides:

getFunctParameters in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the function parameters

Throws:

Exception - in case of any error

getFuncts

public DataSet getFuncts(String catalog,
                         String schema,
                         String pattern,
                         String type)
                  throws Exception

Description copied from class: JdbcMetadata

Gets the functions.

Overrides:

getFuncts in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the function

Throws:

Exception - in case of any error

getIndexColumns

public DataSet getIndexColumns(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception

Description copied from class: JdbcMetadata

Gets the index columns.

Overrides:

getIndexColumns in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the index columns

Throws:

Exception - in case of any error

getLicensePropertyName

public String getLicensePropertyName()

Description copied from interface: ExtensionModule

Gets the name of the license property. If not null the model is a subject of licensing.

Specified by:

getLicensePropertyName in interface ExtensionModule

Overrides:

getLicensePropertyName in class JdbcMetadata

Returns:

the name of the license property

getMetadataMethods

public Map<String,String> getMetadataMethods()

Description copied from class: BaseMetadata

Gets the metadata methods.

Overrides:

getMetadataMethods in class JdbcMetadata

Returns:

the metadata methods

getName

public String getName()

Description copied from interface: Metadata

Gets the name.

Specified by:

getName in interface Metadata

Overrides:

getName in class JdbcMetadata

Returns:

the name

getObjectTypes

public KeyValue[] getObjectTypes()

Description copied from interface: Metadata

Gets the object types.

Specified by:

getObjectTypes in interface Metadata

Overrides:

getObjectTypes in class BaseMetadata

Returns:

the object types, key = type, value = description

getPackageAsText

public String getPackageAsText(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception

Gets the package as text.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the package as text

Throws:

Exception - in case of any error

getPackages

public DataSet getPackages(String catalog,
                           String schema,
                           String pattern,
                           String type)
                    throws Exception

Gets the packages.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the packages

Throws:

Exception - in case of any error

getProcAsText

public String getProcAsText(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception

Gets the procedure as text.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the procedure as text

Throws:

Exception - in case of any error

getProcParameters

public DataSet getProcParameters(String catalog,
                                 String schema,
                                 String pattern,
                                 String type)
                          throws Exception

Description copied from class: JdbcMetadata

Gets the procedure parameters.

Overrides:

getProcParameters in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the procedure parameters

Throws:

Exception - in case of any error

getProcs

public DataSet getProcs(String catalog,
                        String schema,
                        String pattern,
                        String type)
                 throws Exception

Description copied from class: JdbcMetadata

Gets the procedures.

Overrides:

getProcs in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the procedures

Throws:

Exception - in case of any error

getSequences

public DataSet getSequences(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception

Gets the sequences.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the sequences

Throws:

Exception - in case of any error

getTableIndexes

public DataSet getTableIndexes(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception

Description copied from class: JdbcMetadata

Gets the table indexes.

Overrides:

getTableIndexes in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the table indexes

Throws:

Exception - in case of any error

getTableMetadataTypes

public List<String> getTableMetadataTypes()

Description copied from class: JdbcMetadata

Gets the table metadata types.

Overrides:

getTableMetadataTypes in class JdbcMetadata

Returns:

the table metadata types

getTriggerAsText

public String getTriggerAsText(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception

Gets the trigger as text.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the trigger as text

Throws:

Exception - in case of any error

getTriggers

public DataSet getTriggers(String catalog,
                           String schema,
                           String pattern,
                           String type)
                    throws Exception

Gets the triggers.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the triggers

Throws:

Exception - in case of any error

getTypesByParent

public Map<String,String> getTypesByParent()

Description copied from class: BaseMetadata

Gets the types by parent.

Overrides:

getTypesByParent in class JdbcMetadata

Returns:

the types by parent

getUserTypes

public DataSet getUserTypes(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception

Gets the user defined types.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the user defined types

Throws:

Exception - in case of any error

getViewAsText

public String getViewAsText(String catalog,
                            String schema,
                            String pattern,
                            String type)
                     throws Exception

Gets the view as text.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the view as text

Throws:

Exception - in case of any error

getXmlSchemas

public DataSet getXmlSchemas(String catalog,
                             String schema,
                             String pattern,
                             String type)
                      throws Exception

Gets the xml schemas.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the xml schemas

Throws:

Exception - in case of any error

searchDatabase

public DataSet searchDatabase(DatabaseFilter filter)
                       throws Exception

Description copied from interface: Metadata

Search database objects.

Specified by:

searchDatabase in interface Metadata

Overrides:

searchDatabase in class BaseMetadata

Parameters:

filter - the search filter

Returns:

the data set

Throws:

Exception - in case of any error

supportsAsText

public boolean supportsAsText(String type)

Description copied from interface: Metadata

Checks if metadata driver supports asText method for the type.

Specified by:

supportsAsText in interface Metadata

Overrides:

supportsAsText in class JdbcMetadata

Parameters:

type - the type

Returns:

true, if successful

supportsExecute

public boolean supportsExecute(String type)

Description copied from interface: Metadata

Checks if metadata driver supports executeAsText method for the type.

Specified by:

supportsExecute in interface Metadata

Overrides:

supportsExecute in class JdbcMetadata

Parameters:

type - the type

Returns:

true, if successful

supportsSearchDatabase

public boolean supportsSearchDatabase()

Description copied from interface: Metadata

Checks if metadata driver supports search database.

Specified by:

supportsSearchDatabase in interface Metadata

Overrides:

supportsSearchDatabase in class BaseMetadata

Returns:

true, if successful

getTablesByType

public DataSet getTablesByType(String catalog,
                               String schema,
                               String pattern,
                               String type)
                        throws Exception

Gets the tables by type.

Overrides:

getTablesByType in class JdbcMetadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the tables by type

Throws:

Exception - the exception