oracle.jdbc.driver
Class StructMetaData

java.lang.Object
  oracle.jdbc.driver.StructMetaData

All Implemented Interfaces:

OracleResultSetMetaData, java.sql.ResultSetMetaData, oracle.jdbc.internal.StructMetaData, StructMetaData

public class StructMetaData

extends java.lang.Object

implements oracle.jdbc.internal.StructMetaData

Field Summary

static java.lang.String	BUILD_DATE
static boolean	PRIVATE_TRACE
static boolean	TRACE

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

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) isNCHAR (int)
int	isNullable(int column)
boolean	isReadOnly(int column)
boolean	isSearchable(int column)
boolean	isSigned(int column)
boolean	isWritable(int column)

Methods inherited from class java.lang.Object

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

Field Detail

TRACE

public static final boolean TRACE

See Also:

Constant Field Values

PRIVATE_TRACE

public static final boolean PRIVATE_TRACE

See Also:

Constant Field Values

BUILD_DATE

public static final java.lang.String BUILD_DATE

See Also:

Constant Field Values

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.

Specified by:

getColumnCount in interface java.sql.ResultSetMetaData

Returns:

number of attribute.

Throws:

java.sql.SQLException

isAutoIncrement

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

Specified by:

isAutoIncrement in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

isSearchable

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

Specified by:

isSearchable in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

isCurrency

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

Specified by:

isCurrency in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

isCaseSensitive

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

Specified by:

isCaseSensitive in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

isNullable

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

Specified by:

isNullable in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

isSigned

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

Specified by:

isSigned in interface java.sql.ResultSetMetaData

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.

Specified by:

getColumnDisplaySize in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

getColumnLabel

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

Specified by:

getColumnLabel in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

getColumnName

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

Gets a attribute's name.

Specified by:

getColumnName in interface java.sql.ResultSetMetaData

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.

Specified by:

getSchemaName in interface java.sql.ResultSetMetaData

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

Specified by:

getPrecision in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

getScale

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

Specified by:

getScale in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

getTableName

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

Specified by:

getTableName in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

getCatalogName

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

Specified by:

getCatalogName in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

getColumnType

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

Specified by:

getColumnType in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

getColumnTypeName

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

Retrieves a attribute's database-specific type name.

Specified by:

getColumnTypeName in interface java.sql.ResultSetMetaData

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

Specified by:

isReadOnly in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

isWritable

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

Specified by:

isWritable in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

isDefinitelyWritable

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

Specified by:

isDefinitelyWritable in interface java.sql.ResultSetMetaData

Throws:

java.sql.SQLException

getColumnClassName

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

Specified by:

getColumnClassName in interface java.sql.ResultSetMetaData

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.

Specified by:

getOracleColumnClassName in interface StructMetaData

Throws:

java.sql.SQLException

getLocalColumnCount

public int getLocalColumnCount()
                        throws java.sql.SQLException

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

Specified by:

getLocalColumnCount in interface StructMetaData

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.

Specified by:

isInherited in interface StructMetaData

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.

Specified by:

getAttributeJavaName in interface StructMetaData

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

Description copied from interface: OracleResultSetMetaData

isNCHAR (int)

Specified by:

isNCHAR in interface OracleResultSetMetaData

Parameters:

column - the column index

Returns:

true if the column is of type NCHAR/NVARCHAR/NCLOB false if the column is not of type NCHAR/NVARCHAR/NCLOB

Throws:

java.sql.SQLException