Top Fields Constructors Methods
org.apache.derby.client.am

public Class ColumnMetaData

extends Object
implements ResultSetMetaData
Class Inheritance
All Implemented Interfaces
java.sql.ResultSetMetaData, java.sql.Wrapper
Imports
java.sql.ResultSet, .ResultSetMetaData, .SQLException, .Types, java.util.Hashtable, org.apache.derby.shared.common.reference.DRDAConstants, .JDBC40Translation, .SQLState

Field Summary

Modifier and TypeField and Description
public transient int[]
clientParamtertype_

private transient Hashtable<String, Integer>
columnNameToIndexCache_

public int
columns_

private transient LogWriter
logWriter_

public boolean[]
nullable_

public transient int[][]
protocolTypesCache_

pack-priv transient int
resultSetConcurrency_

public int[]
sqlCcsid_

public String[]
sqlComment_

public short
sqldFcode_

public short
sqldHold_

public short
sqldKeytype_

public String
sqldRdbnam_

public short
sqldReturn_

public String
sqldSchema_

public short
sqldScroll_

public short
sqldSensitive_

public String[]
sqlLabel_

public long[]
sqlLength_

public String[]
sqlName_

public int[]
sqlPrecision_

public int[]
sqlScale_

public int[]
sqlType_

public String[]
sqlUDTclassName_

public String[]
sqlUDTname_

public short[]
sqlUnnamed_

public String[]
sqlxBasename_

public String[]
sqlxCorname_

public short[]
sqlxGenerated_

public short[]
sqlxKeymem_

public String[]
sqlxName_

public short[]
sqlxParmmode_

public String[]
sqlxRdbnam_

public String[]
sqlxSchema_

public int[]
sqlxUpdatable_

private transient boolean
statementClosed_

public transient int[]
types_

Constructor Summary

AccessConstructor and Description
public
ColumnMetaData(LogWriter logWriter)

public
ColumnMetaData(LogWriter logWriter, int upperBound)

Method Summary

Modifier and TypeMethod and Description
private void
assignColumnName(int column)

private void
checkForClosedStatement()

pack-priv void
checkForValidColumnIndex(int column)

pack-priv int
findColumnX(String columnName)

public String

Returns:

column name or "" if not applicable.
getCatalogName(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getCatalogName.

What's a column's table's catalog name?
public String
getColumnClassName(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getColumnClassName.

Returns the fully-qualified name of the Java class whose instances are manufactured if the method ResultSet.getObject is called to retrieve a value from the column.

public int
getColumnCount()

Implements java.sql.ResultSetMetaData.getColumnCount.

Returns the number of columns in this ResultSet object.
public int
getColumnDisplaySize(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getColumnDisplaySize.

Indicates the designated column's normal maximum width in characters.
public String
getColumnLabel(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getColumnLabel.

Gets the designated column's suggested title for use in printouts and displays.
public String
getColumnName(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getColumnName.

Get the designated column's name.
public int
getColumnType(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getColumnType.

Retrieves the designated column's SQL type.
public String
getColumnTypeName(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getColumnTypeName.

Retrieves the designated column's database-specific type name.
public int
getPrecision(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getPrecision.

Get the designated column's specified column size.
public int
getScale(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getScale.

Gets the designated column's number of digits to right of the decimal point.
public String
getSchemaName(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getSchemaName.

Get the designated column's table's schema.
public String
getTableName(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.getTableName.

Gets the designated column's table name.
pack-priv boolean
hasLobColumns()

public void
initializeCache(int upperBound)

public boolean
isAutoIncrement(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isAutoIncrement.

Indicates whether the designated column is automatically numbered.
public boolean
isCaseSensitive(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isCaseSensitive.

Indicates whether a column's case matters.
public boolean
isCurrency(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isCurrency.

Indicates whether the designated column is a cash value.
public boolean
isDefinitelyWritable(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isDefinitelyWritable.

Indicates whether a write on the designated column will definitely succeed.
public int
isNullable(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isNullable.

Indicates the nullability of values in the designated column.
public boolean
isReadOnly(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isReadOnly.

Indicates whether the designated column is definitely not writable.
public boolean
isSearchable(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isSearchable.

Indicates whether the designated column can be used in a where clause.
public boolean
isSigned(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isSigned.

Indicates whether values in the designated column are signed numbers.
public boolean

Returns:

true if this instance implements iface, or false otherwise
isWrapperFor(Class<?>
a class defining an interface
iface)

Implements java.sql.Wrapper.isWrapperFor.

Check whether this instance wraps an object that implements the interface specified by iface.
public boolean
isWritable(int
the first column is 1, the second is 2, ...
column)

Implements java.sql.ResultSetMetaData.isWritable.

Indicates whether it is possible for a write on the designated column to succeed.
pack-priv void
markClosed()

private void
nullDataForGC()

public void
setLogWriter(LogWriter logWriter)

public <T> T

Returns:

an object that implements the interface
unwrap(Class<T>
a class defining an interface
iface)

Implements java.sql.Wrapper.unwrap.

Returns this if this class implements the specified interface.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

clientParamtertype_back to summary
public transient int[] clientParamtertype_
columnNameToIndexCache_back to summary
private transient Hashtable<String, Integer> columnNameToIndexCache_
columns_back to summary
public int columns_
logWriter_back to summary
private transient LogWriter logWriter_
nullable_back to summary
public boolean[] nullable_
protocolTypesCache_back to summary
public transient int[][] protocolTypesCache_
resultSetConcurrency_back to summary
pack-priv transient int resultSetConcurrency_
sqlCcsid_back to summary
public int[] sqlCcsid_
sqlComment_back to summary
public String[] sqlComment_
sqldFcode_back to summary
public short sqldFcode_
sqldHold_back to summary
public short sqldHold_
sqldKeytype_back to summary
public short sqldKeytype_
sqldRdbnam_back to summary
public String sqldRdbnam_
sqldReturn_back to summary
public short sqldReturn_
sqldSchema_back to summary
public String sqldSchema_
sqldScroll_back to summary
public short sqldScroll_
sqldSensitive_back to summary
public short sqldSensitive_
sqlLabel_back to summary
public String[] sqlLabel_
sqlLength_back to summary
public long[] sqlLength_
sqlName_back to summary
public String[] sqlName_
sqlPrecision_back to summary
public int[] sqlPrecision_
sqlScale_back to summary
public int[] sqlScale_
sqlType_back to summary
public int[] sqlType_
sqlUDTclassName_back to summary
public String[] sqlUDTclassName_
sqlUDTname_back to summary
public String[] sqlUDTname_
sqlUnnamed_back to summary
public short[] sqlUnnamed_
sqlxBasename_back to summary
public String[] sqlxBasename_
sqlxCorname_back to summary
public String[] sqlxCorname_
sqlxGenerated_back to summary
public short[] sqlxGenerated_
sqlxKeymem_back to summary
public short[] sqlxKeymem_
sqlxName_back to summary
public String[] sqlxName_
sqlxParmmode_back to summary
public short[] sqlxParmmode_
sqlxRdbnam_back to summary
public String[] sqlxRdbnam_
sqlxSchema_back to summary
public String[] sqlxSchema_
sqlxUpdatable_back to summary
public int[] sqlxUpdatable_
statementClosed_back to summary
private transient boolean statementClosed_
types_back to summary
public transient int[] types_

Constructor Detail

ColumnMetaDataback to summary
public ColumnMetaData(LogWriter logWriter)
ColumnMetaDataback to summary
public ColumnMetaData(LogWriter logWriter, int upperBound)

Method Detail

assignColumnNameback to summary
private void assignColumnName(int column)
checkForClosedStatementback to summary
private void checkForClosedStatement() throws SqlException
checkForValidColumnIndexback to summary
pack-priv void checkForValidColumnIndex(int column) throws SqlException
findColumnXback to summary
pack-priv int findColumnX(String columnName) throws SqlException
getCatalogNameback to summary
public String getCatalogName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getCatalogName.

What's a column's table's catalog name?

Parameters
column:int

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

Returns:String

column name or "" if not applicable.

Exceptions
SQLException:
thrown on failure
getColumnClassNameback to summary
public String getColumnClassName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnClassName.

Doc from java.sql.ResultSetMetaData.getColumnClassName.

Returns the fully-qualified name of the Java class whose instances are manufactured if the method ResultSet.getObject is called to retrieve a value from the column. ResultSet.getObject may return a subclass of the class returned by this method.

Parameters
column:int

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

Returns:String

the fully-qualified name of the class in the Java programming language that would be used by the method ResultSet.getObject to retrieve the value in the specified column. This is the class name used for custom mapping.

Exceptions
SQLException:
if a database access error occurs
getColumnCountback to summary
public int getColumnCount() throws SQLException

Implements java.sql.ResultSetMetaData.getColumnCount.

Doc from java.sql.ResultSetMetaData.getColumnCount.

Returns the number of columns in this ResultSet object.

Returns:int

the number of columns

Exceptions
SQLException:
if a database access error occurs
getColumnDisplaySizeback to summary
public int getColumnDisplaySize(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnDisplaySize.

Doc from java.sql.ResultSetMetaData.getColumnDisplaySize.

Indicates the designated column's normal maximum width in characters.

Parameters
column:int

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

Returns:int

the normal maximum number of characters allowed as the width of the designated column

Exceptions
SQLException:
if a database access error occurs
getColumnLabelback to summary
public String getColumnLabel(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnLabel.

Doc from java.sql.ResultSetMetaData.getColumnLabel.

Gets the designated column's suggested title for use in printouts and displays. The suggested title is usually specified by the SQL AS clause. If a SQL AS is not specified, the value returned from getColumnLabel will be the same as the value returned by the getColumnName method.

Parameters
column:int

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

Returns:String

the suggested column title

Exceptions
SQLException:
if a database access error occurs
getColumnNameback to summary
public String getColumnName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnName.

Doc from java.sql.ResultSetMetaData.getColumnName.

Get the designated column's name.

Parameters
column:int

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

Returns:String

column name

Exceptions
SQLException:
if a database access error occurs
getColumnTypeback to summary
public int getColumnType(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnType.

Doc from java.sql.ResultSetMetaData.getColumnType.

Retrieves the designated column's SQL type.

Parameters
column:int

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

Returns:int

SQL type from java.sql.Types

Exceptions
SQLException:
if a database access error occurs
getColumnTypeNameback to summary
public String getColumnTypeName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnTypeName.

Doc from java.sql.ResultSetMetaData.getColumnTypeName.

Retrieves the designated column's database-specific type name.

Parameters
column:int

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

Returns:String

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

Exceptions
SQLException:
if a database access error occurs
getPrecisionback to summary
public int getPrecision(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getPrecision.

Doc from java.sql.ResultSetMetaData.getPrecision.

Get the designated column's specified column size. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.

Parameters
column:int

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

Returns:int

precision

Exceptions
SQLException:
if a database access error occurs
getScaleback to summary
public int getScale(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getScale.

Doc from java.sql.ResultSetMetaData.getScale.

Gets the designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.

Parameters
column:int

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

Returns:int

scale

Exceptions
SQLException:
if a database access error occurs
getSchemaNameback to summary
public String getSchemaName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getSchemaName.

Doc from java.sql.ResultSetMetaData.getSchemaName.

Get the designated column's table's schema.

Parameters
column:int

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

Returns:String

schema name or "" if not applicable

Exceptions
SQLException:
if a database access error occurs
getTableNameback to summary
public String getTableName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getTableName.

Doc from java.sql.ResultSetMetaData.getTableName.

Gets the designated column's table name.

Parameters
column:int

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

Returns:String

table name or "" if not applicable

Exceptions
SQLException:
if a database access error occurs
hasLobColumnsback to summary
pack-priv boolean hasLobColumns()
initializeCacheback to summary
public void initializeCache(int upperBound)
isAutoIncrementback to summary
public boolean isAutoIncrement(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isAutoIncrement.

Doc from java.sql.ResultSetMetaData.isAutoIncrement.

Indicates whether the designated column is automatically numbered.

Parameters
column:int

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

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isCaseSensitiveback to summary
public boolean isCaseSensitive(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isCaseSensitive.

Doc from java.sql.ResultSetMetaData.isCaseSensitive.

Indicates whether a column's case matters.

Parameters
column:int

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

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isCurrencyback to summary
public boolean isCurrency(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isCurrency.

Doc from java.sql.ResultSetMetaData.isCurrency.

Indicates whether the designated column is a cash value.

Parameters
column:int

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

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isDefinitelyWritableback to summary
public boolean isDefinitelyWritable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isDefinitelyWritable.

Doc from java.sql.ResultSetMetaData.isDefinitelyWritable.

Indicates whether a write on the designated column will definitely succeed.

Parameters
column:int

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

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isNullableback to summary
public int isNullable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isNullable.

Doc from java.sql.ResultSetMetaData.isNullable.

Indicates the nullability of values in the designated column.

Parameters
column:int

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

Returns:int

the nullability status of the given column; one of columnNoNulls, columnNullable or columnNullableUnknown

Exceptions
SQLException:
if a database access error occurs
isReadOnlyback to summary
public boolean isReadOnly(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isReadOnly.

Doc from java.sql.ResultSetMetaData.isReadOnly.

Indicates whether the designated column is definitely not writable.

Parameters
column:int

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

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isSearchableback to summary
public boolean isSearchable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isSearchable.

Doc from java.sql.ResultSetMetaData.isSearchable.

Indicates whether the designated column can be used in a where clause.

Parameters
column:int

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

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isSignedback to summary
public boolean isSigned(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isSigned.

Doc from java.sql.ResultSetMetaData.isSigned.

Indicates whether values in the designated column are signed numbers.

Parameters
column:int

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

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
isWrapperForback to summary
public boolean isWrapperFor(Class<?> iface) throws SQLException

Implements java.sql.Wrapper.isWrapperFor.

Check whether this instance wraps an object that implements the interface specified by iface.

Parameters
iface:Class<?>

a class defining an interface

Returns:boolean

true if this instance implements iface, or false otherwise

Exceptions
SQLException:
if an error occurs while determining if this instance implements iface
isWritableback to summary
public boolean isWritable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isWritable.

Doc from java.sql.ResultSetMetaData.isWritable.

Indicates whether it is possible for a write on the designated column to succeed.

Parameters
column:int

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

Returns:boolean

true if so; false otherwise

Exceptions
SQLException:
if a database access error occurs
markClosedback to summary
pack-priv void markClosed()
nullDataForGCback to summary
private void nullDataForGC()
setLogWriterback to summary
public void setLogWriter(LogWriter logWriter)
unwrapback to summary
public <T> T unwrap(Class<T> iface) throws SQLException

Implements java.sql.Wrapper.unwrap.

Returns this if this class implements the specified interface.

Parameters
<T>

Doc from java.sql.Wrapper.unwrap. the type of the class modeled by this Class object

iface:Class<T>

a class defining an interface

Returns:T

an object that implements the interface

Exceptions
SQLException:
if no object is found that implements the interface