Top Description Fields Constructors Methods
org.jooq.tools.jdbc

public Class MockResultSetMetaData

extends Object
implements ResultSetMetaData, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, java.sql.ResultSetMetaData, java.sql.Wrapper
Imports
java.io.Serializable, java.sql.ResultSetMetaData, .SQLException, org.jooq.Configuration, .Field, .Schema, .Table, .TableField, org.jooq.impl.DSL, org.jooq.types.UNumber

A mock result set meta data object.
Author
Lukas Eder
See Also
MockConnection

Field Summary

Modifier and TypeField and Description
private final MockResultSet
rs

The result set reference.

Constructor Summary

AccessConstructor and Description
public
MockResultSetMetaData(MockResultSet rs)

Deprecated as a consequence of MockResultSet being deprecated.
Create a new mock result set meta data object

Method Summary

Modifier and TypeMethod and Description
public String
getCatalogName(int
the first column is 1, the second is 2, ...
column
)

Implements java.sql.ResultSetMetaData.getCatalogName.

Gets the designated 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.
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
isWrapperFor(Class<?>
a Class defining an interface.
iface
)

Implements java.sql.Wrapper.isWrapperFor.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
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.
public <T> T
unwrap(Class<T>
A Class defining an interface that the result must implement.
iface
)

Implements java.sql.Wrapper.unwrap.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

rsback to summary
private final MockResultSet rs

Deprecated

as a consequence of MockResultSet being deprecated. See corresponding docs for further information.

The result set reference.

Constructor Detail

MockResultSetMetaDataback to summary
public MockResultSetMetaData(MockResultSet rs)

Deprecated

as a consequence of MockResultSet being deprecated. See corresponding docs for further information.

Create a new mock result set meta data object

Method Detail

getCatalogNameback to summary
public String getCatalogName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getCatalogName.

Doc from java.sql.ResultSetMetaData.getCatalogName.

Gets the designated column's table's catalog name.

Parameters
column:int

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

Returns:String

the name of the catalog for the table in which the given column appears or "" if not applicable

Annotations
@Override
Exceptions
SQLException:
if a database access error occurs
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.

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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.

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
Exceptions
SQLException:
if a database access error occurs
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

Annotations
@Override
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

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

Implements java.sql.Wrapper.isWrapperFor.

Doc from java.sql.Wrapper.isWrapperFor.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Parameters
iface:Class<?>

a Class defining an interface.

Returns:boolean

true if this implements the interface or directly or indirectly wraps an object that does.

Annotations
@Override
Exceptions
SQLException:
if an error occurs while determining whether this is a wrapper for an object with the given interface.
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

Annotations
@Override
Exceptions
SQLException:
if a database access error occurs
unwrapback to summary
public <T> T unwrap(Class<T> iface) throws SQLException

Implements java.sql.Wrapper.unwrap.

Doc from java.sql.Wrapper.unwrap.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Parameters
<T>
the type of the class modeled by this Class object
iface:Class<T>

A Class defining an interface that the result must implement.

Returns:T

an object that implements the interface. May be a proxy for the actual implementing object.

Annotations
@SuppressWarnings:unchecked
@Override
Exceptions
SQLException:
If no object found that implements the interface