com.corticon.eclipse.studio.vocabulary.core

Interface IDatabaseMetadataAPI

All Superinterfaces:

IModelAPI

public interface IDatabaseMetadataAPI
extends IModelAPI

Database Metadata API. This interface contains methods needed to load database metadata from a JDBC data source and provides various finder and helper methods for using the data.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache() Clear the metadata.
com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.ColumnMetadata	findColumnMetadata(ITableInfo table, java.lang.String astrColumnName) Return the specified ColumnMetadata object instance.
com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.ColumnMetadata	findColumnMetadataFromString(java.lang.String tableName, java.lang.String astrColumnName) Return the specified ColumnMetadata object instance using a fully qualified table name.
com.corticon.rulesemf.canonicalvocabularymodel.DatabaseAccess	findDatabaseAccess() Finder for DatabaseAccess instance.
com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.DatabaseMetadata	findDatabaseMetadata() Finder for DatabaseMetadata anchor.
com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.ForeignKeyMetadata	findForeignKeyMetadata(ITableInfo table, java.lang.String astrForeignKeyName) Return the specified foreign key metadata object instance.
com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.PrimaryKeyMetadata	findPrimaryKeyMetadata(ITableInfo table, java.lang.String astrPrimaryKeyName) Return the specified primary key metadata object instance.
ITableInfo	findTableInfoFromFullyQualifiedTableName(java.lang.String tableName) Returns a description of the table given a fully qualified table name.
com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.TableMetadata	findTableMetadata(ITableInfo table) Return the specified TableMetadata object instance.
com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.TableMetadata	findTableMetadataFromString(java.lang.String tableName) Return the specified TableMetadata object instance, given a table name string.
java.util.ArrayList	getAllColumnNames(ITableInfo table) Return a list of all column names of the specified table.
java.util.ArrayList	getAllColumnNamesFromString(java.lang.String tableName) Return a list of all column names of the specified table table
java.util.ArrayList	getAllForeignKeyNames(ITableInfo table) Return a list of all foreign key names (foreign keys that *point* to this table, not foreign keys defined for this table).
java.util.ArrayList	getAllTableInfo() Return a list of all the table info objects
java.util.ArrayList	getAllTableNames() Return a list of fully-qualified table names.
java.util.ArrayList	getAllTables() Return a list of all fully-qualified table names from the database.
java.util.ArrayList	getColumnNamesForTypes(ITableInfo table, java.util.List aListJdbcDataTypes) Return a list of column names belonging to the specified table that have the specified JDBC data type(s).
int	getColumnSize(ITableInfo table, java.lang.String astrColumnName) Given a table name and column name, return the column size as specified in the database metadata or -1 if no information is available.
int	getDecimalDigits(ITableInfo table, java.lang.String astrColumnName) Given a table name and column name, return the number of decimal digits specified in the database metadata or -1 if no information is available.
java.lang.String	getJdbcDataType(ITableInfo table, java.lang.String astrColumnName) Get the JDBC data type for a given database table name and column name.
java.util.List	getJoinExpressionsInverse(ITableInfo tableSource, ITableInfo tableTarget) Given a source and target table, return a list of inverse join expressions.
java.util.List	getJoinExpressionsManyToMany(ITableInfo tableSource, ITableInfo tableTarget) Return join expressions appropriate for many-to-many associations.
java.util.List	getJoinExpressionsStandard(ITableInfo tableSource, ITableInfo tableTarget) Return join expressions appropriate for one-to-one or one-to-many associations.
java.util.ArrayList	getPrimaryKeyColumnNames(ITableInfo table) Return a sorted list of the primary key column names for a given table name.
java.lang.String	getSqlDataType(ITableInfo table, java.lang.String astrColumnName) Get the SQL data type for a given database table name and column name.
java.util.List<java.lang.String>	getSQLKeywords() Get a list of SQL keywords from the current database connection.
boolean	isEmpty() Determine whether the metadata cache is empty (i.e., database contains zero tables).
boolean	isForeignKeyColumn(ITableInfo table, java.lang.String astrColumnName) Determine whether the specified table and column name are part of a foreign key.
boolean	isMetadataLoaded() Determine whether any metadata has been loaded.
boolean	isSequence(IEntity aEntity, ITableInfo info) Determine whether the specified name is a database sequence.
boolean	isTable(ITableInfo info) Determine whether the specified table info specifies a table in the database.
boolean	isValidColumn(ITableInfo info, java.lang.String astrColumnName) Determine whether the specified column name is valid (i.e., whether there is any metadata present that describes the column).
boolean	isValidTable(ITableInfo info) Determine whether the specified table name is valid (i.e., whether there is any metadata present that describes the table).
boolean	isView(ITableInfo info) Determine whether the specified name is a database view.
boolean	load() Load all metadata from a database connection using connection properties defined in the DatabaseAccess EMF object.
boolean	load(java.util.List<java.lang.String> alstFullyQualifiedTableName) Load all metadata from a database connection using connection properties defined in the DatabaseAccess EMF object.
boolean	load(java.util.List<java.lang.String> alstTableNames, boolean abNamesAreFullyQualified) Load all metadata from a database connection using connection properties defined in the DatabaseAccess EMF object.
JoinExpression	parseJoinExpression(java.lang.String astrJoinExpression, ITableInfo sourceTable, ITableInfo targetTable, boolean abManyToMany, boolean abPerformSemanticAnalysis) Parse a given join expression to construct an object representation then optionally perform semantic analysis if the database metadata is available.
void	setVocabularyModelAPI(IVocabularyModelAPI aIVocabularyModelAPI) Setter for reference to Vocabulary model API (required).
boolean	testConnection(boolean abSilent) Test the current database connection and may optionally display a message box to indicate whether the test was successful.

Methods inherited from interface com.corticon.eclipse.core.IModelAPI

activate, addAnnotation, addBatchedModelListener, addLowLevelModelListener, addModelListener, addResourceListener, addView, beginTransaction, cancelTransaction, canSetSupportedLocales, closeResource, createResource, deleteAnnotation, deleteAnnotation, deleteAnnotation, deleteResource, displayMessageBox, dispose, doPostLoadValidation, doSmartValidation, endTransaction, endTransaction, flushCommandStack, formatValidationMessageLocation, formatValidationMessageText, getAllLocalesProvidingCompleteLocalization, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAPIContextObject, getAsset, getBaseAttribute, getBaseAttributeString, getBatchedModelListeners, getBuildNumber, getBuildNumberOfLastValidationRulesChange, getEditingDomain, getErrors, getErrors, getIndexByLocale, getLocale, getLocalizedAttribute, getLocalizedAttributeString, getLowLevelModelListeners, getMajorServiceNumber, getMajorVersionNumber, getMessage, getMessage, getMessageBase, getMessageBoxDelegate, getMinorServiceNumber, getMinorVersionNumber, getModelAPIState, getModelListeners, getNewResourceName, getPersistenceServicesDelegate, getPreferences, getPrimaryResource, getPrimaryResourceURI, getScrollableMessageDelegate, getSupportedLocales, getSuppressBrokenLinkValidation, getSuppressValidation, getToolTip, getUpdateStamp, getUserInterfaceInfoDelegate, getValidationMessageCount, getValidationMessageCount, getValidationMessageCount, getValidationMessageCount, getValidationMessages, getValidationMessages, getWarnings, getWarnings, handleException, hasErrors, hasErrors, hasErrors, hasErrors, hasErrors, hasErrors, hasErrorsOrWarnings, hasErrorsOrWarnings, hasErrorsOrWarnings, hasErrorsOrWarnings, hasErrorsOrWarnings, hasErrorsOrWarnings, hasWarnings, hasWarnings, hasWarnings, hasWarnings, hasWarnings, hasWarnings, isAPIStateEstablished, isEnabledRedo, isEnabledUndo, isInhibitNotification, isLoaded, isOperationModeNormal, isOperationModeRedo, isOperationModeUndo, isPassive, isPostLoadInProgress, isPrimaryResourceSet, isReadOnly, isResourceActivated, isResourceConflict, isResourceDemandLoaded, isResourceLoaded, isScrollableMessageDelegateAvailable, isShowCanonicalValidationMessages, isSuppressModifiedFlagUpdates, isSuppressPostLoad, isTransactionInProgress, isValid, isValid, loadResource, loadResource, loadResource, newInstance, noOperation, postLoad, postMethod, postMethod, postsave, preMethod, presave, redo, reloadResource, remapResource, remapResource, removeBatchedModelListener, removeLowLevelModelListener, removeModelListener, removeResource, removeResourceListener, removeView, renameResource, rollbackTransaction, saveAll, saveResource, setAnnotation, setAPIContextObject, setAPIState, setBuildNumber, setEditingDomain, setInhibitNotification, setLocale, setMajorServiceNumber, setMajorVersionNumber, setMessageBoxDelegate, setMinorServiceNumber, setMinorVersionNumber, setModelAPIState, setModelListeners, setPassive, setPersistenceServicesDelegate, setPostLoadInProgress, setPreferencesDelegate, setPrimaryResource, setReadOnly, setScrollableMessageDelegate, setSupportedLocales, setSuppressBrokenLinkValidation, setSuppressModifiedFlagUpdates, setSuppressPostLoad, setSuppressValidation, setUserInterfaceInfoDelegate, undo, unloadResource, validate, validateLicense

Method Detail

clearCache

void clearCache()

Clear the metadata.

getAllColumnNames

java.util.ArrayList getAllColumnNames(ITableInfo table)

Return a list of all column names of the specified table.

Parameters:

table - Definition of a table to match to database info.

Returns:

ArrayList of database column names belonging to the specified table.

getAllColumnNamesFromString

java.util.ArrayList getAllColumnNamesFromString(java.lang.String tableName)

Return a list of all column names of the specified table table

Parameters:

tableName - A fully qualified table name that the system will use best match to compare with.

Returns:

ArrayList of database column names belonging to the specified table.

getAllTableInfo

java.util.ArrayList getAllTableInfo()

Return a list of all the table info objects

Returns:

ArrayList of TableInfo objects

getAllForeignKeyNames

java.util.ArrayList getAllForeignKeyNames(ITableInfo table)

Return a list of all foreign key names (foreign keys that *point* to this table, not foreign keys defined for this table). The foreign key names will be sorted in alphabetical order.

Parameters:

table - Table info object.

Returns:

ArrayList of database column names belonging to the specified table.

getColumnNamesForTypes

java.util.ArrayList getColumnNamesForTypes(ITableInfo table,
                                         java.util.List aListJdbcDataTypes)

Return a list of column names belonging to the specified table that have the specified JDBC data type(s).

Parameters:

table - Definition of a table to match to database info.

aListJdbcDataTypes - List of JDBC data types.

Returns:

ArrayList of database column names.

getJdbcDataType

java.lang.String getJdbcDataType(ITableInfo table,
                               java.lang.String astrColumnName)

Get the JDBC data type for a given database table name and column name.

Parameters:

table - Definition of a table to match to database info.

astrColumn - Name of database column.

Returns:

JDBC data type (e.g., "VARCHAR") or null.

getSqlDataType

java.lang.String getSqlDataType(ITableInfo table,
                              java.lang.String astrColumnName)

Get the SQL data type for a given database table name and column name.

Parameters:

table - Definition of a table to match to database info.

astrColumn - Name of database column.

Returns:

SQL data type (e.g., "LONGVARCHAR") or null.

getColumnSize

int getColumnSize(ITableInfo table,
                java.lang.String astrColumnName)

Given a table name and column name, return the column size as specified in the database metadata or -1 if no information is available.

Parameters:

table - Definition of a table to match to database info.

astrColumnName - Column name.

Returns:

Column size as specified in database metadata.

getDecimalDigits

int getDecimalDigits(ITableInfo table,
                   java.lang.String astrColumnName)

Given a table name and column name, return the number of decimal digits specified in the database metadata or -1 if no information is available.

Parameters:

table - Definition of a table to match to database info.

astrColumnName - Column name.

Returns:

Number of decimal digits specified in database metadata.

findColumnMetadata

com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.ColumnMetadata findColumnMetadata(ITableInfo table,
                                                                                                 java.lang.String astrColumnName)

Return the specified ColumnMetadata object instance.

Parameters:

table - Definition of a table to match to database info.

astrColumnName - Column name.

Returns:

ColumnMetadata instance matching the specified name.

findColumnMetadataFromString

com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.ColumnMetadata findColumnMetadataFromString(java.lang.String tableName,
                                                                                                           java.lang.String astrColumnName)

Return the specified ColumnMetadata object instance using a fully qualified table name. (less accurate).

Parameters:

tableName - Fully Qualified table name to match to database metadata.

astrColumnName - Database column name.

Returns:

ColumnMetadata instance matching the specified column name.

findDatabaseAccess

com.corticon.rulesemf.canonicalvocabularymodel.DatabaseAccess findDatabaseAccess()

Finder for DatabaseAccess instance.

Returns:

Instance of DatabaseAccess.

findDatabaseMetadata

com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.DatabaseMetadata findDatabaseMetadata()

Finder for DatabaseMetadata anchor.

Returns:

Instance of DatabaseMetadata.

findForeignKeyMetadata

com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.ForeignKeyMetadata findForeignKeyMetadata(ITableInfo table,
                                                                                                         java.lang.String astrForeignKeyName)

Return the specified foreign key metadata object instance.

Parameters:

table - Definition of a table to match to database info.

astrForeignKeyName - Foreign key name.

Returns:

ForeignKeyMetadata instance matching the specified key.

findPrimaryKeyMetadata

com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.PrimaryKeyMetadata findPrimaryKeyMetadata(ITableInfo table,
                                                                                                         java.lang.String astrPrimaryKeyName)

Return the specified primary key metadata object instance.

Parameters:

table - Definition of a table to match to database info.

astrPrimaryKeyName - Primary key name.

Returns:

PrimaryKeyMetadata instance matching the specified key.

findTableMetadataFromString

com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.TableMetadata findTableMetadataFromString(java.lang.String tableName)

Return the specified TableMetadata object instance, given a table name string.

Parameters:

tableName - a string representing a fully qualified table name.

Returns:

findTableInfoFromFullyQualifiedTableName

ITableInfo findTableInfoFromFullyQualifiedTableName(java.lang.String tableName)

Returns a description of the table given a fully qualified table name.

Parameters:

tableName - a fully qualified table name.

Returns:

table description matching the fully qualified table name given.

findTableMetadata

com.corticon.rulesemf.canonicalvocabularymodel.metadata.database.TableMetadata findTableMetadata(ITableInfo table)

Return the specified TableMetadata object instance.

Parameters:

table - Definition of a table to match to database info.

Returns:

TableMetadata instance matching the specified name.

getJoinExpressionsStandard

java.util.List getJoinExpressionsStandard(ITableInfo tableSource,
                                        ITableInfo tableTarget)

Return join expressions appropriate for one-to-one or one-to-many associations. Given a source and target table, this function will return a list containing the join expression(s) that identify the foreign key relationship(s) between them, traversing from the source table to the target table.

In a one-to-many association, the source table is assumed to contain the primary key and the target table is assumed to contain the foreign key (for one-to-one associations, this distinction is not important).

The join expressions will be returned as shown in this example:

{CORTICON.CUSTOMER.NAME=PRODUCTORDER.FK_NAME, CORTICON.CUSTOMER.ADDRESS=PRODUCTORDER.FK_ADDRESS, CORTICON.CUSTOMER.SSNO=PRODUCTORDER.FK_SSNO}

Parameters:

tableSource - Definition of a table to match to database info.

tableTarget - Definition of a table to match to database info.

Returns:

List of all valid join expressions connecting source and target tables.

getJoinExpressionsInverse

java.util.List getJoinExpressionsInverse(ITableInfo tableSource,
                                       ITableInfo tableTarget)

Given a source and target table, return a list of inverse join expressions. The join expressions will be valid traversal paths from target to source.

Parameters:

tableSource - Definition of a table to match to database info.

tableTarget - Definition of a table to match to database info.

Returns:

List of inverse join expressions.

getJoinExpressionsManyToMany

java.util.List getJoinExpressionsManyToMany(ITableInfo tableSource,
                                          ITableInfo tableTarget)

Return join expressions appropriate for many-to-many associations. Such join expressions involve an "intersection" (middle) table as shown in this example:

{CORTICON.CUSTOMER.ID = CORTICON.CUSTOMER_ADDRESS.FK_CUSTOMER_ID, CORTICON.CUSTOMER_ADDRESS.FK_ADDRESS_ID = CORTICON.ADDRESS.ID}

This process analyzes the foreign key references of the source and target tables to locate any table(s) they share in common. If such common table(s) can be found, this method builds one or more join expressions that traverse from source to intersection to target.

Parameters:

tableSource - Definition of a table to match to database info.

tableTarget - Definition of a table to match to database info.

Returns:

List of all valid join expressions connecting source and target tables.

getPrimaryKeyColumnNames

java.util.ArrayList getPrimaryKeyColumnNames(ITableInfo table)

Return a sorted list of the primary key column names for a given table name.

Parameters:

table - Definition of a table to match to database info.

Returns:

ArrayList of primary key column names.

isEmpty

boolean isEmpty()

Determine whether the metadata cache is empty (i.e., database contains zero tables).

Returns:

true if loaded but table count is empty.

isForeignKeyColumn

boolean isForeignKeyColumn(ITableInfo table,
                         java.lang.String astrColumnName)

Determine whether the specified table and column name are part of a foreign key.

Parameters:

table - Definition of a table to match to database info.

astrColumnName - Column Name.

Returns:

true if the column is part of a foreign key.

isMetadataLoaded

boolean isMetadataLoaded()

Determine whether any metadata has been loaded.

Returns:

true if metadata is present.

isTable

boolean isTable(ITableInfo info)

Determine whether the specified table info specifies a table in the database.

Parameters:

info - Definition of a table or view to match to database info.

Returns:

true if name is a table.

isView

boolean isView(ITableInfo info)

Determine whether the specified name is a database view.

Parameters:

info - Definition of a table or view to match to database info.

Returns:

true if name is a view.

isSequence

boolean isSequence(IEntity aEntity,
                 ITableInfo info)

Determine whether the specified name is a database sequence.

Parameters:

aEntity - Name of an entity the sequence belongs to

info - Definition of sequence to match to database info.

Returns:

true if name is a sequence.

isValidColumn

boolean isValidColumn(ITableInfo info,
                    java.lang.String astrColumnName)

Determine whether the specified column name is valid (i.e., whether there is any metadata present that describes the column).

Parameters:

info - Definition of a table to match to database info.

astrColumnName - Name of the database column.

Returns:

true if metadata is available.

isValidTable

boolean isValidTable(ITableInfo info)

Determine whether the specified table name is valid (i.e., whether there is any metadata present that describes the table).

Parameters:

info - Definition of a table to match to database info.

Returns:

true if metadata is available.

load

boolean load()

Load all metadata from a database connection using connection properties defined in the DatabaseAccess EMF object.

Returns:

true if metadata was successfully loaded.

load

boolean load(java.util.List<java.lang.String> alstFullyQualifiedTableName)

Load all metadata from a database connection using connection properties defined in the DatabaseAccess EMF object.

Parameters:

alstFullyQualifiedTableName - Fully-qualified name of the database table.

Returns:

true if metadata was successfully loaded.

load

boolean load(java.util.List<java.lang.String> alstTableNames,
           boolean abNamesAreFullyQualified)

Load all metadata from a database connection using connection properties defined in the DatabaseAccess EMF object.

Parameters:

alstTableNames - Could be fully-qualified name of the database table or just the table name.

abNamesAreFullyQualified - Tells the system that the values in the List are fully-qualified or not.

Returns:

true if metadata was successfully loaded.

parseJoinExpression

JoinExpression parseJoinExpression(java.lang.String astrJoinExpression,
                                 ITableInfo sourceTable,
                                 ITableInfo targetTable,
                                 boolean abManyToMany,
                                 boolean abPerformSemanticAnalysis)

Parse a given join expression to construct an object representation then optionally perform semantic analysis if the database metadata is available. The object representation of the join expression consists of instance of the following classes:

JoinExpression - Anchor for the join expression JoinReference - Contains source and target column names

Both parsing and semantic analysis may generate messages which are anchored within the JoinExpression.

Parameters:

astrJoinExpression - Join expression (string).

sourceTable - Description of source table.

targetTable - Description of target table.

abManyToMany - true if join expression describes many-to-many association.

abPerformSemanticAnalysis - true to check join expression against metadata.

Returns:

JoinExpression instance.

setVocabularyModelAPI

void setVocabularyModelAPI(IVocabularyModelAPI aIVocabularyModelAPI)

Setter for reference to Vocabulary model API (required).

Parameters:

aIVocabularyModelAPI - Vocabulary model API instance.

testConnection

boolean testConnection(boolean abSilent)

Test the current database connection and may optionally display a message box to indicate whether the test was successful.

Parameters:

abSilent - true to suppress message "connection successful" message box.

Returns:

true if connection was successful.

getSQLKeywords

java.util.List<java.lang.String> getSQLKeywords()

Get a list of SQL keywords from the current database connection. This list includes the SQL 2003 keywords and any other keywords supported by the specific database being used.

Returns:

List of keywords as a list, if the metadata is available; null otherwise

getAllTableNames

java.util.ArrayList getAllTableNames()

Return a list of fully-qualified table names.

Returns:

ArrayList of fully-qualified table names.

getAllTables

java.util.ArrayList getAllTables()

Return a list of all fully-qualified table names from the database.

Returns:

ArrayList of all fully-qualified table names in the database.