com.ibm.ims.db.cci

Class SQLInteractionSpec

java.lang.Object

com.ibm.ims.db.cci.InteractionSpecImpl

com.ibm.ims.db.cci.SQLInteractionSpec

All Implemented Interfaces:

Serializable, javax.resource.cci.InteractionSpec

public class SQLInteractionSpec
extends com.ibm.ims.db.cci.InteractionSpecImpl

Use this class to access data from an IMS database with the IMS Universal Database Resource Adapter using SQL queries. SQLInteractionSpec is used by an Interaction to execute the specified SQL query against an IMS database.

See Also:

Serialized Form

Field Summary

Fields inherited from interface javax.resource.cci.InteractionSpec

SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE

Constructor Summary

Constructors

Constructor and Description
SQLInteractionSpec()

Method Summary

Modifier and Type	Method and Description
int	getFetchSize() Retrieves the number of result set rows that is the default fetch size for ResultSet objects generated from this interaction.
String	getSQL() Retrieves the SQL query the interaction will use when executed.
void	setFetchSize(int rows) Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed.
void	setSQL(String query) Sets the SQL query the interaction will use when executed.

Methods inherited from class com.ibm.ims.db.cci.InteractionSpecImpl

getExecutionTimeout, getFetchDirection, getInteractionVerb, getMaxFieldSize, getResultSetConcurrency, getResultSetType, setExecutionTimeout, setFetchDirection, setInteractionVerb, setMaxFieldSize, setResultSetConcurrency, setResultSetType

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLInteractionSpec

public SQLInteractionSpec()

Method Detail

setSQL

public void setSQL(String query)

Sets the SQL query the interaction will use when executed. The IMS Universal Database Resource Adapter supports the same SQL statement syntax and usage as the IMS Universal JDBC driver and has the same restrictions. In the the SELECT query, you can specify the qualification column values in the WHERE clause with a ? parameter marker, meaning that the values will provided later (similar to a SELECT string for a PreparedStatement in JDBC).

The following code example shows how to specify the SELECT statement without using parameter markers, where iSpec is an instance of SQLInteractionSpec:

 iSpec.setQuery("SELECT PATIENT.PATNAME, ILLNESS.ILLNAME "+      
    "FROM pcb01.HOSPITAL,pcb01.PATIENT, pcb01.ILLNESS " +       
    "WHERE HOSPITAL.HOSPNAME='SANTA TERESA'");
 

The following example shows how to perform the SELECT statement with the parameter markers, where iSpec is an instance of SQLInteractionSpec:

 iSpec.setQuery("SELECT PATIENT.PatName, WARD.WardName "+      
    "FROM pcb01.HOSPITAL, pcb01.PATIENT, pcb01.WARD " +       
    "WHERE HOSPITAL.HospName=? AND WARD.DocCount>?");
 

Parameters:

query - a SQL query

getSQL

public String getSQL()

Retrieves the SQL query the interaction will use when executed.

Returns:

a String representing the SQL query.

setFetchSize

public void setFetchSize(int rows)

Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. The number of rows specified affects only result sets created using this interaction. If the value specified is zero, then the hint is ignored. The default value is zero.

Overrides:

setFetchSize in class com.ibm.ims.db.cci.InteractionSpecImpl

Parameters:

rows - the number of rows to fetch

getFetchSize

public int getFetchSize()

Retrieves the number of result set rows that is the default fetch size for ResultSet objects generated from this interaction.

Overrides:

getFetchSize in class com.ibm.ims.db.cci.InteractionSpecImpl

Returns:

the default fetch size for result sets generated from this interaction.