|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jpox.store.rdbms.typeinfo.TypeInfo
Represents the metadata of a specific JDBC data type. This class is
basically a data structure that makes accessing the JDBC type metadata
easier. Each of the columns of information returned by
DatabaseMetaData.getTypeInfo()
is represented by a
public field in this class.
Subclasses of TypeInfo can be created on a per-DBMS basis to supply missing metadata or correct faulty metadata obtained from that DBMS's JDBC driver(s).
DatabaseMetaData.getTypeInfo()
Field Summary | |
boolean |
allowsPrecisionSpec
This is not defined in the JDBC type info, and defines if the type allows specification of the precision in parentheses after the type name. |
boolean |
autoIncrement
true indicates the type automatically increments for each new row inserted, false otherwise. |
boolean |
caseSensitive
true indicates this data type is case-sensitive in comparisons, false otherwise. |
java.lang.String |
createParams
Indicates the parameters used in defining columns of this type. |
short |
dataType
The JDBC (SQL) data type number of this data type. |
boolean |
fixedPrecScale
true indicates the type can be assigned a fixed scale value, such as for decimal or currency types, false otherwise. |
java.lang.String |
literalPrefix
The prefix used to quote a literal of this data type; may be null. |
java.lang.String |
literalSuffix
The suffix used to quote a literal of this data type; may be null. |
java.lang.String |
localTypeName
Localized version of the DBMS-specific type name of this data type. |
short |
maximumScale
The maximum supported scale value for this data type. |
short |
minimumScale
The minimum supported scale value for this data type. |
int |
nullable
Indicates whether null values are allowed for this data type. |
int |
numPrecRadix
Indicates the numeric radix of this data type, which is usually 2 or 10. |
int |
precision
The maximum precision/length allowed for this data type. |
short |
searchable
Indicates searchability of this data type in terms of the kinds of SQL WHERE clauses that are allowed. |
java.lang.String |
typeName
The DBMS-specific name for this data type. |
boolean |
unsignedAttribute
true indicates the type is unsigned, false otherwise. |
Constructor Summary | |
TypeInfo(java.sql.ResultSet rs)
Constructs a type information objectd from the current row of the given result set. |
|
TypeInfo(java.lang.String typeName,
short dataType,
int precision,
java.lang.String literalPrefix,
java.lang.String literalSuffix,
java.lang.String createParams,
int nullable,
boolean caseSensitive,
short searchable,
boolean unsignedAttribute,
boolean fixedPrecScale,
boolean autoIncrement,
java.lang.String localTypeName,
short minimumScale,
short maximumScale,
int numPrecRadix)
/** Constructs a type information object from its individual attributes. |
Method Summary | |
static boolean |
areCompatibleTypes(int expected,
int actual)
Method to return if 2 types are compatible. |
boolean |
equals(java.lang.Object obj)
Indicates whether some object is "equal to" this one. |
static java.lang.String |
getJDBCTypeName(int type)
Returns the string name of the Java constant that equals the given JDBC type number type. |
int |
hashCode()
Returns a hash code value for this object. |
boolean |
isCompatibleWith(ColumnInfo ci)
Indicates whether the type of a given database column is "compatible" with this type. |
boolean |
isToValidate(ColumnInfo ci)
Indicates whether validate columns with certain types |
java.lang.String |
toString()
Returns the string representation of this object. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public java.lang.String typeName
public short dataType
public int precision
public java.lang.String literalPrefix
public java.lang.String literalSuffix
public java.lang.String createParams
public int nullable
DatabaseMetaData.typeNoNulls
,
DatabaseMetaData.typeNullable
,
DatabaseMetaData.typeNullableUnknown
public boolean caseSensitive
public short searchable
DatabaseMetaData.typePredNone
,
DatabaseMetaData.typePredChar
,
DatabaseMetaData.typePredBasic
,
DatabaseMetaData.typeSearchable
public boolean unsignedAttribute
public boolean fixedPrecScale
public boolean autoIncrement
public java.lang.String localTypeName
public short minimumScale
public short maximumScale
public int numPrecRadix
public boolean allowsPrecisionSpec
Constructor Detail |
public TypeInfo(java.sql.ResultSet rs) throws javax.jdo.JDOFatalDataStoreException
ResultSet
object passed must have been obtained
from a call to java.sql.DatabaseMetaData.getTypeInfo().
This method only retrieves the values from the current row; the caller
is required to advance to the next row with ResultSet.next()
.
rs
- The result set returned from
java.sql.DatabaseMetaData.getTypeInfo().
javax.jdo.JDOFatalDataStoreException
- if a column of type information could not be retrieved from the
result set.public TypeInfo(java.lang.String typeName, short dataType, int precision, java.lang.String literalPrefix, java.lang.String literalSuffix, java.lang.String createParams, int nullable, boolean caseSensitive, short searchable, boolean unsignedAttribute, boolean fixedPrecScale, boolean autoIncrement, java.lang.String localTypeName, short minimumScale, short maximumScale, int numPrecRadix)
This can be useful to subclasses and/or custom DatabaseAdapters that need to modify and/or correct the metadata returned by the JDBC driver.
typeName
- dataType
- precision
- literalPrefix
- literalSuffix
- createParams
- nullable
- caseSensitive
- searchable
- unsignedAttribute
- fixedPrecScale
- autoIncrement
- localTypeName
- minimumScale
- maximumScale
- numPrecRadix
- Method Detail |
public boolean isCompatibleWith(ColumnInfo ci)
ci
- The ColumnInfo
public boolean isToValidate(ColumnInfo ci)
ci
- The ColumnInfo
public boolean equals(java.lang.Object obj)
obj
- the reference object with which to compare
public int hashCode()
public java.lang.String toString()
public static java.lang.String getJDBCTypeName(int type)
Types
.
If type is not equal to one of the known type numbers, the string "Unrecognized type (type)" is returned.
type
- the JDBC type number.
Types
.public static boolean areCompatibleTypes(int expected, int actual)
expected
- The expectedactual
- The actual
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |