javax.sql.rowset.RowSetMetaDataImpl — clojure-interop/javax.sql 1.0.4

Provides implementations for the methods that set and get metadata information about a RowSet object's columns. A RowSetMetaDataImpl object keeps track of the number of columns in the rowset and maintains an internal array of column attributes for each column.

A RowSet object creates a RowSetMetaDataImpl object internally in order to set and retrieve information about its columns.

NOTE: All metadata in a RowSetMetaDataImpl object should be considered as unavailable until the RowSet object that it describes is populated. Therefore, any RowSetMetaDataImpl method that retrieves information is defined as having unspecified behavior when it is called before the RowSet object contains data.

->row-set-meta-data-impl clj

(->row-set-meta-data-impl)

Constructor.

auto-increment? clj

(auto-increment? this column-index)

Retrieves whether a value stored in the designated column is automatically numbered, and thus readonly.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: true if the column is automatically numbered; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

case-sensitive? clj

(case-sensitive? this column-index)

Indicates whether the case of the designated column's name matters.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: true if the column name is case sensitive; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

currency? clj

(currency? this column-index)

Indicates whether a value stored in the designated column is a cash value.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: true if a value in the designated column is a cash value; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

definitely-writable? clj

(definitely-writable? this column-index)

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

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: true if a write operation on the designated column will definitely succeed; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-catalog-name clj

(get-catalog-name this column-index)

Retrieves the catalog name of the table from which the value in the designated column was derived.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the catalog name of the column's table or an empty String if no catalog name is available - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-column-class-name clj

(get-column-class-name this column-index)

Retrieves the fully-qualified name of the class in the Java programming language to which a value in the designated column will be mapped. For example, if the value is an int, the class name returned by this method will be java.lang.Integer.

If the value in the designated column has a custom mapping, this method returns the name of the class that implements SQLData. When the method ResultSet.getObject is called to retrieve a value from the designated column, it will create an instance of this class or one of its subclasses.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the fully-qualified name of the class in the Java programming language that would be used by the method RowSet.getObject to retrieve the value in the specified column. This is the class name used for custom mapping when there is a custom mapping. - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-column-count clj

(get-column-count this)

Retrieves the number of columns in the RowSet object for which this RowSetMetaDataImpl object was created.

returns: the number of columns - int

throws: java.sql.SQLException - if an error occurs determining the column count

get-column-display-size clj

(get-column-display-size this column-index)

Retrieves the normal maximum width in chars of the designated column.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the maximum number of chars that can be displayed in the designated column - int

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-column-label clj

(get-column-label this column-index)

Retrieves the suggested column title for the designated column for use in printouts and displays.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the suggested column name to use in printouts and displays - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-column-name clj

(get-column-name this column-index)

Retrieves the name of the designated column.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the column name of the designated column - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-column-type clj

(get-column-type this column-index)

Retrieves the type code (one of the java.sql.Types constants) for the SQL type of the value stored in the designated column.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: an int representing the SQL type of values stored in the designated column - int

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-column-type-name clj

(get-column-type-name this column-index)

Retrieves the DBMS-specific type name for values stored in the designated column.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the type name used by the data source - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-precision clj

(get-precision this column-index)

Retrieves the total number of digits for values stored in the designated column.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the precision for values stored in the designated column - int

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-scale clj

(get-scale this column-index)

Retrieves the number of digits to the right of the decimal point for values stored in the designated column.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the scale for values stored in the designated column - int

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-schema-name clj

(get-schema-name this column-index)

Retrieves the schema name of the table from which the value in the designated column was derived.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the schema name or an empty String if no schema name is available - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

get-table-name clj

(get-table-name this column-index)

Retrieves the name of the table from which the value in the designated column was derived.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: the table name or an empty String if no table name is available - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

is-nullable clj

(is-nullable this column-index)

Retrieves a constant indicating whether it is possible to store a NULL value in the designated column.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: a constant from the ResultSetMetaData interface; either columnNoNulls, columnNullable, or columnNullableUnknown - int

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

read-only? clj

(read-only? this column-index)

Indicates whether the designated column is definitely not writable, thus readonly.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: true if this RowSet object is read-Only and thus not updatable; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

searchable? clj

(searchable? this column-index)

Indicates whether a value stored in the designated column can be used in a WHERE clause.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: true if a value in the designated column can be used in a WHERE clause; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

set-auto-increment clj

(set-auto-increment this column-index property)

Sets whether the designated column is automatically numbered, thus read-only, to the given boolean value.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns in the rowset, inclusive - int property - true if the given column is automatically incremented; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given index is out of bounds

set-case-sensitive clj

(set-case-sensitive this column-index property)

Sets whether the name of the designated column is case sensitive to the given boolean.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns in the rowset, inclusive - int property - true to indicate that the column name is case sensitive; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

set-catalog-name clj

(set-catalog-name this column-index catalog-name)

Sets the catalog name of the table from which the designated column was derived to catalogName. If catalogName is null, the catalog name is set to an empty string.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int catalog-name - the column's table's catalog name; if the catalogName is null, an empty String is set - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

set-column-count clj

(set-column-count this column-count)

Sets to the given number the number of columns in the RowSet object for which this RowSetMetaDataImpl object was created.

column-count - an int giving the number of columns in the RowSet object - int

throws: java.sql.SQLException - if the given number is equal to or less than zero

set-column-display-size clj

(set-column-display-size this column-index size)

Sets the normal maximum number of chars in the designated column to the given number.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int size - the maximum size of the column in chars; must be 0 or more - int

throws: java.sql.SQLException - if a database access error occurs, the given column number is out of bounds, or size is less than 0

set-column-label clj

(set-column-label this column-index label)

Sets the suggested column label for use in printouts and displays, if any, to label. If label is null, the column label is set to an empty string (``).

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int label - the column label to be used in printouts and displays; if the column label is null, an empty String is set - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column index is out of bounds

set-column-name clj

(set-column-name this column-index column-name)

Sets the column name of the designated column to the given name.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int column-name - a String object indicating the column name; if the given name is null, an empty String is set - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column index is out of bounds

set-column-type clj

(set-column-type this column-index sql-type)

Sets the SQL type code for values stored in the designated column to the given type code from the class java.sql.Types.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int sql-type - the designated column's SQL type, which must be one of the constants in the class java.sql.Types - int

throws: java.sql.SQLException - if a database access error occurs, the given column number is out of bounds, or the column type specified is not one of the constants in java.sql.Types

set-column-type-name clj

(set-column-type-name this column-index type-name)

Sets the type name used by the data source for values stored in the designated column to the given type name.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int type-name - the data source-specific type name; if typeName is null, an empty String is set - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

set-currency clj

(set-currency this column-index property)

Sets whether a value stored in the designated column is a cash value to the given boolean.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive between 1 and the number of columns, inclusive - int property - true if the value is a cash value; false otherwise. - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

set-nullable clj

(set-nullable this column-index property)

Sets whether a value stored in the designated column can be set to NULL to the given constant from the interface ResultSetMetaData.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int property - one of the following ResultSetMetaData constants: columnNoNulls, columnNullable, or columnNullableUnknown - int

throws: java.sql.SQLException - if a database access error occurs, the given column number is out of bounds, or the value supplied for the property parameter is not one of the following constants: ResultSetMetaData.columnNoNulls, ResultSetMetaData.columnNullable, or ResultSetMetaData.columnNullableUnknown

set-precision clj

(set-precision this column-index precision)

Sets the total number of decimal digits in a value stored in the designated column to the given number.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int precision - the total number of decimal digits; must be 0 or more - int

throws: java.sql.SQLException - if a database access error occurs, columnIndex is out of bounds, or precision is less than 0

set-scale clj

(set-scale this column-index scale)

Sets the number of digits to the right of the decimal point in a value stored in the designated column to the given number.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int scale - the number of digits to the right of the decimal point; must be zero or greater - int

throws: java.sql.SQLException - if a database access error occurs, columnIndex is out of bounds, or scale is less than 0

set-schema-name clj

(set-schema-name this column-index schema-name)

Sets the designated column's table's schema name, if any, to schemaName. If schemaName is null, the schema name is set to an empty string (``).

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int schema-name - the schema name for the table from which a value in the designated column was derived; may be an empty String or null - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

set-searchable clj

(set-searchable this column-index property)

Sets whether a value stored in the designated column can be used in a WHERE clause to the given boolean value.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns in the rowset, inclusive - int property - true to indicate that a column value can be used in a WHERE clause; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

set-signed clj

(set-signed this column-index property)

Sets whether a value stored in the designated column is a signed number to the given boolean.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int property - true to indicate that a column value is a signed number; false to indicate that it is not - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

set-table-name clj

(set-table-name this column-index table-name)

Sets the name of the table from which the designated column was derived to the given table name.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int table-name - the column's table name; may be null or an empty string - java.lang.String

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

signed? clj

(signed? this column-index)

Indicates whether a value stored in the designated column is a signed number.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: true if a value in the designated column is a signed number; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds

unwrap clj

(unwrap this iface)

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

iface - A Class defining an interface that the result must implement. - java.lang.Class

returns: an object that implements the interface. May be a proxy for the actual implementing object. - <T> T

throws: java.sql.SQLException - If no object found that implements the interface

wrapper-for? clj

(wrapper-for? this interfaces)

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.

interfaces - a Class defining an interface. - java.lang.Class

returns: true if this implements the interface or directly or indirectly wraps an object that does. - boolean

throws: java.sql.SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.

writable? clj

(writable? this column-index)

Indicates whether it is possible for a write operation on the designated column to succeed. A return value of true means that a write operation may or may not succeed.

column-index - the first column is 1, the second is 2, and so on; must be between 1 and the number of columns, inclusive - int

returns: true if a write operation on the designated column may will succeed; false otherwise - boolean

throws: java.sql.SQLException - if a database access error occurs or the given column number is out of bounds