Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.jdbc.EmbedResultSetMetaData

Modifier and Type	Field and Description
private final ResultColumnDescriptor[]	columnInfo

Access	Constructor and Description
public	EmbedResultSetMetaData(ResultColumnDescriptor[] columnInfo)

Method Summary

Modifier and Type	Method and Description
public final 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 final String	getColumnClassName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnClassName. JDBC 2.0 Return the fully qualified name of the Java class whose instances are manufactured if ResultSet.getObject() is called to retrieve a value from the column.
public final int	Returns: the number getColumnCount() Implements java.sql.ResultSetMetaData.getColumnCount. What's the number of columns in the ResultSet?
public final int	Returns: max width getColumnDisplaySize(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnDisplaySize. What's the column's normal max width in chars?
public final String	Returns: true if so getColumnLabel(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnLabel. What's the suggested column title for use in printouts and displays?
public final String	Returns: column name getColumnName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnName. What's a column's name?
public final int	Returns: SQL type getColumnType(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnType. What's a column's SQL type?
private DataTypeDescriptor	getColumnTypeDescriptor(int column)
public final String	Returns: type name getColumnTypeName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnTypeName. What's a column's data source specific type name?
public final int	Returns: precision getPrecision(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getPrecision. What's a column's number of decimal digits?
public static ResultColumnDescriptor	getResultColumnDescriptor(String name, int jdcbTypeId, boolean nullable)
public static ResultColumnDescriptor	getResultColumnDescriptor(String name, int jdcbTypeId, boolean nullable, int length)
public static ResultColumnDescriptor	getResultColumnDescriptor(String name, DataTypeDescriptor dtd)
public final int	Returns: scale getScale(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getScale. What's a column's number of digits to right of the decimal point?
public final String	Returns: schema name or "" if not applicable getSchemaName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getSchemaName. What's a column's table's schema?
public final String	Returns: table name or "" if not applicable getTableName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getTableName. What's a column's table name?
public final boolean	Returns: true if so isAutoIncrement(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isAutoIncrement. Is the column automatically numbered, thus read-only?
public final boolean	Returns: true if so isCaseSensitive(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isCaseSensitive. Does a column's case matter?
public final boolean	Returns: false, always isCurrency(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isCurrency. Is the column a cash value?
public final boolean	Returns: true if so isDefinitelyWritable(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isDefinitelyWritable. Will a write on the column definitely succeed?
public final int	Returns: columnNoNulls, columnNullable or columnNullableUnknown isNullable(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isNullable. Can you put a NULL in this column?
public final boolean	Returns: true if so isReadOnly(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isReadOnly. Is a column definitely not writable?
public final boolean	Returns: true if so isSearchable(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isSearchable. Can the column be used in a where clause?
public final boolean	Returns: true if so isSigned(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isSigned. Is the column a signed number?
public final boolean	Returns: true if this implements the interface isWrapperFor(Class<?> the interface to check for iface) Implements java.sql.Wrapper.isWrapperFor. Returns whether or not this instance implements the specified interface.
public final boolean	Returns: true if so isWritable(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isWritable. Is it possible for a write on the column to succeed?
public final <T> T	Returns: an object that implements the interface unwrap(Class<T> the interface iface) Implements java.sql.Wrapper.unwrap. Returns `this` if this class implements the interface.
private void	validColumnNumber(int column)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

columnInfo	back to summary
private final ResultColumnDescriptor[] columnInfo

Method Detail

getCatalogName	back to summary
public final 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

getCatalogName

back to summary

public final 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

getColumnClassName back to summary

getColumnClassName	back to summary
public final String getColumnClassName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnClassName. JDBC 2.0 Return the fully qualified name of the Java class whose instances are manufactured if 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 Doc from java.sql.ResultSetMetaData.getColumnClassName. the first column is 1, the second is 2, ... Returns:String Doc from java.sql.ResultSetMetaData.getColumnClassName. 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: Feature not inplemented for now.

public final String getColumnClassName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnClassName.

JDBC 2.0

Return the fully qualified name of the Java class whose instances are manufactured if 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

Doc from java.sql.ResultSetMetaData.getColumnClassName.

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

Returns:String

Doc from java.sql.ResultSetMetaData.getColumnClassName.

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:: Feature not inplemented for now.

getColumnCount	back to summary
public final int getColumnCount() Implements java.sql.ResultSetMetaData.getColumnCount. What's the number of columns in the ResultSet? Returns:int the number

getColumnCount

back to summary

public final int getColumnCount()

Implements java.sql.ResultSetMetaData.getColumnCount.

What's the number of columns in the ResultSet?

Returns:int: the number

getColumnDisplaySize	back to summary
public final int getColumnDisplaySize(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnDisplaySize. What's the column's normal max width in chars? Parameters column:int the first column is 1, the second is 2, ... Returns:int max width Exceptions SQLException: thrown on failure

getColumnDisplaySize

back to summary

public final int getColumnDisplaySize(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnDisplaySize.

What's the column's normal max width in chars?

Parameters

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

Returns:int

max width

Exceptions

SQLException:: thrown on failure

getColumnLabel	back to summary
public final String getColumnLabel(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnLabel. What's the suggested column title for use in printouts and displays? Parameters column:int the first column is 1, the second is 2, ... Returns:String true if so Exceptions SQLException: thrown on failure

getColumnLabel

back to summary

public final String getColumnLabel(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnLabel.

What's the suggested column title for use in printouts and displays?

Parameters

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

Returns:String

true if so

Exceptions

SQLException:: thrown on failure

getColumnName	back to summary
public final String getColumnName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnName. What's a column's name? Parameters column:int the first column is 1, the second is 2, ... Returns:String column name Exceptions SQLException: thrown on failure

getColumnName

back to summary

public final String getColumnName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnName.

What's a column's name?

Parameters

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

Returns:String

column name

Exceptions

SQLException:: thrown on failure

getColumnType back to summary

getColumnType	back to summary
public final int getColumnType(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnType. What's a column's SQL type? Parameters column:int the first column is 1, the second is 2, ... Returns:int SQL type Exceptions SQLException: thrown on failure See Also `Types`

public final int getColumnType(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnType.

What's a column's SQL type?

Parameters

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

Returns:int

SQL type

Exceptions

SQLException:: thrown on failure

See Also

Types

getColumnTypeDescriptor	back to summary
private DataTypeDescriptor getColumnTypeDescriptor(int column) throws SQLException

getColumnTypeName	back to summary
public final String getColumnTypeName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnTypeName. What's a column's data source specific type name? Parameters column:int the first column is 1, the second is 2, ... Returns:String type name Exceptions SQLException: thrown on failure

getColumnTypeName

back to summary

public final String getColumnTypeName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnTypeName.

What's a column's data source specific type name?

Parameters

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

Returns:String

type name

Exceptions

SQLException:: thrown on failure

getPrecision	back to summary
public final int getPrecision(int column) throws SQLException Implements java.sql.ResultSetMetaData.getPrecision. What's a column's number of decimal digits? Parameters column:int the first column is 1, the second is 2, ... Returns:int precision Exceptions SQLException: thrown on failure

getPrecision

back to summary

public final int getPrecision(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getPrecision.

What's a column's number of decimal digits?

Parameters

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

Returns:int

precision

Exceptions

SQLException:: thrown on failure

getResultColumnDescriptor	back to summary
public static ResultColumnDescriptor getResultColumnDescriptor(String name, int jdcbTypeId, boolean nullable)

getResultColumnDescriptor	back to summary
public static ResultColumnDescriptor getResultColumnDescriptor(String name, int jdcbTypeId, boolean nullable, int length)

getResultColumnDescriptor	back to summary
public static ResultColumnDescriptor getResultColumnDescriptor(String name, DataTypeDescriptor dtd)

getScale	back to summary
public final int getScale(int column) throws SQLException Implements java.sql.ResultSetMetaData.getScale. What's a column's number of digits to right of the decimal point? Parameters column:int the first column is 1, the second is 2, ... Returns:int scale Exceptions SQLException: thrown on failure

getScale

back to summary

public final int getScale(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getScale.

What's a column's number of digits to right of the decimal point?

Parameters

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

Returns:int

scale

Exceptions

SQLException:: thrown on failure

getSchemaName	back to summary
public final String getSchemaName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getSchemaName. What's a 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: thrown on failure

getSchemaName

back to summary

public final String getSchemaName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getSchemaName.

What's a 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:: thrown on failure

getTableName	back to summary
public final String getTableName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getTableName. What's a column's table name? Parameters column:int Doc from java.sql.ResultSetMetaData.getTableName. the first column is 1, the second is 2, ... Returns:String table name or "" if not applicable Exceptions SQLException: thrown on failure

getTableName

back to summary

public final String getTableName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getTableName.

What's a column's table name?

Parameters

column:int

Doc from java.sql.ResultSetMetaData.getTableName.

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

Returns:String

table name or "" if not applicable

Exceptions

SQLException:: thrown on failure

isAutoIncrement	back to summary
public final boolean isAutoIncrement(int column) throws SQLException Implements java.sql.ResultSetMetaData.isAutoIncrement. Is the column automatically numbered, thus read-only? Parameters column:int the first column is 1, the second is 2, ... Returns:boolean true if so Exceptions SQLException: thrown on failure

isAutoIncrement

back to summary

public final boolean isAutoIncrement(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isAutoIncrement.

Is the column automatically numbered, thus read-only?

Parameters

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

Returns:boolean

true if so

Exceptions

SQLException:: thrown on failure

isCaseSensitive	back to summary
public final boolean isCaseSensitive(int column) throws SQLException Implements java.sql.ResultSetMetaData.isCaseSensitive. Does a column's case matter? Parameters column:int the first column is 1, the second is 2, ... Returns:boolean true if so Exceptions SQLException: thrown on failure

isCaseSensitive

back to summary

public final boolean isCaseSensitive(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isCaseSensitive.

Does a column's case matter?

Parameters

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

Returns:boolean

true if so

Exceptions

SQLException:: thrown on failure

isCurrency	back to summary
public final boolean isCurrency(int column) throws SQLException Implements java.sql.ResultSetMetaData.isCurrency. Is the column a cash value? Always returns false since there are no currency data types in Derby. Parameters column:int the first column is 1, the second is 2, ... Returns:boolean false, always Exceptions SQLException: thrown on failure

isCurrency

back to summary

public final boolean isCurrency(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isCurrency.

Is the column a cash value? Always returns false since there are no currency data types in Derby.

Parameters

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

Returns:boolean

false, always

Exceptions

SQLException:: thrown on failure

isDefinitelyWritable	back to summary
public final boolean isDefinitelyWritable(int column) throws SQLException Implements java.sql.ResultSetMetaData.isDefinitelyWritable. Will a write on the column definitely succeed? Parameters column:int the first column is 1, the second is 2, ... Returns:boolean true if so Exceptions SQLException: thrown on failure

isDefinitelyWritable

back to summary

public final boolean isDefinitelyWritable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isDefinitelyWritable.

Will a write on the column definitely succeed?

Parameters

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

Returns:boolean

true if so

Exceptions

SQLException:: thrown on failure

isNullable	back to summary
public final int isNullable(int column) throws SQLException Implements java.sql.ResultSetMetaData.isNullable. Can you put a NULL in this column? Parameters column:int the first column is 1, the second is 2, ... Returns:int columnNoNulls, columnNullable or columnNullableUnknown Exceptions SQLException: thrown on failure

isNullable

back to summary

public final int isNullable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isNullable.

Can you put a NULL in this column?

Parameters

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

Returns:int

columnNoNulls, columnNullable or columnNullableUnknown

Exceptions

SQLException:: thrown on failure

isReadOnly	back to summary
public final boolean isReadOnly(int column) throws SQLException Implements java.sql.ResultSetMetaData.isReadOnly. Is a column definitely not writable? Parameters column:int the first column is 1, the second is 2, ... Returns:boolean true if so Exceptions SQLException: thrown on failure

isReadOnly

back to summary

public final boolean isReadOnly(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isReadOnly.

Is a column definitely not writable?

Parameters

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

Returns:boolean

true if so

Exceptions

SQLException:: thrown on failure

isSearchable	back to summary
public final boolean isSearchable(int column) throws SQLException Implements java.sql.ResultSetMetaData.isSearchable. Can the column be used in a where clause? Parameters column:int the first column is 1, the second is 2, ... Returns:boolean true if so Exceptions SQLException: thrown on failure

isSearchable

back to summary

public final boolean isSearchable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isSearchable.

Can the column be used in a where clause?

Parameters

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

Returns:boolean

true if so

Exceptions

SQLException:: thrown on failure

isSigned	back to summary
public final boolean isSigned(int column) throws SQLException Implements java.sql.ResultSetMetaData.isSigned. Is the column a signed number? Parameters column:int the first column is 1, the second is 2, ... Returns:boolean true if so Exceptions SQLException: thrown on failure

isSigned

back to summary

public final boolean isSigned(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isSigned.

Is the column a signed number?

Parameters

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

Returns:boolean

true if so

Exceptions

SQLException:: thrown on failure

isWrapperFor	back to summary
public final boolean isWrapperFor(Class<?> iface) Implements java.sql.Wrapper.isWrapperFor. Returns whether or not this instance implements the specified interface. Parameters iface:Class<?> the interface to check for Returns:boolean true if this implements the interface

isWrapperFor

back to summary

public final boolean isWrapperFor(Class<?> iface)

Implements java.sql.Wrapper.isWrapperFor.

Returns whether or not this instance implements the specified interface.

Parameters

iface:Class<?>: the interface to check for

Returns:boolean

true if this implements the interface

isWritable	back to summary
public final boolean isWritable(int column) throws SQLException Implements java.sql.ResultSetMetaData.isWritable. Is it possible for a write on the column to succeed? Parameters column:int the first column is 1, the second is 2, ... Returns:boolean true if so Exceptions SQLException: thrown on failure

isWritable

back to summary

public final boolean isWritable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isWritable.

Is it possible for a write on the column to succeed?

Parameters

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

Returns:boolean

true if so

Exceptions

SQLException:: thrown on failure

unwrap back to summary

unwrap	back to summary
public final <T> T unwrap(Class<T> iface) throws SQLException Implements java.sql.Wrapper.unwrap. Returns `this` if this class implements the interface. Parameters <T> Doc from java.sql.Wrapper.unwrap. the type of the class modeled by this Class object iface:Class<T> the interface Returns:T an object that implements the interface Exceptions SQLException: if no object is found that implements the interface

public final <T> T unwrap(Class<T> iface) throws SQLException

Implements java.sql.Wrapper.unwrap.

Returns this if this class implements the interface.

Parameters

<T>: Doc from java.sql.Wrapper.unwrap. the type of the class modeled by this Class object
iface:Class<T>: the interface

Returns:T

an object that implements the interface

Exceptions

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

validColumnNumber	back to summary
private void validColumnNumber(int column) throws SQLException

public Class EmbedResultSetMetaData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail