schemacrawler.crawl

Class MetadataResultSet

java.lang.Object

schemacrawler.crawl.MetadataResultSet

All Implemented Interfaces:

AutoCloseable

public final class MetadataResultSet
extends Object
implements AutoCloseable

A wrapper around a JDBC resultset obtained from a database metadata call. This allows type-safe methods to obtain boolean, integer and string data, while abstracting away the quirks of the JDBC metadata API.

Constructor Summary

Constructors

Constructor and Description
MetadataResultSet(Query query, Statement statement, InclusionRule schemaInclusionRule)
MetadataResultSet(ResultSet resultSet, String description)

Method Summary

Modifier and Type	Method and Description
void	close() Releases this ResultSet object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
Map<String,Object>	getAttributes() Gets unread (and therefore unmapped) columns from the database metadata result-set, and makes them available as additional attributes.
BigInteger	getBigInteger(String columnName)
boolean	getBoolean(String columnName) Checks if the value of a column from the result set evaluates to true.
String[]	getColumnNames()
<E extends Enum<E>> E	getEnum(String columnName, E defaultValue) Reads the value of a column from the result set as an enum.
<E extends Enum<E> & IdentifiedEnum> E	getEnumFromId(String columnName, E defaultValue) Reads the value of a column from the result set as an enum.
<E extends Enum<E> & IdentifiedEnum> E	getEnumFromShortId(String columnName, E defaultValue) Reads the value of a column from the result set as an enum.
int	getInt(String columnName, int defaultValue) Reads the value of a column from the result set as an integer.
long	getLong(String columnName, long defaultValue) Reads the value of a column from the result set as a long.
short	getShort(String columnName, short defaultValue) Reads the value of a column from the result set as a short.
String	getString(String columnName) Reads the value of a column from the result set as a string.
boolean	next() Moves the cursor down one row from its current position.
List<Object>	row()
void	setShowLobs(boolean showLobs)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataResultSet

public MetadataResultSet(Query query,
                         Statement statement,
                         InclusionRule schemaInclusionRule)
                  throws SQLException

Throws:

SQLException

MetadataResultSet

public MetadataResultSet(ResultSet resultSet,
                         String description)
                  throws SQLException

Throws:

SQLException

Method Detail

close

public void close()
           throws SQLException

Releases this ResultSet object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.

Specified by:

close in interface AutoCloseable

Throws:

SQLException - On an exception

getAttributes

public Map<String,Object> getAttributes()

Gets unread (and therefore unmapped) columns from the database metadata result-set, and makes them available as additional attributes.

Returns:

Map of additional attributes to the database object

getBigInteger

public BigInteger getBigInteger(String columnName)

getBoolean

public boolean getBoolean(String columnName)

Checks if the value of a column from the result set evaluates to true.

Parameters:

columnName - Column name to check

Returns:

Whether the string evaluates to true

getColumnNames

public String[] getColumnNames()

getEnum

public <E extends Enum<E>> E getEnum(String columnName,
                                     E defaultValue)

Reads the value of a column from the result set as an enum.

Parameters:

columnName - Column name

defaultValue - Default enum value to return

Returns:

Enum value of the column, or the default if not available

getEnumFromId

public <E extends Enum<E> & IdentifiedEnum> E getEnumFromId(String columnName,
                                                            E defaultValue)

Reads the value of a column from the result set as an enum.

Parameters:

columnName - Column name

defaultValue - Default enum value to return

Returns:

Enum value of the column, or the default if not available

getEnumFromShortId

public <E extends Enum<E> & IdentifiedEnum> E getEnumFromShortId(String columnName,
                                                                 E defaultValue)

Reads the value of a column from the result set as an enum.

Parameters:

columnName - Column name

defaultValue - Default enum value to return

Returns:

Enum value of the column, or the default if not available

getInt

public int getInt(String columnName,
                  int defaultValue)

Reads the value of a column from the result set as an integer. If the value was null, returns the default.

Parameters:

columnName - Column name

defaultValue - Default value

Returns:

Integer value of the column, or the default if not available

getLong

public long getLong(String columnName,
                    long defaultValue)

Reads the value of a column from the result set as a long. If the value was null, returns the default.

Parameters:

columnName - Column name

defaultValue - Default value

Returns:

Long value of the column, or the default if not available

getShort

public short getShort(String columnName,
                      short defaultValue)

Reads the value of a column from the result set as a short. If the value was null, returns the default.

Parameters:

columnName - Column name

defaultValue - Default value

Returns:

Short value of the column, or the default if not available

getString

public String getString(String columnName)

Reads the value of a column from the result set as a string.

Parameters:

columnName - Column name

Returns:

String value of the column, or null if not available

next

public boolean next()
             throws SQLException

Moves the cursor down one row from its current position. A ResultSet cursor is initially positioned before the first row; the first call to the method next makes the first row the current row; the second call makes the second row the current row, and so on.

Returns:

true if the new current row is valid; false if there are no more rows

Throws:

SQLException - On a database access error

row

public List<Object> row()
                 throws SQLException

Throws:

SQLException

setShowLobs

public void setShowLobs(boolean showLobs)