org.jboss.dna.common.jdbc.model.api
Interface SqlTypeInfo

All Superinterfaces:

CoreMetaData, DatabaseNamedObject, Serializable

All Known Implementing Classes:

SqlTypeInfoBean

public interface SqlTypeInfo
extends DatabaseNamedObject

Provides RDBMS supported standatd SQL types info.

Author:

Sergiy Litsenko

Method Summary

String	getCreateParams() Returns parameters used in creating the type (may be null)
String	getLiteralPrefix() Returns prefix used to quote a literal (may be null)
String	getLiteralSuffix() Returns suffix used to quote a literal (may be null)
String	getLocalizedTypeName() Returns localized version of type name (may be null).
Integer	getMaxScale() Returns maximum scale supported
Integer	getMinScale() Returns minimum scale supported
NullabilityType	getNullabilityType() Gets SQL type nullability
Integer	getNumberPrecisionRadix() Returns sql type precision radix (usually 2 or 10)
Long	getPrecision() Gets precision (number of fractional digits/scale) if applicable otherwise 0.
SearchabilityType	getSearchabilityType() Returns sql type searchability
SqlType	getSqlType() Gets SQL type from java.sql.Types
Boolean	isAutoIncrement() Returns true if sql type can be used for an auto-increment value.
Boolean	isCaseSensitive() Is sql type case sensitive
Boolean	isFixedPrecisionScale() Returns true if sql type can be a money value, for instance
Boolean	isUnsigned() Returns true if sql type is unsigned
void	setAutoIncrement(Boolean autoIncrement) Sets true if sql type can be used for an auto-increment value.
void	setCaseSensitive(Boolean caseSensitive) Is sql type case sensitive
void	setCreateParams(String createParams) Sets parameters used in creating the type (may be null)
void	setFixedPrecisionScale(Boolean fixedPrecisionScale) Sets true if sql type can be a money value, for instance
void	setLiteralPrefix(String literalPrefix) Sets prefix used to quote a literal (may be null)
void	setLiteralSuffix(String literalSuffix) Sets suffix used to quote a literal (may be null)
void	setLocalizedTypeName(String localizedTypeName) Sets localized version of type name (may be null).
void	setMaxScale(Integer maxScale) Sets maximum scale supported
void	setMinScale(Integer minScale) Sets minimum scale supported
void	setNullabilityType(NullabilityType nullabilityType) Sets SQL type nullability
void	setNumberPrecisionRadix(Integer numberPrecisionRadix) sets sql type precision radix (usually 2 or 10)
void	setPrecision(Long precision) Sets precision (number of fractional digits/scale) if applicable otherwise 0.
void	setSearchabilityType(SearchabilityType searchabilityType) Sets sql type searchability
void	setSqlType(SqlType sqlType) Sets SQL type from java.sql.Types
void	setUnsigned(Boolean unsigned) Sets true if sql type is unsigned

Methods inherited from interface org.jboss.dna.common.jdbc.model.api.DatabaseNamedObject

addExtraProperty, deleteExtraProperty, getExtraProperties, getExtraProperty, getName, getRemarks, setName, setRemarks

Method Detail

getLocalizedTypeName

String getLocalizedTypeName()

Returns localized version of type name (may be null). Type name is returned by DatabaseNamedObject.getName () method.

Returns:

localized version of type name (may be null)

setLocalizedTypeName

void setLocalizedTypeName(String localizedTypeName)

Sets localized version of type name (may be null). Type name is returned by DatabaseNamedObject.getName () method.

Parameters:

localizedTypeName - localized version of type name (may be null)

getNullabilityType

NullabilityType getNullabilityType()

Gets SQL type nullability

Returns:

SQL type nullability

setNullabilityType

void setNullabilityType(NullabilityType nullabilityType)

Sets SQL type nullability

Parameters:

nullabilityType - SQL type nullability

getSqlType

SqlType getSqlType()

Gets SQL type from java.sql.Types

Returns:

SQL type from java.sql.Types

setSqlType

void setSqlType(SqlType sqlType)

Sets SQL type from java.sql.Types

Parameters:

sqlType - the SQL type from java.sql.Types

getPrecision

Long getPrecision()

Gets precision (number of fractional digits/scale) if applicable otherwise 0.

Returns:

precision if applicable otherwise 0

setPrecision

void setPrecision(Long precision)

Sets precision (number of fractional digits/scale) if applicable otherwise 0.

Parameters:

precision - precision if applicable otherwise 0

isFixedPrecisionScale

Boolean isFixedPrecisionScale()

Returns true if sql type can be a money value, for instance

Returns:

true if sql type can be a money value, for instance

setFixedPrecisionScale

void setFixedPrecisionScale(Boolean fixedPrecisionScale)

Sets true if sql type can be a money value, for instance

Parameters:

fixedPrecisionScale - true if sql type can be a money value, for instance

getNumberPrecisionRadix

Integer getNumberPrecisionRadix()

Returns sql type precision radix (usually 2 or 10)

Returns:

sql type precision radix (usually 2 or 10)

setNumberPrecisionRadix

void setNumberPrecisionRadix(Integer numberPrecisionRadix)

sets sql type precision radix (usually 2 or 10)

Parameters:

numberPrecisionRadix - the sql type precision radix (usually 2 or 10)

getMinScale

Integer getMinScale()

Returns minimum scale supported

Returns:

minimum scale supported

setMinScale

void setMinScale(Integer minScale)

Sets minimum scale supported

Parameters:

minScale - minimum scale supported

getMaxScale

Integer getMaxScale()

Returns maximum scale supported

Returns:

maximum scale supported

setMaxScale

void setMaxScale(Integer maxScale)

Sets maximum scale supported

Parameters:

maxScale - the maximum scale supported

getLiteralPrefix

String getLiteralPrefix()

Returns prefix used to quote a literal (may be null)

Returns:

prefix used to quote a literal (may be null)

setLiteralPrefix

void setLiteralPrefix(String literalPrefix)

Sets prefix used to quote a literal (may be null)

Parameters:

literalPrefix - the prefix used to quote a literal (may be null)

getLiteralSuffix

String getLiteralSuffix()

Returns suffix used to quote a literal (may be null)

Returns:

suffix used to quote a literal (may be null)

setLiteralSuffix

void setLiteralSuffix(String literalSuffix)

Sets suffix used to quote a literal (may be null)

Parameters:

literalSuffix - the suffix used to quote a literal (may be null)

getCreateParams

String getCreateParams()

Returns parameters used in creating the type (may be null)

Returns:

parameters used in creating the type (may be null)

setCreateParams

void setCreateParams(String createParams)

Sets parameters used in creating the type (may be null)

Parameters:

createParams - the parameters used in creating the type (may be null)

isCaseSensitive

Boolean isCaseSensitive()

Is sql type case sensitive

Returns:

true if sql type case sensitive

setCaseSensitive

void setCaseSensitive(Boolean caseSensitive)

Is sql type case sensitive

Parameters:

caseSensitive - the true if sql type case sensitive

getSearchabilityType

SearchabilityType getSearchabilityType()

Returns sql type searchability

Returns:

sql type searchability

setSearchabilityType

void setSearchabilityType(SearchabilityType searchabilityType)

Sets sql type searchability

Parameters:

searchabilityType - the sql type searchability

isUnsigned

Boolean isUnsigned()

Returns true if sql type is unsigned

Returns:

true if sql type is unsigned

setUnsigned

void setUnsigned(Boolean unsigned)

Sets true if sql type is unsigned

Parameters:

unsigned - true if sql type is unsigned

isAutoIncrement

Boolean isAutoIncrement()

Returns true if sql type can be used for an auto-increment value.

Returns:

true if sql type can be used for an auto-increment value.

setAutoIncrement

void setAutoIncrement(Boolean autoIncrement)

Sets true if sql type can be used for an auto-increment value.

Parameters:

autoIncrement - true if sql type can be used for an auto-increment value.