com.ddtek.jxtr
Interface JXTRResultSetMetaData

public interface JXTRResultSetMetaData

Methods to query meta data information for a JXTRResultSet.

Method Summary
java.lang.String	getCatalogName(int column)           Gets the designated column's table's catalog name.
java.lang.String	getColumnClassName(int column)           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.
int	getColumnCount()           Number of result set columns.
int	getColumnDisplaySize(int column)           Indicates the designated column's maximum width in characters.
java.lang.String	getColumnLabel(int column)           Gets the designated column's suggested title for use in printouts and displays.
java.lang.String	getColumnName(int column)           Get the designated column's name.
int	getColumnType(int column)           Retrieves the designated column's SQL type.
java.lang.String	getColumnTypeName(int column)           Retrieves the designated column's database-specific type name.
int	getPrecision(int column)           Get the designated column's number of decimal digits.
int	getScale(int column)           Gets the designated column's number of digits to right of the decimal point.
java.lang.String	getSchemaName(int column)           Get the designated column's table's schema.
java.lang.String	getTableName(int column)           Gets the designated column's table name.
boolean	isAutoIncrement(int column)           Indicates whether the designated column is automatically numbered, and consequently, read-only.
boolean	isCaseSensitive(int column)           Indicates whether a column's case matters.
boolean	isCurrency(int column)           Indicates whether the designated column is a cash value.
boolean	isDefinitelyWritable(int column)           Indicates whether a write performed on the designated column will succeed.
int	isNullable(int column)           Indicates the nullability of values in the designated column.
boolean	isReadOnly(int column)           Indicates whether the designated column is not writable.
boolean	isSearchable(int column)           Indicates whether the designated column can be used in a where clause.
boolean	isSigned(int column)           Indicates whether values in the designated column are signed numbers.
boolean	isWritable(int column)           Indicates whether it is possible to perform a write on the designated column.

 

Method Detail

getColumnCount

public int getColumnCount()
                   throws JXTRException

Number of result set columns.

Returns:

number of result set columns.

Throws:

JXTRException - in case an error is detected.

isAutoIncrement

public boolean isAutoIncrement(int column)
                        throws JXTRException

Indicates whether the designated column is automatically numbered, and consequently, read-only.

Parameters:

column - 1 based column index.

Returns:

true if so; false otherwise

Throws:

JXTRException - in case an error is detected.

getColumnName

public java.lang.String getColumnName(int column)
                               throws JXTRException

Get the designated column's name.

Parameters:

column - 1 based column index.

Returns:

column name

Throws:

JXTRException - in case an error is detected.

getColumnType

public int getColumnType(int column)
                  throws JXTRException

Retrieves the designated column's SQL type.

Parameters:

column - 1 based column index.

Returns:

SQL type from java.sql.Types or JXTRQuery.XMLTYPE.

Throws:

JXTRException - in case an error is detected.

isCaseSensitive

public boolean isCaseSensitive(int column)
                        throws JXTRException

Indicates whether a column's case matters.

Parameters:

column - 1 based column index.

Returns:

true if so; false otherwise

Throws:

JXTRException - in case an error is detected.

isSearchable

public boolean isSearchable(int column)
                     throws JXTRException

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

Parameters:

column - 1 based column index.

Returns:

true if so; false otherwise

Throws:

JXTRException - in case an error is detected.

isCurrency

public boolean isCurrency(int column)
                   throws JXTRException

Indicates whether the designated column is a cash value.

Parameters:

column - 1 based column index.

Returns:

true if so; false otherwise

Throws:

JXTRException - in case an error is detected.

isNullable

public int isNullable(int column)
               throws JXTRException

Indicates the nullability of values in the designated column.

Parameters:

column - 1 based column index.

Returns:

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

Throws:

JXTRException - in case an error is detected.

isSigned

public boolean isSigned(int column)
                 throws JXTRException

Indicates whether values in the designated column are signed numbers.

Parameters:

column - 1 based column index.

Returns:

true if so; false otherwise

Throws:

JXTRException - in case an error is detected.

getColumnDisplaySize

public int getColumnDisplaySize(int column)
                         throws JXTRException

Indicates the designated column's maximum width in characters.

Parameters:

column - 1 based column index.

Returns:

the maximum number of characters allowed as the width of the designated column, or 0 for XML columns.

Throws:

JXTRException - in case an error is detected.

getColumnLabel

public java.lang.String getColumnLabel(int column)
                                throws JXTRException

Gets the designated column's suggested title for use in printouts and displays.

Parameters:

column - 1 based column index.

Returns:

the suggested column title

Throws:

JXTRException - in case an error is detected.

getSchemaName

public java.lang.String getSchemaName(int column)
                               throws JXTRException

Get the designated column's table's schema.

Parameters:

column - 1 based column index.

Returns:

schema name or "" if not applicable

Throws:

JXTRException - in case an error is detected.

getPrecision

public int getPrecision(int column)
                 throws JXTRException

Get the designated column's number of decimal digits.

Parameters:

column - 1 based column index.

Returns:

precision

Throws:

JXTRException - in case an error is detected.

getScale

public int getScale(int column)
             throws JXTRException

Gets the designated column's number of digits to right of the decimal point.

Parameters:

column - 1 based column index.

Returns:

scale

Throws:

JXTRException - in case an error is detected.

getTableName

public java.lang.String getTableName(int column)
                              throws JXTRException

Gets the designated column's table name.

Parameters:

column - 1 based column index.

Returns:

table name or "" if not applicable

Throws:

JXTRException - in case an error is detected.

getCatalogName

public java.lang.String getCatalogName(int column)
                                throws JXTRException

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

Parameters:

column - 1 based column index.

Returns:

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

Throws:

JXTRException - in case an error is detected.

getColumnTypeName

public java.lang.String getColumnTypeName(int column)
                                   throws JXTRException

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

Parameters:

column - 1 based column index.

Returns:

type name used by the database. For XML columns, "" is returned.

Throws:

JXTRException - in case an error is detected.

isReadOnly

public boolean isReadOnly(int column)
                   throws JXTRException

Indicates whether the designated column is not writable.

Parameters:

column - 1 based column index.

Returns:

true if so; false otherwise

Throws:

JXTRException - in case an error is detected.

isWritable

public boolean isWritable(int column)
                   throws JXTRException

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

Parameters:

column - 1 based column index.

Returns:

true if so; false otherwise

Throws:

JXTRException - in case an error is detected.

isDefinitelyWritable

public boolean isDefinitelyWritable(int column)
                             throws JXTRException

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

Parameters:

column - 1 based column index.

Returns:

true if so; false otherwise

Throws:

JXTRException - in case an error is detected.

getColumnClassName

public java.lang.String getColumnClassName(int column)
                                    throws JXTRException

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. JXTRResultSet.getObject may return a subclass of the class returned by this method.

Parameters:

column - 1 based column index.

Returns:

the fully-qualified name of the Java class that would be used by the method JXTRResultSet.getObject to retrieve the value in the specified column

Throws:

JXTRException - in case an error is detected.