com.toolsverse.etl.metadata

Class BaseMetadata

Object

com.toolsverse.etl.metadata.BaseMetadata

All Implemented Interfaces:

Metadata, ExtensionModule, Comparable<ExtensionModule>

Direct Known Subclasses:

FileMetadata, JdbcMetadata

public abstract class BaseMetadata
extends Object
implements Metadata

The base abstract implementation of the Metadata interface.

Since:

1.0

Version:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	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
BaseMetadata()

Method Summary

Modifier and Type	Method and Description
String	asText(String catalog, String schema, String pattern, String type, String metadataId) Shows object DDL.
int	compareTo(ExtensionModule ext)
String	dropAsText(String catalog, String schema, String pattern, String type) Shows object drop DDL.
DataSet	getColumns(Alias alias, DataSet dataSet, DataSetConnectorParams params, DataSetConnector connector) Gets the columns.
String	getConfigFileName() Gets the path to the configuration file for the module.
ConnectionFactory	getConnectionFactory() Gets the connection factory.
ConnectionParamsProvider<Alias>	getConnectionParamsProvider() Gets the connection params provider.
String	getCurrentDatabase() Gets the current database.
DataSet	getDefaultColumns(Alias alias, DataSet dataSet) Gets the default columns.
String	getDisplayName() Gets the display name.
Driver	getDriver() Gets the driver.
int	getExtensionRank() Gets the extension rank.
String	getFullObjectName(String pattern, String catalog, String schema) Gets the full object name.
String	getIconPath() Gets the full path to the icon file.
String	getLocalUnitClassPath() If extension module is a "local" it must return the path to it's corresponding Unit.
DataSet	getMetadataByType(String catalog, String schema, String pattern, String type, String metadataId) Gets the metadata by type.
DataSet	getMetadataByTypePreserveException(String catalog, String schema, String pattern, String type, String metadataId) Gets the metadata by type and preserve exception.
abstract Map<String,String>	getMetadataMethods() Gets the metadata methods.
String	getMetadataTypeByParentType(String parentType) Gets the metadata type by parent type.
List<Object>	getMetadataTypes(String parentType) Gets the metadata types.
String	getObjectName(String pattern) Gets the object name.
String	getObjectOwnerName(String pattern) Gets the object owner name.
KeyValue[]	getObjectTypes() Gets the object types.
String	getType() Gets the type of the extension module.
abstract Map<String,String>	getTypesByParent() Gets the types by parent.
String	getXmlConfigFileName() Gets the path to the xml configuration file for the module.
boolean	hasCatalogs() Checks if database has catalogs.
boolean	hasMetadataTypes(String type) Checks if database has given metadata type.
boolean	hasSchemas() Checks if database has schemas.
void	init(ConnectionFactory connectionFactory, ConnectionParamsProvider<Alias> connectionParamsProvider, Driver driver) Initializes metadata driver.
boolean	isDatabaseCurrent(String compareTo) Checks if database is current.
DataSet	searchDatabase(DatabaseFilter filter) Search database objects.
void	setCurrentDatabase(String value) Sets the current database.
void	setHasCatalogs(boolean value) Sets the value for the flag "has catalogs".
void	setHasSchemas(boolean value) Sets the value for the flag "has schemas".
boolean	supportsAsText(String type) Checks if metadata driver supports asText method for the type.
boolean	supportsDrop(String type) Checks if metadata driver supports dropAsText method for the type.
boolean	supportsRefresh(String type) Checks if metadata driver supports refresh for the type.
boolean	supportsSearchDatabase() Checks if metadata driver supports search database.

Methods inherited from class Object

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

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

allowNotDefault, createAsText, discoverDatabaseTypes, executeAsText, free, getAllowedSchema, getCatalogSchemaMetadataAllowed, getName, getTableMetadataAllowed, getTopLevelAllowed, getTopLevelDbObjects, getTypeByTypeFieldValue, getTypeField, getTypeMethods, needToPopulate, supportsExecute

Methods inherited from interface com.toolsverse.ext.ExtensionModule

getLicensePropertyName, getVendor, getVersion

Field Detail

TYPES_SUPPORT_REFRESH

public static Set<String> TYPES_SUPPORT_REFRESH

Constructor Detail

BaseMetadata

public BaseMetadata()

Method Detail

asText

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

Description copied from interface: Metadata

Shows object DDL.

Specified by:

asText in interface Metadata

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

compareTo

public int compareTo(ExtensionModule ext)

Specified by:

compareTo in interface Comparable<ExtensionModule>

dropAsText

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

Description copied from interface: Metadata

Shows object drop DDL.

Specified by:

dropAsText in interface Metadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the string

Throws:

Exception - in case of any error

getConfigFileName

public String getConfigFileName()

Description copied from interface: ExtensionModule

Gets the path to the configuration file for the module. The configuration file contains module specific properties, resides inside package and deployed with the code in the jar file.

Specified by:

getConfigFileName in interface ExtensionModule

Returns:

the path to the configuration name

getConnectionFactory

public ConnectionFactory getConnectionFactory()

Gets the connection factory.

Returns:

the connection factory

getConnectionParamsProvider

public ConnectionParamsProvider<Alias> getConnectionParamsProvider()

Description copied from interface: Metadata

Gets the connection params provider.

Specified by:

getConnectionParamsProvider in interface Metadata

Returns:

the connection params provider

getCurrentDatabase

public String getCurrentDatabase()

Gets the current database.

Returns:

the current database

getDisplayName

public String getDisplayName()

Description copied from interface: ExtensionModule

Gets the display name. This name will be used to display module in the various UI controls.

Specified by:

getDisplayName in interface ExtensionModule

Returns:

the display name

getDriver

public Driver getDriver()

Description copied from interface: Metadata

Gets the driver.

Specified by:

getDriver in interface Metadata

Returns:

the driver

getExtensionRank

public int getExtensionRank()

Description copied from interface: ExtensionModule

Gets the extension rank.

Specified by:

getExtensionRank in interface ExtensionModule

Returns:

the extension rank

getFullObjectName

public String getFullObjectName(String pattern,
                                String catalog,
                                String schema)

Description copied from interface: Metadata

Gets the full object name.

Specified by:

getFullObjectName in interface Metadata

Parameters:

pattern - the pattern

catalog - the catalog

schema - the schema

Returns:

the full object name

getIconPath

public String getIconPath()

Description copied from interface: ExtensionModule

Gets the full path to the icon file. The icon reside inside package and deployed with the code in jar file.

Specified by:

getIconPath in interface ExtensionModule

Returns:

the icon path

getLocalUnitClassPath

public String getLocalUnitClassPath()

Description copied from interface: ExtensionModule

If extension module is a "local" it must return the path to it's corresponding Unit. Otherwise returns null. The "local" extensions is loaded for each session independently.

Specified by:

getLocalUnitClassPath in interface ExtensionModule

Returns:

the local unit class path

See Also:

Unit

getMetadataByType

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

Description copied from interface: Metadata

Gets the metadata by type. Catch and log exception.

Specified by:

getMetadataByType in interface Metadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

metadataId - the metadata id

Returns:

the metadata by type

Throws:

Exception - in case of any error

getMetadataByTypePreserveException

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

Description copied from interface: Metadata

Gets the metadata by type and preserve exception.

Specified by:

getMetadataByTypePreserveException in interface Metadata

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

metadataId - the metadata id

Returns:

the metadata by type

Throws:

Exception - in case of any error

getMetadataMethods

public abstract Map<String,String> getMetadataMethods()

Gets the metadata methods.

Returns:

the metadata methods

getMetadataTypeByParentType

public String getMetadataTypeByParentType(String parentType)

Description copied from interface: Metadata

Gets the metadata type by parent type.

Specified by:

getMetadataTypeByParentType in interface Metadata

Parameters:

parentType - the parent type

Returns:

the metadata type by parent type

getMetadataTypes

public List<Object> getMetadataTypes(String parentType)
                              throws Exception

Description copied from interface: Metadata

Gets the metadata types.

Specified by:

getMetadataTypes in interface Metadata

Parameters:

parentType - the parent type

Returns:

the metadata types

Throws:

Exception - in case of any error

getObjectName

public String getObjectName(String pattern)

Description copied from interface: Metadata

Gets the object name.

Specified by:

getObjectName in interface Metadata

Parameters:

pattern - the pattern

Returns:

the object name

getObjectOwnerName

public String getObjectOwnerName(String pattern)

Description copied from interface: Metadata

Gets the object owner name.

Specified by:

getObjectOwnerName in interface Metadata

Parameters:

pattern - the pattern

Returns:

the object owner name

getObjectTypes

public KeyValue[] getObjectTypes()

Description copied from interface: Metadata

Gets the object types.

Specified by:

getObjectTypes in interface Metadata

Returns:

the object types, key = type, value = description

getType

public String getType()

Description copied from interface: ExtensionModule

Gets the type of the extension module.

Specified by:

getType in interface ExtensionModule

Returns:

the type

getTypesByParent

public abstract Map<String,String> getTypesByParent()

Gets the types by parent.

Returns:

the types by parent

getXmlConfigFileName

public String getXmlConfigFileName()

Description copied from interface: ExtensionModule

Gets the path to the xml configuration file for the module. The xml configuration file usually contains module specific UI elements, resides inside package and deployed with the code in the jar file.

Specified by:

getXmlConfigFileName in interface ExtensionModule

Returns:

the path to the configuration name

hasCatalogs

public boolean hasCatalogs()

Description copied from interface: Metadata

Checks if database has catalogs.

Specified by:

hasCatalogs in interface Metadata

Returns:

true, if successful

hasMetadataTypes

public boolean hasMetadataTypes(String type)

Description copied from interface: Metadata

Checks if database has given metadata type.

Specified by:

hasMetadataTypes in interface Metadata

Parameters:

type - the type

Returns:

true, if successful

hasSchemas

public boolean hasSchemas()

Description copied from interface: Metadata

Checks if database has schemas.

Specified by:

hasSchemas in interface Metadata

Returns:

true, if successful

init

public void init(ConnectionFactory connectionFactory,
                 ConnectionParamsProvider<Alias> connectionParamsProvider,
                 Driver driver)
          throws Exception

Description copied from interface: Metadata

Initializes metadata driver.

Specified by:

init in interface Metadata

Parameters:

connectionFactory - the connection factory

connectionParamsProvider - the connection params provider

driver - the driver

Throws:

Exception - in case of any error

isDatabaseCurrent

public boolean isDatabaseCurrent(String compareTo)

Description copied from interface: Metadata

Checks if database is current. For example if user logs into into the Oracle database using user name "test" the current schema is "test".

Specified by:

isDatabaseCurrent in interface Metadata

Parameters:

compareTo - the compare to

Returns:

true, if database is current

searchDatabase

public DataSet searchDatabase(DatabaseFilter filter)
                       throws Exception

Description copied from interface: Metadata

Search database objects.

Specified by:

searchDatabase in interface Metadata

Parameters:

filter - the search filter

Returns:

the data set

Throws:

Exception - in case of any error

setCurrentDatabase

public void setCurrentDatabase(String value)

Sets the current database.

Parameters:

value - the new current database

setHasCatalogs

public void setHasCatalogs(boolean value)

Sets the value for the flag "has catalogs".

Parameters:

value - the new value for the flag "has catalogs"

setHasSchemas

public void setHasSchemas(boolean value)

Sets the value for the flag "has schemas".

Parameters:

value - the new value for the flag "has schemas".

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

Parameters:

type - the type

Returns:

true, if successful

supportsDrop

public boolean supportsDrop(String type)

Description copied from interface: Metadata

Checks if metadata driver supports dropAsText method for the type.

Specified by:

supportsDrop in interface Metadata

Parameters:

type - the type

Returns:

true, if successful

supportsRefresh

public boolean supportsRefresh(String type)

Description copied from interface: Metadata

Checks if metadata driver supports refresh for the type.

Specified by:

supportsRefresh in interface Metadata

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

Returns:

true, if successful

getColumns

public DataSet getColumns(Alias alias,
                          DataSet dataSet,
                          DataSetConnectorParams params,
                          DataSetConnector connector)
                   throws Exception

Gets the columns.

Parameters:

alias - the alias

dataSet - the data set

params - the params

connector - the connector

Returns:

the columns

Throws:

Exception - the exception

getDefaultColumns

public DataSet getDefaultColumns(Alias alias,
                                 DataSet dataSet)

Gets the default columns. Used to populate metadata even when there is no actual data set.

Parameters:

alias - the alias

dataSet - the data set with columns. Can be null.

Returns:

the default columns