org.postgresql.jdbc

Class TypeInfoCache

java.lang.Object

org.postgresql.jdbc.TypeInfoCache

All Implemented Interfaces:

TypeInfo

public class TypeInfoCache
extends java.lang.Object
implements TypeInfo

Constructor Summary

Constructors

Constructor and Description
TypeInfoCache(BaseConnection conn, int unknownLength)

Method Summary

Modifier and Type	Method and Description
void	addCoreType(java.lang.String pgTypeName, java.lang.Integer oid, java.lang.Integer sqlType, java.lang.String javaClass, java.lang.Integer arrayOid)
void	addDataType(java.lang.String type, java.lang.Class<? extends PGobject> klass)
protected int	convertArrayToBaseOid(int oid) Return the oid of the array's base element if it's an array, if not return the provided oid.
char	getArrayDelimiter(int oid) Determine the delimiter for the elements of the given array type oid.
int	getDisplaySize(int oid, int typmod)
java.lang.String	getJavaClass(int oid)
int	getMaximumPrecision(int oid)
int	getPGArrayElement(int oid) Look up the oid of an array's base type given the array's type oid.
int	getPGArrayType(java.lang.String elementTypeName) Determine the oid of the given base postgresql type's array type.
java.lang.Class<? extends PGobject>	getPGobject(java.lang.String type)
java.lang.String	getPGType(int oid) Look up the postgresql type name for a given oid.
int	getPGType(java.lang.String pgTypeName) Look up the oid for a given postgresql type name.
java.util.Iterator<java.lang.String>	getPGTypeNamesWithSQLTypes()
int	getPrecision(int oid, int typmod)
int	getScale(int oid, int typmod)
int	getSQLType(int oid) Look up the SQL typecode for a given type oid.
int	getSQLType(java.lang.String pgTypeName) Look up the SQL typecode for a given postgresql type name.
java.lang.String	getTypeForAlias(java.lang.String alias)
boolean	isCaseSensitive(int oid)
boolean	isSigned(int oid)
boolean	requiresQuoting(int oid)
boolean	requiresQuotingSqlType(int sqlType) Returns true if particular sqlType requires quoting.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeInfoCache

public TypeInfoCache(BaseConnection conn,
                     int unknownLength)

Method Detail

addCoreType

public void addCoreType(java.lang.String pgTypeName,
                        java.lang.Integer oid,
                        java.lang.Integer sqlType,
                        java.lang.String javaClass,
                        java.lang.Integer arrayOid)

Specified by:

addCoreType in interface TypeInfo

addDataType

public void addDataType(java.lang.String type,
                        java.lang.Class<? extends PGobject> klass)
                 throws java.sql.SQLException

Specified by:

addDataType in interface TypeInfo

Throws:

java.sql.SQLException

getPGTypeNamesWithSQLTypes

public java.util.Iterator<java.lang.String> getPGTypeNamesWithSQLTypes()

Specified by:

getPGTypeNamesWithSQLTypes in interface TypeInfo

getSQLType

public int getSQLType(int oid)
               throws java.sql.SQLException

Description copied from interface: TypeInfo

Look up the SQL typecode for a given type oid.

Specified by:

getSQLType in interface TypeInfo

Parameters:

oid - the type's OID

Returns:

the SQL type code (a constant from Types) for the type

Throws:

java.sql.SQLException - if an error occurs when retrieving sql type

getSQLType

public int getSQLType(java.lang.String pgTypeName)
               throws java.sql.SQLException

Description copied from interface: TypeInfo

Look up the SQL typecode for a given postgresql type name.

Specified by:

getSQLType in interface TypeInfo

Parameters:

pgTypeName - the server type name to look up

Returns:

the SQL type code (a constant from Types) for the type

Throws:

java.sql.SQLException - if an error occurs when retrieving sql type

getPGType

public int getPGType(java.lang.String pgTypeName)
              throws java.sql.SQLException

Description copied from interface: TypeInfo

Look up the oid for a given postgresql type name. This is the inverse of TypeInfo.getPGType(int).

Specified by:

getPGType in interface TypeInfo

Parameters:

pgTypeName - the server type name to look up

Returns:

the type's OID, or 0 if unknown

Throws:

java.sql.SQLException - if an error occurs when retrieving PG type

getPGType

public java.lang.String getPGType(int oid)
                           throws java.sql.SQLException

Description copied from interface: TypeInfo

Look up the postgresql type name for a given oid. This is the inverse of TypeInfo.getPGType(String).

Specified by:

getPGType in interface TypeInfo

Parameters:

oid - the type's OID

Returns:

the server type name for that OID or null if unknown

Throws:

java.sql.SQLException - if an error occurs when retrieving PG type

getPGArrayType

public int getPGArrayType(java.lang.String elementTypeName)
                   throws java.sql.SQLException

Description copied from interface: TypeInfo

Determine the oid of the given base postgresql type's array type.

Specified by:

getPGArrayType in interface TypeInfo

Parameters:

elementTypeName - the base type's

Returns:

the array type's OID, or 0 if unknown

Throws:

java.sql.SQLException - if an error occurs when retrieving array type

convertArrayToBaseOid

protected int convertArrayToBaseOid(int oid)

Return the oid of the array's base element if it's an array, if not return the provided oid. This doesn't do any database lookups, so it's only useful for the originally provided type mappings. This is fine for it's intended uses where we only have intimate knowledge of types that are already known to the driver.

Parameters:

oid - input oid

Returns:

oid of the array's base element or the provided oid (if not array)

getArrayDelimiter

public char getArrayDelimiter(int oid)
                       throws java.sql.SQLException

Description copied from interface: TypeInfo

Determine the delimiter for the elements of the given array type oid.

Specified by:

getArrayDelimiter in interface TypeInfo

Parameters:

oid - the array type's OID

Returns:

the base type's array type delimiter

Throws:

java.sql.SQLException - if an error occurs when retrieving array delimiter

getPGArrayElement

public int getPGArrayElement(int oid)
                      throws java.sql.SQLException

Description copied from interface: TypeInfo

Look up the oid of an array's base type given the array's type oid.

Specified by:

getPGArrayElement in interface TypeInfo

Parameters:

oid - the array type's OID

Returns:

the base type's OID, or 0 if unknown

Throws:

java.sql.SQLException - if an error occurs when retrieving array element

getPGobject

public java.lang.Class<? extends PGobject> getPGobject(java.lang.String type)

Specified by:

getPGobject in interface TypeInfo

getJavaClass

public java.lang.String getJavaClass(int oid)
                              throws java.sql.SQLException

Specified by:

getJavaClass in interface TypeInfo

Throws:

java.sql.SQLException

getTypeForAlias

public java.lang.String getTypeForAlias(java.lang.String alias)

Specified by:

getTypeForAlias in interface TypeInfo

getPrecision

public int getPrecision(int oid,
                        int typmod)

Specified by:

getPrecision in interface TypeInfo

getScale

public int getScale(int oid,
                    int typmod)

Specified by:

getScale in interface TypeInfo

isCaseSensitive

public boolean isCaseSensitive(int oid)

Specified by:

isCaseSensitive in interface TypeInfo

isSigned

public boolean isSigned(int oid)

Specified by:

isSigned in interface TypeInfo

getDisplaySize

public int getDisplaySize(int oid,
                          int typmod)

Specified by:

getDisplaySize in interface TypeInfo

getMaximumPrecision

public int getMaximumPrecision(int oid)

Specified by:

getMaximumPrecision in interface TypeInfo

requiresQuoting

public boolean requiresQuoting(int oid)
                        throws java.sql.SQLException

Specified by:

requiresQuoting in interface TypeInfo

Throws:

java.sql.SQLException

requiresQuotingSqlType

public boolean requiresQuotingSqlType(int sqlType)
                               throws java.sql.SQLException

Returns true if particular sqlType requires quoting. This method is used internally by the driver, so it might disappear without notice.

Specified by:

requiresQuotingSqlType in interface TypeInfo

Parameters:

sqlType - sql type as in java.sql.Types

Returns:

true if the type requires quoting

Throws:

java.sql.SQLException - if something goes wrong