org.jumpmind.symmetric.ddl.PlatformInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of symmetric-ddl Show documentation
Show all versions of symmetric-ddl Show documentation
This library is a fork of Apache DdlUtils. DdlUtils is a small, easy-to-use component for working with Database Definition (DDL) files.
package org.jumpmind.symmetric.ddl;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.lang.reflect.Field;
import java.sql.Types;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/*
* Contains information about the database platform such as supported features and native type mappings.
*/
public class PlatformInfo
{
/* The Log to which logging calls will be made. */
private final Log log = LogFactory.getLog(PlatformInfo.class);
// properties influencing the definition of columns
/* Whether the database requires the explicit stating of NULL as the default value. */
private boolean nullAsDefaultValueRequired = false;
/* Whether default values can be defined for LONGVARCHAR/LONGVARBINARY columns. */
private boolean defaultValuesForLongTypesSupported = true;
// properties influencing the specification of table constraints
/* Whether primary key constraints are embedded inside the create table statement. */
private boolean primaryKeyEmbedded = true;
/* Whether foreign key constraints are embedded inside the create table statement. */
private boolean foreignKeysEmbedded = false;
/* Whether embedded foreign key constraints are explicitly named. */
private boolean embeddedForeignKeysNamed = false;
/* Whether non-unique indices are supported. */
private boolean indicesSupported = true;
/* Whether indices are embedded inside the create table statement. */
private boolean indicesEmbedded = false;
private boolean triggersSupported = true;
/* Whether identity specification is supported for non-primary key columns. */
private boolean nonPKIdentityColumnsSupported = true;
/* Whether the auto-increment definition is done via the DEFAULT part of the column definition. */
private boolean defaultValueUsedForIdentitySpec = false;
// properties influencing the reading of models from live databases
/* Whether system indices (database-generated indices for primary and foreign keys) are returned when
reading a model from a database. */
private boolean systemIndicesReturned = true;
/* Whether system indices for foreign keys are always non-unique or can be
unique (i.e. if a primary key column is used to establish the foreign key). */
private boolean systemForeignKeyIndicesAlwaysNonUnique = false;
/* Whether the database returns a synthetic default value for non-identity required columns. */
private boolean syntheticDefaultValueForRequiredReturned = false;
/* Whether the platform is able to determine auto increment status from an existing database. */
private boolean identityStatusReadingSupported = true;
// other DDL/DML properties
/* Whether comments are supported. */
private boolean sqlCommentsSupported = true;
/* Whether delimited identifiers are supported or not. */
private boolean delimitedIdentifiersSupported = true;
/* Whether an ALTER TABLE is needed to drop indexes. */
private boolean alterTableForDropUsed = false;
/* Whether the platform allows for the explicit specification of values for identity columns in INSERT
and UPDATE statements. */
private boolean identityOverrideAllowed = true;
/* Whether the values of identity columns can be read back from the database after insertion. */
private boolean lastIdentityValueReadable = true;
/* Whether auto-commit mode for the reading of the values of identity columns after insertion
shall be used. */
private boolean autoCommitModeForLastIdentityValueReading = true;
/* Specifies the maximum length that a table name can have for this database (-1 if there is no limit). */
private int maxTableNameLength = -1;
/* Specifies the maximum length that a column name can have for this database (-1 if there is no limit). */
private int maxColumnNameLength = -1;
/* Specifies the maximum length that a constraint name can have for this database (-1 if there is no limit). */
private int maxConstraintNameLength = -1;
/* Specifies the maximum length that a foreign key name can have for this database (-1 if there is no limit). */
private int maxForeignKeyNameLength = -1;
/* The string used for delimiting SQL identifiers, eg. table names, column names etc. */
private String delimiterToken = "\"";
/* The string used for escaping values when generating textual SQL statements. */
private String valueQuoteToken = "'";
/* The string that starts a comment. */
private String commentPrefix = "--";
/* The string that ends a comment. */
private String commentSuffix = "";
/* The text separating individual sql commands. */
private String sqlCommandDelimiter = ";";
private boolean storesUpperCaseInCatalog = false;
/* Contains non-default mappings from jdbc to native types. */
private Map nativeTypes = new HashMap();
/* Contains the jdbc types corresponding to the native types for non-default mappings. */
private Map targetJdbcTypes = new HashMap();
/* Contains those JDBC types whose corresponding native types have a null value as the default value. */
private Set typesWithNullDefault = new HashSet();
/* Contains those JDBC types whose corresponding native types are types that have a size on this platform. */
private Set typesWithSize = new HashSet();
/* Contains the default sizes for those JDBC types whose corresponding native types require a size. */
private Map typesDefaultSizes = new HashMap();
/* Contains those JDBC types whose corresponding native types are types that have precision and scale on this platform. */
private HashSet typesWithPrecisionAndScale = new HashSet();
/*
* Creates a new platform info object.
*/
public PlatformInfo()
{
this.typesWithNullDefault.add(new Integer(Types.CHAR));
this.typesWithNullDefault.add(new Integer(Types.VARCHAR));
this.typesWithNullDefault.add(new Integer(Types.LONGVARCHAR));
this.typesWithNullDefault.add(new Integer(Types.CLOB));
this.typesWithNullDefault.add(new Integer(Types.BINARY));
this.typesWithNullDefault.add(new Integer(Types.VARBINARY));
this.typesWithNullDefault.add(new Integer(Types.LONGVARBINARY));
this.typesWithNullDefault.add(new Integer(Types.BLOB));
this.typesWithSize.add(new Integer(Types.CHAR));
this.typesWithSize.add(new Integer(Types.VARCHAR));
this.typesWithSize.add(new Integer(Types.BINARY));
this.typesWithSize.add(new Integer(Types.VARBINARY));
this.typesWithPrecisionAndScale.add(new Integer(Types.DECIMAL));
this.typesWithPrecisionAndScale.add(new Integer(Types.NUMERIC));
}
// properties influencing the definition of columns
/*
* Determines whether a NULL needs to be explicitly stated when the column
* has no specified default value. Default is false.
*
* @return true if NULL must be written for empty default values
*/
public boolean isNullAsDefaultValueRequired()
{
return nullAsDefaultValueRequired;
}
/*
* Specifies whether a NULL needs to be explicitly stated when the column
* has no specified default value. Default is false.
*
* @param requiresNullAsDefaultValue Whether NULL must be written for empty
* default values
*/
public void setNullAsDefaultValueRequired(boolean requiresNullAsDefaultValue)
{
this.nullAsDefaultValueRequired = requiresNullAsDefaultValue;
}
/*
* Determines whether default values can be specified for LONGVARCHAR/LONGVARBINARY columns.
*
* @return true if default values are allowed
*/
public boolean isDefaultValuesForLongTypesSupported()
{
return defaultValuesForLongTypesSupported;
}
/*
* Specifies whether default values can be specified for LONGVARCHAR/LONGVARBINARY columns.
*
* @param isSupported true if default values are supported
*/
public void setDefaultValuesForLongTypesSupported(boolean isSupported)
{
this.defaultValuesForLongTypesSupported = isSupported;
}
// properties influencing the specification of table constraints
/*
* Determines whether primary key constraints are embedded in the create
* table clause or as seperate alter table statements. The default is
* embedded pks.
*
* @return true if pk constraints are embedded
*/
public boolean isPrimaryKeyEmbedded()
{
return primaryKeyEmbedded;
}
/*
* Specifies whether the primary key constraints are embedded in the create
* table clause or as seperate alter table statements.
*
* @param primaryKeyEmbedded Whether pk constraints are embedded
*/
public void setPrimaryKeyEmbedded(boolean primaryKeyEmbedded)
{
this.primaryKeyEmbedded = primaryKeyEmbedded;
}
/*
* Determines whether foreign key constraints are embedded in the create
* table clause or as seperate alter table statements. Per default,
* foreign keys are external.
*
* @return true if fk constraints are embedded
*/
public boolean isForeignKeysEmbedded()
{
return foreignKeysEmbedded;
}
/*
* Specifies whether foreign key constraints are embedded in the create
* table clause or as seperate alter table statements.
*
* @param foreignKeysEmbedded Whether fk constraints are embedded
*/
public void setForeignKeysEmbedded(boolean foreignKeysEmbedded)
{
this.foreignKeysEmbedded = foreignKeysEmbedded;
}
/*
* Returns whether embedded foreign key constraints should have a name.
*
* @return true if embedded fks have name
*/
public boolean isEmbeddedForeignKeysNamed()
{
return embeddedForeignKeysNamed;
}
/*
* Specifies whether embedded foreign key constraints should be named.
*
* @param embeddedForeignKeysNamed Whether embedded fks shall have a name
*/
public void setEmbeddedForeignKeysNamed(boolean embeddedForeignKeysNamed)
{
this.embeddedForeignKeysNamed = embeddedForeignKeysNamed;
}
/*
* Determines whether indices are supported.
*
* @return true if indices are supported
*/
public boolean isIndicesSupported()
{
return indicesSupported;
}
/*
* Specifies whether indices are supported.
*
* @param supportingIndices true if indices are supported
*/
public void setIndicesSupported(boolean supportingIndices)
{
this.indicesSupported = supportingIndices;
}
/*
* Determines whether the indices are embedded in the create table clause
* or as seperate statements. Per default, indices are external.
*
* @return true if indices are embedded
*/
public boolean isIndicesEmbedded()
{
return indicesEmbedded;
}
/*
* Specifies whether indices are embedded in the create table clause or
* as seperate alter table statements.
*
* @param indicesEmbedded Whether indices are embedded
*/
public void setIndicesEmbedded(boolean indicesEmbedded)
{
this.indicesEmbedded = indicesEmbedded;
}
/*
* Determines whether non-primary key columns can be auto-incrementing (IDENTITY columns).
*
* @return true if normal non-PK columns can be auto-incrementing
*/
public boolean isNonPKIdentityColumnsSupported()
{
return nonPKIdentityColumnsSupported;
}
/*
* Specifies whether non-primary key columns can be auto-incrementing (IDENTITY columns).
*
* @param supportingNonPKIdentityColumns true if normal non-PK columns can
* be auto-incrementing
*/
public void setNonPKIdentityColumnsSupported(boolean supportingNonPKIdentityColumns)
{
this.nonPKIdentityColumnsSupported = supportingNonPKIdentityColumns;
}
/*
* Determines whether the auto-increment specification uses the DEFAULT value of the
* column definition.
*
* @return true if the auto-increment spec is done via the DEFAULT value
*/
public boolean isDefaultValueUsedForIdentitySpec()
{
return defaultValueUsedForIdentitySpec;
}
/*
* Specifies whether the auto-increment specification uses the DEFAULT value of the
* column definition.
*
* @param identitySpecUsesDefaultValue true if the auto-increment spec is
* done via the DEFAULT value
*/
public void setDefaultValueUsedForIdentitySpec(boolean identitySpecUsesDefaultValue)
{
this.defaultValueUsedForIdentitySpec = identitySpecUsesDefaultValue;
}
// properties influencing the reading of models from live databases
/*
* Determines whether database-generated indices for primary and foreign keys are
* returned when reading a model from a database.
*
* @return true if system indices are read from a live database
*/
public boolean isSystemIndicesReturned()
{
return systemIndicesReturned;
}
/*
* Specifies whether database-generated indices for primary and foreign keys are
* returned when reading a model from a database.
*
* @param returningSystemIndices true if system indices are read from
* a live database
*/
public void setSystemIndicesReturned(boolean returningSystemIndices)
{
this.systemIndicesReturned = returningSystemIndices;
}
/*
* Determines whether system indices for foreign keys are always non-unique or can be
* unique (i.e. if a primary key column is used to establish the foreign key).
*
* @return true if system foreign key indices are always non-unique;
* default is false
*/
public boolean isSystemForeignKeyIndicesAlwaysNonUnique()
{
return systemForeignKeyIndicesAlwaysNonUnique;
}
/*
* Specifies whether system indices for foreign keys are always non-unique or can be
* unique (i.e. if a primary key column is used to establish the foreign key).
*
* @param alwaysNonUnique true if system foreign key indices are always
* non-unique
*/
public void setSystemForeignKeyIndicesAlwaysNonUnique(boolean alwaysNonUnique)
{
this.systemForeignKeyIndicesAlwaysNonUnique = alwaysNonUnique;
}
/*
* Determines whether the platform returns synthetic default values (e.g. 0 for numeric
* columns etc.) for non-identity required columns when reading a model from a database.
*
* @return true if synthetic default values are returned for non-identity
* required columns
*/
public boolean isSyntheticDefaultValueForRequiredReturned()
{
return syntheticDefaultValueForRequiredReturned;
}
/*
* Specifies whether the platform returns synthetic default values (e.g. 0 for numeric
* columns etc.) for non-identity required columns when reading a model from a database.
*
* @param returningDefaultValue true if synthetic default values are returned for
* non-identity required columns
*/
public void setSyntheticDefaultValueForRequiredReturned(boolean returningDefaultValue)
{
this.syntheticDefaultValueForRequiredReturned = returningDefaultValue;
}
/*
* Determines whether the platform is able to read the auto-increment status for columns
* from an existing database.
*
* @return true if the auto-increment status can be determined from an existing
* database
*/
public boolean getIdentityStatusReadingSupported()
{
return identityStatusReadingSupported;
}
/*
* Specifies whether the platform is able to read the auto-increment status for columns
* from an existing database.
*
* @param canReadAutoIncrementStatus true if the auto-increment status can be
* determined from an existing database
*/
public void setIdentityStatusReadingSupported(boolean canReadAutoIncrementStatus)
{
this.identityStatusReadingSupported = canReadAutoIncrementStatus;
}
// other ddl properties
/*
* Determines whether the database supports SQL comments.
*
* @return true if comments are supported
*/
public boolean isSqlCommentsSupported()
{
return sqlCommentsSupported;
}
/*
* Specifies whether SQL comments are supported by the database.
*
* @param commentsSupported true if comments are supported
*/
public void setSqlCommentsSupported(boolean commentsSupported)
{
this.sqlCommentsSupported = commentsSupported;
}
/*
* Determines whether delimited identifiers are supported.
*
* @return true if delimited identifiers are supported
*/
public boolean isDelimitedIdentifiersSupported()
{
return delimitedIdentifiersSupported;
}
/*
* Specifies whether delimited identifiers are supported.
*
* @param areSupported true if delimited identifiers are supported
*/
public void setDelimitedIdentifiersSupported(boolean areSupported)
{
this.delimitedIdentifiersSupported = areSupported;
}
/*
* Determines whether an ALTER TABLE statement shall be used for dropping indices
* or constraints. The default is false.
*
* @return true if ALTER TABLE is required
*/
public boolean isAlterTableForDropUsed()
{
return alterTableForDropUsed;
}
/*
* Specifies whether an ALTER TABLE statement shall be used for dropping indices
* or constraints.
*
* @param useAlterTableForDrop Whether ALTER TABLE will be used
*/
public void setAlterTableForDropUsed(boolean useAlterTableForDrop)
{
this.alterTableForDropUsed = useAlterTableForDrop;
}
/*
* Determines whether the platform is allows the explicit specification of values for
* identity columns in INSERT/UPDATE statements.
*
* @return true if values for identity columns can be specified
*/
public boolean isIdentityOverrideAllowed()
{
return identityOverrideAllowed;
}
/*
* Specifies whether the platform is allows the explicit specification of values for
* identity columns in INSERT/UPDATE statements.
*
* @param identityOverrideAllowed true if values for identity columns can be specified
*/
public void setIdentityOverrideAllowed(boolean identityOverrideAllowed)
{
this.identityOverrideAllowed = identityOverrideAllowed;
}
/*
* Determines whether the values of identity columns can be read back from the
* database after insertion of a row.
*
* @return true if the identity column(s) can be read back
*/
public boolean isLastIdentityValueReadable()
{
return lastIdentityValueReadable;
}
/*
* Specifies whether the values of identity columns can be read back from the
* database after insertion of a row.
*
* @param lastIdentityValueReadable true if the identity column(s) can be read back
*/
public void setLastIdentityValueReadable(boolean lastIdentityValueReadable)
{
this.lastIdentityValueReadable = lastIdentityValueReadable;
}
/*
* Determines whether auto-commit mode for the reading of the values of identity columns
* after insertion shall be used, i.e. whether between the insertion of the row and the
* reading of the database-generated identity value a commit is issued.
*
* @return true if auto-commit mode is used
*/
public boolean isAutoCommitModeForLastIdentityValueReading()
{
return autoCommitModeForLastIdentityValueReading;
}
/*
* Determines whether auto-commit mode for the reading of the values of identity columns
* after insertion shall be used, i.e. whether between the insertion of the row and the
* reading of the database-generated identity value a commit is issued.
*
* @param autoCommitModeForLastIdentityValueReading true if auto-commit mode
* shall be used
*/
public void setAutoCommitModeForLastIdentityValueReading(boolean autoCommitModeForLastIdentityValueReading)
{
this.autoCommitModeForLastIdentityValueReading = autoCommitModeForLastIdentityValueReading;
}
/*
* Returns the maximum number of characters that a table name can have.
*
* @return The number of characters, or -1 if not limited
*/
public int getMaxTableNameLength()
{
return maxTableNameLength;
}
/*
* Returns the maximum number of characters that a column name can have.
*
* @return The number of characters, or -1 if not limited
*/
public int getMaxColumnNameLength()
{
return maxColumnNameLength;
}
/*
* Returns the maximum number of characters that a constraint name can have.
*
* @return The number of characters, or -1 if not limited
*/
public int getMaxConstraintNameLength()
{
return maxConstraintNameLength;
}
/*
* Returns the maximum number of characters that a foreign key name can have.
*
* @return The number of characters, or -1 if not limited
*/
public int getMaxForeignKeyNameLength()
{
return maxForeignKeyNameLength;
}
/*
* Sets the maximum length of all identifiers that this database allows.
* Use this method if the length limit is the same for all kinds of identifiers.
*
* @param maxIdentifierLength The maximum identifier length, -1 if unlimited
*/
public void setMaxIdentifierLength(int maxIdentifierLength)
{
this.maxTableNameLength = maxIdentifierLength;
this.maxColumnNameLength = maxIdentifierLength;
this.maxConstraintNameLength = maxIdentifierLength;
this.maxForeignKeyNameLength = maxIdentifierLength;
}
/*
* Sets the maximum length of table names that this database allows.
*
* @param maxTableNameLength The maximum length, -1 if unlimited
*/
public void setMaxTableNameLength(int maxTableNameLength)
{
this.maxTableNameLength = maxTableNameLength;
}
/*
* Sets the maximum length of column names that this database allows.
*
* @param maxColumnNameLength The maximum length, -1 if unlimited
*/
public void setMaxColumnNameLength(int maxColumnNameLength)
{
this.maxColumnNameLength = maxColumnNameLength;
}
/*
* Sets the maximum length of constraint names that this database allows.
*
* @param maxConstraintNameLength The maximum length, -1 if unlimited
*/
public void setMaxConstraintNameLength(int maxConstraintNameLength)
{
this.maxConstraintNameLength = maxConstraintNameLength;
}
/*
* Sets the maximum length of foreign key names that this database allows.
*
* @param maxForeignKeyNameLength The maximum length, -1 if unlimited
*/
public void setMaxForeignKeyNameLength(int maxForeignKeyNameLength)
{
this.maxForeignKeyNameLength = maxForeignKeyNameLength;
}
/*
* Returns the text that is used to delimit identifiers (eg. table names).
* Per default, this is a double quotation character (").
*
* @return The delimiter text
*/
public String getDelimiterToken()
{
return delimiterToken;
}
/*
* Sets the text that is used to delimit identifiers (eg. table names).
*
* @param delimiterToken The delimiter text
*/
public void setDelimiterToken(String delimiterToken)
{
this.delimiterToken = delimiterToken;
}
/*
* Returns the text that is used for for quoting values (e.g. text) when
* printing default values and in generates insert/update/delete statements.
* Per default, this is a single quotation character (').
*
* @return The quote text
*/
public String getValueQuoteToken()
{
return valueQuoteToken;
}
/*
* Sets the text that is used for for quoting values (e.g. text) when
* printing default values and in generates insert/update/delete statements.
*
* @param valueQuoteChar The new quote text
*/
public void setValueQuoteToken(String valueQuoteChar)
{
this.valueQuoteToken = valueQuoteChar;
}
/*
* Returns the string that denotes the beginning of a comment.
*
* @return The comment prefix
*/
public String getCommentPrefix()
{
return commentPrefix;
}
/*
* Sets the text that starts a comment.
*
* @param commentPrefix The new comment prefix
*/
public void setCommentPrefix(String commentPrefix)
{
this.commentPrefix = (commentPrefix == null ? "" : commentPrefix);
}
/*
* Returns the string that denotes the end of a comment. Note that comments will
* be always on their own line.
*
* @return The comment suffix
*/
public String getCommentSuffix()
{
return commentSuffix;
}
/*
* Sets the text that ends a comment.
*
* @param commentSuffix The new comment suffix
*/
public void setCommentSuffix(String commentSuffix)
{
this.commentSuffix = (commentSuffix == null ? "" : commentSuffix);
}
/*
* Returns the text separating individual sql commands.
*
* @return The delimiter text
*/
public String getSqlCommandDelimiter()
{
return sqlCommandDelimiter;
}
/*
* Sets the text separating individual sql commands.
*
* @param sqlCommandDelimiter The delimiter text
*/
public void setSqlCommandDelimiter(String sqlCommandDelimiter)
{
this.sqlCommandDelimiter = sqlCommandDelimiter;
}
/*
* Returns the database-native type for the given type code.
*
* @param typeCode The {@link java.sql.Types} type code
* @return The native type or null if there isn't one defined
*/
public String getNativeType(int typeCode)
{
return (String)this.nativeTypes.get(new Integer(typeCode));
}
/*
* Returns the jdbc type corresponding to the native type that is used for the given
* jdbc type. This is most often the same jdbc type, but can also be a different one.
* For instance, if a database has no native boolean type, then the source jdbc type
* would be BIT or BOOLEAN, and the target jdbc type might
* be TINYINT or SMALLINT.
*
* @param typeCode The {@link java.sql.Types} type code
* @return The target jdbc type
*/
public int getTargetJdbcType(int typeCode)
{
Integer targetJdbcType = (Integer)targetJdbcTypes.get(new Integer(typeCode));
return targetJdbcType == null ? typeCode : targetJdbcType.intValue();
}
/*
* Adds a mapping from jdbc type to database-native type.
*
* @param jdbcTypeCode The jdbc type code as defined by {@link java.sql.Types}
* @param nativeType The native type
*/
public void addNativeTypeMapping(int jdbcTypeCode, String nativeType)
{
this.nativeTypes.put(new Integer(jdbcTypeCode), nativeType);
}
/*
* Adds a mapping from jdbc type to database-native type.
*
* @param jdbcTypeCode The jdbc type code as defined by {@link java.sql.Types}
* @param nativeType The native type
* @param targetJdbcTypeCode The jdbc type code corresponding to the native type
* (e.g. when reading the model from the database)
*/
public void addNativeTypeMapping(int jdbcTypeCode, String nativeType, int targetJdbcTypeCode)
{
addNativeTypeMapping(jdbcTypeCode, nativeType);
this.targetJdbcTypes.put(new Integer(jdbcTypeCode), new Integer(targetJdbcTypeCode));
}
/*
* Adds a mapping from jdbc type to database-native type. Note that this
* method accesses the named constant in {@link java.sql.Types} via reflection
* and is thus safe to use under JDK 1.2/1.3 even with constants defined
* only in later Java versions - for these, the method simply will not add
* a mapping.
*
* @param jdbcTypeName The jdbc type name, one of the constants defined in
* {@link java.sql.Types}
* @param nativeType The native type
*/
public void addNativeTypeMapping(String jdbcTypeName, String nativeType)
{
try
{
Field constant = Types.class.getField(jdbcTypeName);
if (constant != null)
{
addNativeTypeMapping(constant.getInt(null), nativeType);
}
}
catch (Exception ex)
{
// ignore -> won't be defined
this.log.warn("Cannot add native type mapping for undefined jdbc type "+jdbcTypeName, ex);
}
}
/*
* Adds a mapping from jdbc type to database-native type. Note that this
* method accesses the named constant in {@link java.sql.Types} via reflection
* and is thus safe to use under JDK 1.2/1.3 even with constants defined
* only in later Java versions - for these, the method simply will not add
* a mapping.
*
* @param jdbcTypeName The jdbc type name, one of the constants defined
* in {@link java.sql.Types}
* @param nativeType The native type
* @param targetJdbcTypeName The jdbc type corresponding to the native type
* (e.g. when reading the model from the database)
*/
public void addNativeTypeMapping(String jdbcTypeName, String nativeType, String targetJdbcTypeName)
{
try
{
Field sourceType = Types.class.getField(jdbcTypeName);
Field targetType = Types.class.getField(targetJdbcTypeName);
if ((sourceType != null) && (targetType != null))
{
addNativeTypeMapping(sourceType.getInt(null), nativeType, targetType.getInt(null));
}
}
catch (Exception ex)
{
// ignore -> won't be defined
this.log.warn("Cannot add native type mapping for undefined jdbc type "+jdbcTypeName+", target jdbc type "+targetJdbcTypeName, ex);
}
}
/*
* Determines whether the native type for the given sql type code (one of the
* {@link java.sql.Types} constants) has a null default value on this platform.
*
* @param sqlTypeCode The sql type code
* @return true if the native type has a null default value
*/
public boolean hasNullDefault(int sqlTypeCode)
{
return typesWithNullDefault.contains(new Integer(sqlTypeCode));
}
/*
* Specifies whether the native type for the given sql type code (one of the
* {@link java.sql.Types} constants) has a null default value on this platform.
*
* @param sqlTypeCode The sql type code
* @param hasNullDefault true if the native type has a null default value
*/
public void setHasNullDefault(int sqlTypeCode, boolean hasNullDefault)
{
if (hasNullDefault)
{
this.typesWithNullDefault.add(new Integer(sqlTypeCode));
}
else
{
this.typesWithNullDefault.remove(new Integer(sqlTypeCode));
}
}
/*
* Determines whether the native type for the given sql type code (one of the
* {@link java.sql.Types} constants) has a size specification on this platform.
*
* @param sqlTypeCode The sql type code
* @return true if the native type has a size specification
*/
public boolean hasSize(int sqlTypeCode)
{
return typesWithSize.contains(new Integer(sqlTypeCode));
}
/*
* Specifies whether the native type for the given sql type code (one of the
* {@link java.sql.Types} constants) has a size specification on this platform.
*
* @param sqlTypeCode The sql type code
* @param hasSize true if the native type has a size specification
*/
public void setHasSize(int sqlTypeCode, boolean hasSize)
{
if (hasSize)
{
this.typesWithSize.add(new Integer(sqlTypeCode));
}
else
{
this.typesWithSize.remove(new Integer(sqlTypeCode));
}
}
/*
* Returns the default size value for the given type, if any.
*
* @param jdbcTypeCode The jdbc type code
* @return The default size or null if none is defined
*/
public Integer getDefaultSize(int jdbcTypeCode)
{
return (Integer)typesDefaultSizes.get(new Integer(jdbcTypeCode));
}
/*
* Adds a default size for the given jdbc type.
*
* @param jdbcTypeCode The jdbc type code
* @param defaultSize The default size
*/
public void setDefaultSize(int jdbcTypeCode, int defaultSize)
{
this.typesDefaultSizes.put(new Integer(jdbcTypeCode), new Integer(defaultSize));
}
/*
* Adds a default size for the given jdbc type.
*
* @param jdbcTypeName The name of the jdbc type, one of the {@link Types} constants
* @param defaultSize The default size
*/
public void setDefaultSize(String jdbcTypeName, int defaultSize)
{
try
{
Field constant = Types.class.getField(jdbcTypeName);
if (constant != null)
{
setDefaultSize(constant.getInt(null), defaultSize);
}
}
catch (Exception ex)
{
// ignore -> won't be defined
this.log.warn("Cannot add default size for undefined jdbc type "+jdbcTypeName, ex);
}
}
/*
* Determines whether the native type for the given sql type code (one of the
* {@link java.sql.Types} constants) has precision and scale specifications on
* this platform.
*
* @param sqlTypeCode The sql type code
* @return true if the native type has precision and scale specifications
*/
public boolean hasPrecisionAndScale(int sqlTypeCode)
{
return typesWithPrecisionAndScale.contains(new Integer(sqlTypeCode));
}
/*
* Specifies whether the native type for the given sql type code (one of the
* {@link java.sql.Types} constants) has precision and scale specifications on
* this platform.
*
* @param sqlTypeCode The sql type code
* @param hasPrecisionAndScale true if the native type has precision and scale specifications
*/
public void setHasPrecisionAndScale(int sqlTypeCode, boolean hasPrecisionAndScale)
{
if (hasPrecisionAndScale)
{
this.typesWithPrecisionAndScale.add(new Integer(sqlTypeCode));
}
else
{
this.typesWithPrecisionAndScale.remove(new Integer(sqlTypeCode));
}
}
public void setStoresUpperCaseInCatalog(boolean storesUpperCaseInCatalog) {
this.storesUpperCaseInCatalog = storesUpperCaseInCatalog;
}
public boolean isStoresUpperCaseInCatalog() {
return storesUpperCaseInCatalog;
}
public void setTriggersSupported(boolean triggersSupported) {
this.triggersSupported = triggersSupported;
}
public boolean isTriggersSupported() {
return triggersSupported;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy