com.altair.hwm.database.sql
Class HWMResultSetMetaDataDB

java.lang.Object
  com.altair.hwm.database.sql.HWMResultSetMetaDataDB

All Implemented Interfaces:

java.sql.ResultSetMetaData

public class HWMResultSetMetaDataDB
extends java.lang.Object
implements java.sql.ResultSetMetaData

Title: HWMResultSetMetaDataDB

Description: The resultset meta data

Company: Altair Engineering, Inc.

Field Summary

Fields inherited from interface java.sql.ResultSetMetaData

columnNoNulls, columnNullable, columnNullableUnknown

Constructor Summary

HWMResultSetMetaDataDB(java.util.Vector vectColName, java.util.Vector vectColTypes)
Constructor

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HWMResultSetMetaDataDB

public HWMResultSetMetaDataDB(java.util.Vector vectColName,
                              java.util.Vector vectColTypes)

Constructor

Parameters:

vectColName - The vector of column names

vectColTypes - The vector of column types

Method Detail

getColumnCount

public int getColumnCount()
                   throws java.sql.SQLException

Returns the number of columns in this ResultSet object.

Specified by:

getColumnCount in interface java.sql.ResultSetMetaData

Returns:

the number of columns

Throws:

java.sql.SQLException - if a database access error occurs

isAutoIncrement

public boolean isAutoIncrement(int nColumn)
                        throws java.sql.SQLException

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

Specified by:

isAutoIncrement in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

isCaseSensitive

public boolean isCaseSensitive(int nColumn)
                        throws java.sql.SQLException

Indicates whether a column's case matters.

Specified by:

isCaseSensitive in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

isSearchable

public boolean isSearchable(int nColumn)
                     throws java.sql.SQLException

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

Specified by:

isSearchable in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

isCurrency

public boolean isCurrency(int nColumn)
                   throws java.sql.SQLException

Indicates whether the designated column is a cash value.

Specified by:

isCurrency in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

isNullable

public int isNullable(int nColumn)
               throws java.sql.SQLException

Indicates the nullability of values in the designated column.

Specified by:

isNullable in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

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

Throws:

java.sql.SQLException - if a database access error occurs

isSigned

public boolean isSigned(int nColumn)
                 throws java.sql.SQLException

Indicates whether values in the designated column are signed numbers.

Specified by:

isSigned in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

getColumnDisplaySize

public int getColumnDisplaySize(int nColumn)
                         throws java.sql.SQLException

Indicates the designated column's normal maximum width in characters.

Specified by:

getColumnDisplaySize in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

the normal maximum number of characters allowed as the width of the designated column

Throws:

java.sql.SQLException - if a database access error occurs

getColumnLabel

public java.lang.String getColumnLabel(int nColumn)
                                throws java.sql.SQLException

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

Specified by:

getColumnLabel in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

the suggested column title

Throws:

java.sql.SQLException - if a database access error occurs

getColumnName

public java.lang.String getColumnName(int nColumn)
                               throws java.sql.SQLException

Get the designated column's name.

Specified by:

getColumnName in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

column name

Throws:

java.sql.SQLException - if a database access error occurs

getSchemaName

public java.lang.String getSchemaName(int nColumn)
                               throws java.sql.SQLException

Get the designated column's table's schema.

Specified by:

getSchemaName in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

schema name or "" if not applicable

Throws:

java.sql.SQLException - if a database access error occurs

getPrecision

public int getPrecision(int nColumn)
                 throws java.sql.SQLException

Get the designated column's number of decimal digits.

Specified by:

getPrecision in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

precision

Throws:

java.sql.SQLException - if a database access error occurs

getScale

public int getScale(int nColumn)
             throws java.sql.SQLException

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

Specified by:

getScale in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

scale

Throws:

java.sql.SQLException - if a database access error occurs

getTableName

public java.lang.String getTableName(int nColumn)
                              throws java.sql.SQLException

Gets the designated column's table name.

Specified by:

getTableName in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

table name or "" if not applicable

Throws:

java.sql.SQLException - if a database access error occurs

getCatalogName

public java.lang.String getCatalogName(int nColumn)
                                throws java.sql.SQLException

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

Specified by:

getCatalogName in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

column name or "" if not applicable

Throws:

java.sql.SQLException - if a database access error occurs

getColumnType

public int getColumnType(int nColumn)
                  throws java.sql.SQLException

Retrieves the designated column's SQL type.

Specified by:

getColumnType in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

SQL type from java.sql.Types

Throws:

java.sql.SQLException - if a database access error occurs

See Also:

Types

getColumnTypeName

public java.lang.String getColumnTypeName(int nColumn)
                                   throws java.sql.SQLException

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

Specified by:

getColumnTypeName in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.

Throws:

java.sql.SQLException - if a database access error occurs

isReadOnly

public boolean isReadOnly(int nColumn)
                   throws java.sql.SQLException

Indicates whether the designated column is definitely not writable.

Specified by:

isReadOnly in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

isWritable

public boolean isWritable(int nColumn)
                   throws java.sql.SQLException

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

Specified by:

isWritable in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

isDefinitelyWritable

public boolean isDefinitelyWritable(int nColumn)
                             throws java.sql.SQLException

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

Specified by:

isDefinitelyWritable in interface java.sql.ResultSetMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

getColumnClassName

public java.lang.String getColumnClassName(int nColumn)
                                    throws java.sql.SQLException

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.

Specified by:

getColumnClassName in interface java.sql.ResultSetMetaData

Returns:

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.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

1.2

See Also:

What Is in the JDBC 2.0 API