oracle.jdbc.driver
Class StructMetaData

oracle.jdbc.driver.StructMetaData

public class StructMetaData

Constructor Summary

StructMetaData(StructDescriptor desc)

Method Summary

java.lang.String	getAttributeJavaName(int column) Gets a JAVA_STRUCT attribute's external name.
java.lang.String	getCatalogName(int column)
java.lang.String	getColumnClassName(int column)
int	getColumnCount() Get number of attributes.
int	getColumnDisplaySize(int column) Return maximum column length in case of type CHAR,VARCHAR and RAW; Return 0 for other cases.
java.lang.String	getColumnLabel(int column)
java.lang.String	getColumnName(int column) Gets a attribute's name.
int	getColumnType(int column)
java.lang.String	getColumnTypeName(int column) Retrieves a attribute's database-specific type name.
int	getLocalColumnCount() Get number of local attributes i.e.
java.lang.String	getOracleColumnClassName(int column) Return the fully-qualified name of the Datum class whose instances are manufactured if the method OracleResultSet.getOracleObject is called to retrieve a value from a column.
int	getPrecision(int column)
int	getScale(int column)
java.lang.String	getSchemaName(int column) Gets a attribute's schema name if it's of object type.
java.lang.String	getTableName(int column)
boolean	isAutoIncrement(int column)
boolean	isCaseSensitive(int column)
boolean	isCurrency(int column)
boolean	isDefinitelyWritable(int column)
boolean	isInherited(int column) Indicates whether the attribute is inherited from its supertype.
boolean	isNCHAR(int column)
int	isNullable(int column)
boolean	isReadOnly(int column)
boolean	isSearchable(int column)
boolean	isSigned(int column)
boolean	isWritable(int column)

Constructor Detail

StructMetaData

public StructMetaData(StructDescriptor desc)
               throws java.sql.SQLException

Method Detail

getColumnCount

public int getColumnCount()
                   throws java.sql.SQLException

Get number of attributes.

Returns:

number of attribute.

isAutoIncrement

public boolean isAutoIncrement(int column)
                        throws java.sql.SQLException

isSearchable

public boolean isSearchable(int column)
                     throws java.sql.SQLException

isCurrency

public boolean isCurrency(int column)
                   throws java.sql.SQLException

isCaseSensitive

public boolean isCaseSensitive(int column)
                        throws java.sql.SQLException

isNullable

public int isNullable(int column)
               throws java.sql.SQLException

isSigned

public boolean isSigned(int column)
                 throws java.sql.SQLException

getColumnDisplaySize

public int getColumnDisplaySize(int column)
                         throws java.sql.SQLException

Return maximum column length in case of type CHAR,VARCHAR and RAW; Return 0 for other cases.

getColumnLabel

public java.lang.String getColumnLabel(int column)
                                throws java.sql.SQLException

getColumnName

public java.lang.String getColumnName(int column)
                               throws java.sql.SQLException

Gets a attribute's name.

Parameters:

column - the first attribue is 1, the second is 2, ...

Returns:

attribute name

Throws:

java.sql.SQLException - if a database access error occurs

getSchemaName

public java.lang.String getSchemaName(int column)
                               throws java.sql.SQLException

Gets a attribute's schema name if it's of object type.

Parameters:

column - the first attribute is 1, the second is 2, ...

Returns:

schema name or "" if not applicable

Throws:

java.sql.SQLException - if a database access error occurs

getPrecision

public int getPrecision(int column)
                 throws java.sql.SQLException

getScale

public int getScale(int column)
             throws java.sql.SQLException

getTableName

public java.lang.String getTableName(int column)
                              throws java.sql.SQLException

getCatalogName

public java.lang.String getCatalogName(int column)
                                throws java.sql.SQLException

getColumnType

public int getColumnType(int column)
                  throws java.sql.SQLException

getColumnTypeName

public java.lang.String getColumnTypeName(int column)
                                   throws java.sql.SQLException

Retrieves a attribute's database-specific type name.

Parameters:

column - the first attribute is 1, the second is 2, ...

Returns:

type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.

Throws:

java.sql.SQLException - if a database access error occurs

isReadOnly

public boolean isReadOnly(int column)
                   throws java.sql.SQLException

isWritable

public boolean isWritable(int column)
                   throws java.sql.SQLException

isDefinitelyWritable

public boolean isDefinitelyWritable(int column)
                             throws java.sql.SQLException

getColumnClassName

public java.lang.String getColumnClassName(int column)
                                    throws java.sql.SQLException

getOracleColumnClassName

public java.lang.String getOracleColumnClassName(int column)
                                          throws java.sql.SQLException

Return the fully-qualified name of the Datum class whose instances are manufactured if the method OracleResultSet.getOracleObject is called to retrieve a value from a column.

getLocalColumnCount

public int getLocalColumnCount()
                        throws java.sql.SQLException

Get number of local attributes i.e. not inherited from its supertype.

Returns:

number of local attribute.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

8.2.0

isInherited

public boolean isInherited(int column)
                    throws java.sql.SQLException

Indicates whether the attribute is inherited from its supertype.

Returns:

true is the attribute is inherited from the object type's supertype(s). Returns false if the attribute is defined in the subtype.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

8.2.0

getAttributeJavaName

public java.lang.String getAttributeJavaName(int column)
                                      throws java.sql.SQLException

Gets a JAVA_STRUCT attribute's external name.

Parameters:

column - the first attribue is 1, the second is 2, ...

Returns:

attribute external name; return null if the attribute is not a attribute of a JAVA_STRUCT object.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

8.2.0

isNCHAR

public boolean isNCHAR(int column)
                throws java.sql.SQLException