com.ibm.db.base
Class DatabaseResultTableParent

java.lang.Object
  |
  +--com.ibm.db.base.DatabaseStatement
        |
        +--com.ibm.db.base.DatabaseResultTableParent
Direct Known Subclasses:
DatabaseResultTable

public abstract class DatabaseResultTableParent
extends DatabaseStatement


Field Summary
private static java.lang.String copyright
           
protected  java.util.Hashtable dbSearchTypeInfo
           
protected  java.sql.ResultSet resultSet
           
protected  int resultSetType
           
protected  DatabaseCompoundType rowStruct
           
 
Fields inherited from class com.ibm.db.base.DatabaseStatement
conn, copyright, isOpen, qSpec
 
Constructor Summary
DatabaseResultTableParent()
          This method was created in VisualAge.
DatabaseResultTableParent(DatabaseConnection aConnection, DatabaseQuerySpec aQuerySpec)
          This constructor sets the connection,name,and query spec It then prepares and executes the statement which produces a JDBC result set
 
Method Summary
 boolean absoluteRow(int row)
          This method positions the cursor on the specified row of the result set.
abstract  void addQuerySpec(DatabaseQuerySpec aQuerySpec)
          This method was created by a SmartGuide.
abstract  void cancel()
          This method sends cancel() to the JDBC statement instance.
private  void checkSearchLevel(java.lang.String columnTypeName, DatabaseTypeField columnType)
          Checks the search level for the column, based on the columnTypeName and the TypeInfo obtained from the DatabaseMetaData.
 void clearWarnings()
          This method was created in VisualAge.
 void close()
          This method sends close() to the JDBC ResultSet instance.
abstract  void closeStatement()
          This method sends close() to the JDBC statement instance.
protected  void describe()
          This method describes the row structure of the result table
protected  void describeCol(int columnIndex, DatabaseCompoundType compoundType, java.sql.ResultSetMetaData metaData)
          This method adds the appropriate field instance that maps to the Sql Data type
abstract  void execute()
          This method executes the sql statement, and retrieves a JDBC result set (if any)
abstract  void execute(DatabaseRow aRow)
          This method executes the sql statement, and retrieves a JDBC result set (if any)
protected  void fillInColumnShape()
           
abstract  java.lang.String getCursorName()
          This method returns the row structure (type)
 java.sql.ResultSetMetaData getMetaData()
          This method returns the JDBC result set meta data.
protected  java.sql.ResultSet getResultSet()
          This method returns the JDBC result set
 DatabaseRow getRow()
          This method was created by a SmartGuide.
 int getRowNumber()
          This method the row number where the ResultSet cursor is currently posititioned.
 DatabaseCompoundType getRowStruct()
          This method returns the row structure (type)
 int getType()
          This method returns the type of the java.sql.ResultSet Types are: TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, and TYPE_SCROLL_SENSITIVE
abstract  java.sql.SQLWarning getWarnings()
          This method was created in VisualAge.
 boolean lastRow()
          This method positions the cursor on the last row of the result set.
protected  DatabaseRow newEmptyRow()
          This method returns an empty row with the same type of the result table row structure
 boolean nextRow()
          This method positions the cursor on the next row of the result set.
 boolean previousRow()
          This method positions the cursor on the previous row of the result set.
abstract  void refresh()
           
abstract  void refresh(DatabaseRow parms)
           
 boolean relativeRow(int offset)
          This method positions the cursor on the row of the result set at the requested offset from the current cursor position.
protected  void setQuerySpec(DatabaseQuerySpec aQuerySpec)
          This method was created by a SmartGuide.
protected  void setResultSet(java.sql.ResultSet aResultSet)
          This method was created by a SmartGuide.
protected  void setRowStruct(DatabaseCompoundType aRowStruct)
          This method was created by a SmartGuide.
abstract  void setTimeout(int seconds)
          This method sets the query timeout of the JDBC statement
 
Methods inherited from class com.ibm.db.base.DatabaseStatement
getConnection, getQuerySpec, isCallStatement, isOpen, isSelectStatement, setConnection, setIsOpen
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

rowStruct

protected DatabaseCompoundType rowStruct

resultSet

protected java.sql.ResultSet resultSet

resultSetType

protected int resultSetType

dbSearchTypeInfo

protected transient java.util.Hashtable dbSearchTypeInfo

copyright

private static final java.lang.String copyright
Constructor Detail

DatabaseResultTableParent

public DatabaseResultTableParent()
This method was created in VisualAge.

DatabaseResultTableParent

public DatabaseResultTableParent(DatabaseConnection aConnection,
                                 DatabaseQuerySpec aQuerySpec)
This constructor sets the connection,name,and query spec It then prepares and executes the statement which produces a JDBC result set
Method Detail

absoluteRow

public boolean absoluteRow(int row)
                    throws java.sql.SQLException
This method positions the cursor on the specified row of the result set.

addQuerySpec

public abstract void addQuerySpec(DatabaseQuerySpec aQuerySpec)
This method was created by a SmartGuide.
Parameters:
aQuerySpec - DatabaseQuerySpec

cancel

public abstract void cancel()
                     throws java.sql.SQLException
This method sends cancel() to the JDBC statement instance.
Overrides:
cancel in class DatabaseStatement

checkSearchLevel

private void checkSearchLevel(java.lang.String columnTypeName,
                              DatabaseTypeField columnType)
                       throws java.sql.SQLException
Checks the search level for the column, based on the columnTypeName and the TypeInfo obtained from the DatabaseMetaData.

clearWarnings

public void clearWarnings()
                   throws java.sql.SQLException
This method was created in VisualAge.
Overrides:
clearWarnings in class DatabaseStatement
Throws:
DataException - The exception description.

close

public void close()
           throws java.sql.SQLException
This method sends close() to the JDBC ResultSet instance. The statement remains open.

closeStatement

public abstract void closeStatement()
                             throws java.sql.SQLException
This method sends close() to the JDBC statement instance.
Overrides:
closeStatement in class DatabaseStatement

describe

protected void describe()
                 throws java.sql.SQLException,
                        DataException
This method describes the row structure of the result table

describeCol

protected void describeCol(int columnIndex,
                           DatabaseCompoundType compoundType,
                           java.sql.ResultSetMetaData metaData)
                    throws java.sql.SQLException,
                           DataException
This method adds the appropriate field instance that maps to the Sql Data type

execute

public abstract void execute()
                      throws java.sql.SQLException,
                             DataException
This method executes the sql statement, and retrieves a JDBC result set (if any)
Overrides:
execute in class DatabaseStatement

execute

public abstract void execute(DatabaseRow aRow)
                      throws java.sql.SQLException,
                             DataException
This method executes the sql statement, and retrieves a JDBC result set (if any)
Overrides:
execute in class DatabaseStatement

fillInColumnShape

protected void fillInColumnShape()
                          throws java.sql.SQLException,
                                 DataException

getCursorName

public abstract java.lang.String getCursorName()
                                        throws java.sql.SQLException
This method returns the row structure (type)

getMetaData

public java.sql.ResultSetMetaData getMetaData()
                                       throws java.sql.SQLException
This method returns the JDBC result set meta data.

getResultSet

protected java.sql.ResultSet getResultSet()
This method returns the JDBC result set

getRow

public DatabaseRow getRow()
                   throws java.sql.SQLException,
                          DataException
This method was created by a SmartGuide.

getRowNumber

public int getRowNumber()
                 throws java.sql.SQLException
This method the row number where the ResultSet cursor is currently posititioned.

getRowStruct

public DatabaseCompoundType getRowStruct()
This method returns the row structure (type)

getType

public int getType()
This method returns the type of the java.sql.ResultSet Types are: TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, and TYPE_SCROLL_SENSITIVE

getWarnings

public abstract java.sql.SQLWarning getWarnings()
                                         throws java.sql.SQLException
This method was created in VisualAge.
Overrides:
getWarnings in class DatabaseStatement
Returns:
java.sql.SQLWarning

lastRow

public boolean lastRow()
                throws java.sql.SQLException
This method positions the cursor on the last row of the result set.

newEmptyRow

protected DatabaseRow newEmptyRow()
This method returns an empty row with the same type of the result table row structure

nextRow

public boolean nextRow()
                throws java.sql.SQLException
This method positions the cursor on the next row of the result set.

previousRow

public boolean previousRow()
                    throws java.sql.SQLException
This method positions the cursor on the previous row of the result set.

refresh

public abstract void refresh()
                      throws java.sql.SQLException,
                             DataException

refresh

public abstract void refresh(DatabaseRow parms)
                      throws java.sql.SQLException,
                             DataException

relativeRow

public boolean relativeRow(int offset)
                    throws java.sql.SQLException
This method positions the cursor on the row of the result set at the requested offset from the current cursor position.

setQuerySpec

protected void setQuerySpec(DatabaseQuerySpec aQuerySpec)
This method was created by a SmartGuide.
Overrides:
setQuerySpec in class DatabaseStatement
Parameters:
aQuerySpec - DatabaseQuerySpec

setResultSet

protected void setResultSet(java.sql.ResultSet aResultSet)
This method was created by a SmartGuide.
Parameters:
aResultSet - ResultSet

setRowStruct

protected void setRowStruct(DatabaseCompoundType aRowStruct)
This method was created by a SmartGuide.
Parameters:
aRowStruct - DatabaseCompoundType

setTimeout

public abstract void setTimeout(int seconds)
                         throws java.sql.SQLException
This method sets the query timeout of the JDBC statement
Overrides:
setTimeout in class DatabaseStatement