com.corticon.eclipse.studio.drivers.core

Class DatabaseDefinitionImpl

java.lang.Object

com.corticon.eclipse.studio.drivers.core.DatabaseDefinitionImpl

All Implemented Interfaces:

IDatabaseDefinition

public class DatabaseDefinitionImpl
extends java.lang.Object
implements IDatabaseDefinition

Constructor Summary

Constructors

Constructor and Description
DatabaseDefinitionImpl()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areCatalogsSupported(java.lang.String astrId) Retrieve the flag for the catalogs support.
boolean	areTransactionsToBeIgnored(java.lang.String astrId) Retrieve the flag which indicates whether transactions are to be ignored.
java.lang.String	findDatabaseId(java.lang.String astrDatabaseServerName) Retrieve the Database Server ID using the database server user-friendly name (reverse lookup).
java.util.Collection<java.lang.String>	getDatabaseIDs() Retrieve a collection of unique database definition identifiers (IDs).
java.lang.String	getDatabaseUrlTemplate(java.lang.String astrId) Retrieve a template of the database JDBC URL.
java.lang.String	getDefaultNumericIdentityStrategy(java.lang.String astrId) Retrieve the default numeric identity strategy type.
java.lang.String	getDefaultStringIdentityStrategy(java.lang.String astrId) Retrieve the default string identity strategy.
java.lang.String	getDialect(java.lang.String astrId) Retrieve the Hibernate Dialect class name be used with a particular database.
java.lang.String	getDriverClassName(java.lang.String astrId) Retrieve the JDBC driver class name associated with a particular database.
java.util.Vector<java.lang.String>	getErrors() Retrieve a vector of errors occurred while reading the database definition file.
java.util.Vector<java.lang.String>	getFatals() Retrieve a vector of fatal errors occurred while reading the database definition file.
java.util.Collection<java.lang.String>	getNumericIdentityStrategies(java.lang.String astrId) Retrieve the list of numeric identity strategies
java.util.Collection<java.lang.String>	getStringIdentityStrategies(java.lang.String astrId) Retrieve the list of string identity strategies
java.util.List<java.lang.String>	getSupportedSqlTypes(java.lang.String astrId, java.lang.String astrCorticonDataTypeName) Determine whether a given Corticon Data Type can be mapped to a given SQL type within the specified database.
java.lang.String	getUserFriendlyName(java.lang.String astrId) Retrieve the user-friendly name of a particular database.
java.util.Collection<java.lang.String>	getUserFriendlyNames() Retrieve a collection of user-friendly database names for the Vocabulary Database Access tab.
java.lang.String	getValidationQuery(java.lang.String astrId) Retrieve a query used to validate a database connection.
java.util.Vector<java.lang.String>	getWarnings() Retrieve a vector of warnings occurred while reading the database definition file.
boolean	hasMandatoryValueStrategy(java.lang.String astrId) Retrieve the flag for the mandatory value strategy.
boolean	isGetGeneratedKeysSupported(java.lang.String astrId) Retrieve the flag for the getGeneratedKeys support.
boolean	isReadOnlyModeSupported(java.lang.String astrId) Retrieve the flag for the read only mode support.
boolean	isSchemaCreationSupported(java.lang.String astrId) Retrieve the flag for the database schema creation support.
boolean	isSupportedSqlTypeMapping(java.lang.String astrId, java.lang.String astrCorticonDataTypeName, java.lang.String astrSqlTypeName) Determine whether a given Corticon Data Type can be mapped to a given SQL type within the specified database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseDefinitionImpl

public DatabaseDefinitionImpl()

Method Detail

findDatabaseId

public java.lang.String findDatabaseId(java.lang.String astrDatabaseServerName)

Description copied from interface: IDatabaseDefinition

Retrieve the Database Server ID using the database server user-friendly name (reverse lookup).

Specified by:

findDatabaseId in interface IDatabaseDefinition

Parameters:

astrDatabaseServerName - Localized database server name.

Returns:

Database Server ID or null.

getDatabaseIDs

public java.util.Collection<java.lang.String> getDatabaseIDs()

Description copied from interface: IDatabaseDefinition

Retrieve a collection of unique database definition identifiers (IDs).

Specified by:

getDatabaseIDs in interface IDatabaseDefinition

Returns:

The collection of database definition identifiers.

getUserFriendlyNames

public java.util.Collection<java.lang.String> getUserFriendlyNames()

Description copied from interface: IDatabaseDefinition

Retrieve a collection of user-friendly database names for the Vocabulary Database Access tab.

Specified by:

getUserFriendlyNames in interface IDatabaseDefinition

Returns:

The collection of user-friendly database names.

getUserFriendlyName

public java.lang.String getUserFriendlyName(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the user-friendly name of a particular database.

Specified by:

getUserFriendlyName in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose user friendly name should be returned.

Returns:

User friendly name.

getDriverClassName

public java.lang.String getDriverClassName(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the JDBC driver class name associated with a particular database.

Specified by:

getDriverClassName in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose JDBC driver class name should be returned;

Returns:

Driver class name.

getDialect

public java.lang.String getDialect(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the Hibernate Dialect class name be used with a particular database.

Specified by:

getDialect in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose Hibernate Dialect class name should be returned;

Returns:

Hibernate dialect class.

getDatabaseUrlTemplate

public java.lang.String getDatabaseUrlTemplate(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve a template of the database JDBC URL.

Specified by:

getDatabaseUrlTemplate in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose database URL template should be returned;

Returns:

Database URL template.

getValidationQuery

public java.lang.String getValidationQuery(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve a query used to validate a database connection. The query must return a single row with return value “1”.

Specified by:

getValidationQuery in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

Validation query.

getErrors

public java.util.Vector<java.lang.String> getErrors()

Description copied from interface: IDatabaseDefinition

Retrieve a vector of errors occurred while reading the database definition file.

Specified by:

getErrors in interface IDatabaseDefinition

Returns:

Vector of error messages.

getFatals

public java.util.Vector<java.lang.String> getFatals()

Description copied from interface: IDatabaseDefinition

Retrieve a vector of fatal errors occurred while reading the database definition file.

Specified by:

getFatals in interface IDatabaseDefinition

Returns:

Vector of fatal error messages.

getWarnings

public java.util.Vector<java.lang.String> getWarnings()

Description copied from interface: IDatabaseDefinition

Retrieve a vector of warnings occurred while reading the database definition file.

Specified by:

getWarnings in interface IDatabaseDefinition

Returns:

Vector of warning messages.

isSupportedSqlTypeMapping

public boolean isSupportedSqlTypeMapping(java.lang.String astrId,
                                java.lang.String astrCorticonDataTypeName,
                                java.lang.String astrSqlTypeName)

Description copied from interface: IDatabaseDefinition

Determine whether a given Corticon Data Type can be mapped to a given SQL type within the specified database.

Specified by:

isSupportedSqlTypeMapping in interface IDatabaseDefinition

Parameters:

astrId - Database definition ID.

astrCorticonDataTypeName - Corticon Data Type name (e.g., Decimal).

astrSqlTypeName - SQL type name (e.g., DECIMAL).

Returns:

true if the mapping is valid.

getSupportedSqlTypes

public java.util.List<java.lang.String> getSupportedSqlTypes(java.lang.String astrId,
                                                    java.lang.String astrCorticonDataTypeName)

Description copied from interface: IDatabaseDefinition

Determine whether a given Corticon Data Type can be mapped to a given SQL type within the specified database.

Specified by:

getSupportedSqlTypes in interface IDatabaseDefinition

Parameters:

astrId - Database definition ID.

astrCorticonDataTypeName - Corticon Data Type name (e.g., Decimal).

Returns:

List of supported SQL types.

isSchemaCreationSupported

public boolean isSchemaCreationSupported(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the flag for the database schema creation support.

Specified by:

isSchemaCreationSupported in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

true if database schema creation is supported.

areTransactionsToBeIgnored

public boolean areTransactionsToBeIgnored(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the flag which indicates whether transactions are to be ignored.

Specified by:

areTransactionsToBeIgnored in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

true if transactions should be ignored.

getDefaultStringIdentityStrategy

public java.lang.String getDefaultStringIdentityStrategy(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the default string identity strategy.

Specified by:

getDefaultStringIdentityStrategy in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

Identity strategy name or null if not defined.

getDefaultNumericIdentityStrategy

public java.lang.String getDefaultNumericIdentityStrategy(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the default numeric identity strategy type.

Specified by:

getDefaultNumericIdentityStrategy in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

Identity strategy name or null if not defined.

isReadOnlyModeSupported

public boolean isReadOnlyModeSupported(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the flag for the read only mode support.

Specified by:

isReadOnlyModeSupported in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

true if read only mode is supported.

isGetGeneratedKeysSupported

public boolean isGetGeneratedKeysSupported(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the flag for the getGeneratedKeys support.

Specified by:

isGetGeneratedKeysSupported in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

true if getGeneratedKeys is supported.

areCatalogsSupported

public boolean areCatalogsSupported(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the flag for the catalogs support.

Specified by:

areCatalogsSupported in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

true if catalogs are supported.

getNumericIdentityStrategies

public java.util.Collection<java.lang.String> getNumericIdentityStrategies(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the list of numeric identity strategies

Specified by:

getNumericIdentityStrategies in interface IDatabaseDefinition

Parameters:

astrId - Database definition ID.

Returns:

Set of numeric identity strategies.

getStringIdentityStrategies

public java.util.Collection<java.lang.String> getStringIdentityStrategies(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the list of string identity strategies

Specified by:

getStringIdentityStrategies in interface IDatabaseDefinition

Parameters:

astrId - Database definition ID.

Returns:

Set of string identity strategies.

hasMandatoryValueStrategy

public boolean hasMandatoryValueStrategy(java.lang.String astrId)

Description copied from interface: IDatabaseDefinition

Retrieve the flag for the mandatory value strategy.

Specified by:

hasMandatoryValueStrategy in interface IDatabaseDefinition

Parameters:

astrId - database definition identifier whose validation query should be returned;

Returns:

true if the value strategy is mandatory.