# package sqlj.runtime.profile.ref

## Interface Index

- DynamicProfile

## Class Index

- EntryInfoImpl
- JDBCProfile
- LocalStatement
- PositionedProfile
- ProfileDataImpl
- ProfileImpl
- ProfileWrapper
- RTResultSetJDBC
- RTResultSetWrapper
- RTStatementJDBCBase
- RTStatementJDBCCallable
- RTStatementJDBCPrepared
- RTStatementWrapper
- TransactionControlProfile
- TypeInfoImpl
Interface sqlj.runtime.profile.ref.DynamicProfile

# Interface sqlj.runtime.profile.ref.DynamicProfile

public interface DynamicProfile
extends ConnectedProfile

A dynamic connected profile instance is a connected profile that has the additional ability to create statements dynamically based on the text of a sql string (similar to the functionality of a jdbc connections' prepareCall/prepareStatement methods).

Note: In general, ConnectedProfiles are not expected to support dynamic operations. However, there are some cases that require the ability to dynamically create statement objects based on sql text caluculated at runtime. For example, in the case of positioned update or delete, the JDBC specification mandates that the name of the cursor be part of the sql operation text, but the name of the cursor cannot be discovered until runtime.

See Also:
  PositionedProfile

## Method Index

o prepareCall(String)
  Returns a statement object prepared to execute the passed sql operation text.
o prepareStatement(String)
  Returns a statement object prepared to execute the passed sql operation text.

## Methods

o prepareStatement

     public abstract RTStatement prepareStatement(String sql) throws SQLException

  Returns a statement object prepared to execute the passed sql operation text. The statement is not expected to contain out-parameters.

  Parameters:
    sql - the text of the sql operation in obdc syntax.
  Throws: SQLException
    if an error occurs creating the statement.

o prepareCall

     public abstract RTStatement prepareCall(String sql) throws SQLException

  Returns a statement object prepared to execute the passed sql operation text. The statement may contain out-parameters.

  Note: Since the statement returned has been dynamically created, there is no way for the implementation of this method to know what the expected bind-types of the statement are. Therefore, it is the responsibility of the client to register any out parameters on the statement returned (via calls on the underlying JDBC callable statement associated with the statement).

  Parameters:
    sql - the text of the sql operation in obdc syntax.
  Throws: SQLException
    if an error occurs creating the statement.

Class sqlj.runtime.profile.ref.EntryInfoImpl

# Class sqlj.runtime.profile.ref.EntryInfoImpl

    java.lang.Object
       |
       +----sqlj.runtime.profile.EntryInfo
               |
               +----sqlj.runtime.profile.ref.EntryInfoImpl

public class EntryInfoImpl
extends EntryInfo

The EntryInfoImpl object provides a concrete implementation of the EntryInfo class. An entry info object contains the constant information describing a static sql operation constructed at translation time, including the sql string in JDBC format, the return type of the operation, the types of each bind parameter, and the way in which the operation is to be executed at runtime.

## Constructor Index

o EntryInfoImpl(String, int, int, int, int, Object, TypeInfo[], TypeInfo[], int, String)
  Creates a new entry info object using the passed entry state.

## Method Index

o getDescriptor()
  Returns an object which describes any additional information particular to this entry.
o getExecuteType()
  Describes the way in which the all jdbc statements associated with this entry will be executed by the sqlj runtime.
o getLineNumber()
  Returns the starting line number of the operation represented by this entry, 0 if not available.
o getParamCount()
o getParamInfo(int)
o getResultSetCount()
  Returns the number of columns in the result set produced by this entry, which is always 0 or greater.
o getResultSetInfo(int)
  Returns a description of the result set column at index "ndx".
o getResultSetName()
o getResultSetType()
  Returns the type of result produced by this entry.
o getRole()
  Returns the role of the operation to be executed.
o getSQLString()
o getStatementType()
  Describes the type of statement for this entry.

## Constructors

o EntryInfoImpl

     public EntryInfoImpl(String sql,
                          int statementType,
                          int execType,
                          int role,
                          int resultSetType,
                          Object descriptor,
                          TypeInfo params[],
                          TypeInfo results[],
                          int lineNumber,
                          String resultSetName)

  Creates a new entry info object using the passed entry state.

  Parameters:
    sql - the text of the sql operation for this entry in odbc format
    statementType - the type of the statements produced by this entry
    execType - the way in which statements produced by this entry will be executed.
    role - the role of the operation represented by this entry
    resultSetType - the type of result set produced by this entry
    descriptor - object describing auxilary information for this entry
    params - array describing the parameters used by this entry
    results - array describnig the results produced by this entry
    lineNumber - the starting line number of this operation in the original source file, 0 if not available.
    resultSetName - the name of the strongly typed result set populated by this entry.
  Throws: IllegalArgumentException
    if arguments passed would produce an invalid entry.
  See Also:
    validateObject

## Methods

o getSQLString

     public String getSQLString()

  Returns:
    the text of the operation to be performed, in jdbc format.
  Overrides:
    getSQLString in class EntryInfo
  See Also:
    getSQLString

o getStatementType

     public int getStatementType()

  Describes the type of statement for this entry.

  Overrides:
    getStatementType in class EntryInfo
  See Also:
    getStatementType

o getExecuteType

     public int getExecuteType()

  Describes the way in which the all jdbc statements associated with this entry will be executed by the sqlj runtime.

  Overrides:
    getExecuteType in class EntryInfo
  See Also:
    getExecuteType

o getRole

     public int getRole()

  Returns the role of the operation to be executed. The role categorizes the operation, and is used to determine how the operation is to be treated by the sqlj runtime.

  Overrides:
    getRole in class EntryInfo
  See Also:
    getExecuteType

o getResultSetType

     public int getResultSetType()

  Returns the type of result produced by this entry.

  Overrides:
    getResultSetType in class EntryInfo
  See Also:
    getResultSetType

o getResultSetCount

     public int getResultSetCount()

  Returns the number of columns in the result set produced by this entry, which is always 0 or greater. If the operation does not produce a result set, 0 is returned.

  Overrides:
    getResultSetCount in class EntryInfo
  See Also:
    getResultSetCount

o getResultSetInfo

     public TypeInfo getResultSetInfo(int ndx)

  Returns a description of the result set column at index "ndx".

  Parameters:
    ndx - the index of the result set column to describe, range 1 to getResultSetCount().
  Returns:
    a description of the result set column at index "ndx", or null if "ndx" out of range.
  Overrides:
    getResultSetInfo in class EntryInfo
  See Also:
    getResultSetInfo

o getResultSetName

     public String getResultSetName()

  Overrides:
    getResultSetName in class EntryInfo

o getParamCount

     public int getParamCount()

  Returns:
    the number of parameters for this entry, 0 or greater.
  Overrides:
    getParamCount in class EntryInfo

o getParamInfo

     public TypeInfo getParamInfo(int ndx)

  Parameters:
    ndx - the index of the parameter to describe, range 1 to getParamCount().
  Returns:
    a description of the parameter at index "ndx", or null if "ndx" out of range.
  Overrides:
    getParamInfo in class EntryInfo

o getDescriptor

     public Object getDescriptor()

  Returns an object which describes any additional information particular to this entry. The object returned will vary according to the role of the sql statement contained in this entry.

  Returns:
    a descriptor object for this entry.
  Overrides:
    getDescriptor in class EntryInfo
  See Also:
    getDescriptor

o getLineNumber

     public int getLineNumber()

  Returns the starting line number of the operation represented by this entry, 0 if not available.

  Overrides:
    getLineNumber in class EntryInfo
  See Also:
    getLineNumber

Class sqlj.runtime.profile.ref.JDBCProfile

# Class sqlj.runtime.profile.ref.JDBCProfile

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.JDBCProfile

public class JDBCProfile
extends Object
implements DynamicProfile

A JDBCProfile is a dynamic connected profile that implements the getStatement, prepareStatement and prepareCall methods using the standard jdbc dynamic sql mapping. This profile employs lazy verification and creation of statement objects (no statements are created until requested).

## Constructor Index

o JDBCProfile(Connection, ProfileData)
  Creates a new object which operates on the passed profile data using the passed connection.

## Method Index

o close()
  Closes the jdbc connected profile instance resources.
o getConnection()
o getProfileData()
o getStatement(int)
  Creates a statement implemented using JDBC.
o prepareCall(String)
  Creates and returns an instance of class RTStatementJDBCCallable.
o prepareStatement(String)
  Creates and returns an instance of class RTStatementJDBCPrepared.

## Constructors

o JDBCProfile

     public JDBCProfile(Connection conn,
                        ProfileData profileData)

  Creates a new object which operates on the passed profile data using the passed connection.

  Parameters:
    conn - the JDBC connection from which to create statements
    profileData - the profile data with which to operate
  See Also:
    getConnectedProfile

## Methods

o getProfileData

     public ProfileData getProfileData()

  Returns:
    s the profile data with which this object was created

o getConnection

     public Connection getConnection()

  Returns:
    s the JDBC connection with which this object was created

o getStatement

     public RTStatement getStatement(int ndx) throws SQLException

  Creates a statement implemented using JDBC. If the statementType is CALLABLE, prepareCall is used to create the statement. Otherwise, prepareStatement is used. Any out-parameters of the statement are registered on the underlying JDBC statement before the statement is returned. The SQL string stored in the profile data entry for the passed index is used to create the statement.

  Throws: SQLException
    if an error occurs while preparing statement
  See Also:
    getSQLString, getStatementType, prepareStatement, prepareCall

o prepareCall

     public RTStatement prepareCall(String sql) throws SQLException

  Creates and returns an instance of class RTStatementJDBCCallable. The underlying callable statement is created based on the passed operation text with a call to the standard JDBC defined `Connection.prepareCall()` method.

  The caller must register out-parameters of the statement returned.

  Parameters:
    the - text of the sql operation to prepare
  Throws: SQLException
    if an error occurs while preparing call
  See Also:
    getSQLString, RTStatementJDBCCallable

o prepareStatement

     public RTStatement prepareStatement(String sql) throws SQLException

  Creates and returns an instance of class RTStatementJDBCPrepared. The underlying callable statement is created based on the passed operation text with a call to the standard JDBC defined `Connection.prepareStatement()` method.

  Parameters:
    the - text of the sql operation to prepare
  Throws: SQLException
    if an error occurs while preparing statement
  See Also:
    getSQLString, RTStatementJDBCPrepared

o close

     public void close() throws SQLException

  Closes the jdbc connected profile instance resources.

  Throws: SQLException
    if an error occurs while closing

Class sqlj.runtime.profile.ref.LocalStatement

# Class sqlj.runtime.profile.ref.LocalStatement

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.RTStatementWrapper
               |
               +----sqlj.runtime.profile.ref.LocalStatement

public class LocalStatement
extends RTStatementWrapper

A local statement is a statement that is executed locally, without requiring the standard RDBMS round-trip. As such, it provides default behavior for many of the RTStatement methods that only have meaning in the context of remote execution.

It is expected that subclasses will implement the proper execute method.

Note: Methods that are not directly implemented in this class or a subclass will throw a null pointer exception when executed.

## Constructor Index

o LocalStatement()
  Constructs a new local statement.

## Method Index

o cancel()
  Local statements do nt require cancellation.
o clearWarnings()
  Since local statements have no warnings, this operation is a no-op
o executeComplete()
  This is a no-op since the statement is local.
o getJDBCCallableStatement()
  Since there is no underlying JDBC statement, this method always throws an exception.
o getJDBCPreparedStatement()
  Since there is no underlying JDBC statement, this method always throws an exception.
o getMaxFieldSize()
  Returns the value set in the last call to setMaxField size, or 0 by default.
o getMaxRows()
  Returns the value set in the last call to setMaxRows size, or 0 by default.
o getQueryTimeout()
  Returns the value set in the last call to setQueryTimeout size, or 0 by default.
o getWarnings()
  Local statements do not produce warnings.
o setMaxFieldSize(int)
  Sets the max field size.
o setMaxRows(int)
  Sets the max rows.
o setQueryTimeout(int)
  Sets the query timeout.

## Constructors

o LocalStatement

     public LocalStatement()

  Constructs a new local statement. The statement wrapped by a local statement is null by default.

## Methods

o getJDBCPreparedStatement

     public PreparedStatement getJDBCPreparedStatement() throws SQLException

  Since there is no underlying JDBC statement, this method always throws an exception.

  Throws: SQLException
    whenever called
  Overrides:
    getJDBCPreparedStatement in class RTStatementWrapper

o getJDBCCallableStatement

     public CallableStatement getJDBCCallableStatement() throws SQLException

  Since there is no underlying JDBC statement, this method always throws an exception.

  Throws: SQLException
    whenever called
  Overrides:
    getJDBCCallableStatement in class RTStatementWrapper

o getMaxFieldSize

     public int getMaxFieldSize()

  Returns the value set in the last call to setMaxField size, or 0 by default.

  Overrides:
    getMaxFieldSize in class RTStatementWrapper

o setMaxFieldSize

     public void setMaxFieldSize(int max)

  Sets the max field size. Since the execution is local, this has no direct effect on the execution of the statement.

  Overrides:
    setMaxFieldSize in class RTStatementWrapper

o getMaxRows

     public int getMaxRows()

  Returns the value set in the last call to setMaxRows size, or 0 by default.

  Overrides:
    getMaxRows in class RTStatementWrapper

o setMaxRows

     public void setMaxRows(int max)

  Sets the max rows. Since the execution is local, this has no direct effect on the execution of the statement.

  Overrides:
    setMaxRows in class RTStatementWrapper

o getQueryTimeout

     public int getQueryTimeout()

  Returns the value set in the last call to setQueryTimeout size, or 0 by default.

  Overrides:
    getQueryTimeout in class RTStatementWrapper

o setQueryTimeout

     public void setQueryTimeout(int seconds)

  Sets the query timeout. Since the execution is local, this has no direct effect on the execution of the statement.

  Overrides:
    setQueryTimeout in class RTStatementWrapper

o executeComplete

     public void executeComplete()

  This is a no-op since the statement is local. There is no state to clean up.

  Overrides:
    executeComplete in class RTStatementWrapper

o cancel

     public void cancel()

  Local statements do nt require cancellation. This call is a no-op.

  Overrides:
    cancel in class RTStatementWrapper

o getWarnings

     public SQLWarning getWarnings()

  Local statements do not produce warnings.

  Returns:
    null
  Overrides:
    getWarnings in class RTStatementWrapper

o clearWarnings

     public void clearWarnings()

  Since local statements have no warnings, this operation is a no-op

  Overrides:
    clearWarnings in class RTStatementWrapper

Class sqlj.runtime.profile.ref.PositionedProfile

# Class sqlj.runtime.profile.ref.PositionedProfile

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.ProfileWrapper
               |
               +----sqlj.runtime.profile.ref.PositionedProfile

public class PositionedProfile
extends ProfileWrapper

A positioned profile is a connected profile wrapper which augments the functionality of the statement creation methods by intercepting any entries with role of POSITIONED, and handling execute of such an entry by creating a new sql operation dynamically with the runtime name of the cursor replacing the ? in the original CURRENT OF ? expression.

Entries with role of POSITIONED have a sql operation that includes the text WHERE CURRENT OF ?. For example, UPDATE TAB SET COL1=? WHERE CURRENT OF ?. The JDBC specification indicates that portable handling of CURRENT OF statements involves passing the name of the current-of-cursor as part of the sql operation rather than as a bind variable. Thus, in the above case, if the cursor name were "CURS", then the text of the new operation created at runtime would be UPDATE TAB SET COL1=? WHERE CURRENT OF CURS. To facilitate construction of the proper sql operation, the entry descriptor for POSITIONED entries is an Integer that describes which passed parameter represents the cursor.

If the operation also includes bind variables, these are stored in an internal cache until the new statement is created, and are then bound to the statement once it has been prepared. We assume that POSITIONED entries only occur with an executeType of EXECUTE_UPDATE and statementType of PREPARED_STATEMENT.

See Also:
  POSITIONED

## Constructor Index

o PositionedProfile(DynamicProfile)
  Creates a new positioned profile that augments the functionality of the passed connected profile.

## Method Index

o getStatement(int)
  Returns an executable statement object representing the statement at index "ndx" in the profile, where "ndx" is 0 based.
o setWrappedProfile(ConnectedProfile)
  The underlying profile for a positioned profile can only be reset if the new profile is a dynamic profile.

## Constructors

o PositionedProfile

     public PositionedProfile(DynamicProfile profile)

  Creates a new positioned profile that augments the functionality of the passed connected profile. Note that since the sql operation will be created at runtime, the passed profile must support dynamic operations.

  Parameters:
    profile - the dynamic connected profile to wrap

## Methods

o setWrappedProfile

     public boolean setWrappedProfile(ConnectedProfile newProfile)

  The underlying profile for a positioned profile can only be reset if the new profile is a dynamic profile.

  Overrides:
    setWrappedProfile in class ProfileWrapper

o getStatement

     public RTStatement getStatement(int ndx) throws SQLException

  Returns an executable statement object representing the statement at index "ndx" in the profile, where "ndx" is 0 based. If the role of the entry at the given index is not POSITIONED, the statement is created using the `prepareStatement` method of the underlying dynamic profile. If the role is POSITIONED, the object returned is a statement that, when executed, dynamically prepares and executes a new statement with the text of the original statement, but the dynamic name of the cursor substituted in place of the '?'. All bound inputs are cached and transferred to the newly created statement before execution.

  It is assumed that POSITIONED statements are always handled with PREPARED statements via the executeUpdate method. If the entry info describes otherwise, this method will raise an exception.

  Parameters:
    the - index of the statement to return, 0 based.
  Throws: SQLException
    if an error occurs preparing the statement.
  Overrides:
    getStatement in class ProfileWrapper
  See Also:
    getRole, POSITIONED, getStatementType, getExecuteType

Class sqlj.runtime.profile.ref.ProfileDataImpl

# Class sqlj.runtime.profile.ref.ProfileDataImpl

    java.lang.Object
       |
       +----sqlj.runtime.profile.ProfileData
               |
               +----sqlj.runtime.profile.ref.ProfileDataImpl

public class ProfileDataImpl
extends ProfileData

The profile data impl class provides a concrete implementation of the profile data class. It manages a collection of profile entries, where each entry describes a static sql operation. A profile data object represents the sql resources of a particular connection context defined within an application module.

## Constructor Index

o ProfileDataImpl(EntryInfo[], Profile, String)
  Creates a new profile data object.

## Method Index

o getEntryInfo(int)
o getProfile()
o getSourceFile()
  Returns the name of the source file from which this profile was generated, or null if not available.
o size()

## Constructors

o ProfileDataImpl

     public ProfileDataImpl(EntryInfo entries[],
                            Profile profile,
                            String sourceFile)

  Creates a new profile data object.

  Parameters:
    entries - the entires in the profile data
    profile - the base profile associated with this object
    sourceFile - the name of the source file producing this profile, null if not available.

## Methods

o size

     public int size()

  Returns:
    the number of entries in the profile
  Overrides:
    size in class ProfileData

o getEntryInfo

     public EntryInfo getEntryInfo(int ndx)

  Parameters:
    ndx - the index of the entry which is describe, range 0 to size()-1.
  Returns:
    a description of the entry at index "ndx" in the profile.
  Overrides:
    getEntryInfo in class ProfileData

o getProfile

     public Profile getProfile()

  Returns:
    the profile with which this object is associated
  Overrides:
    getProfile in class ProfileData

o getSourceFile

     public String getSourceFile()

  Returns the name of the source file from which this profile was generated, or null if not available.

  Overrides:
    getSourceFile in class ProfileData
  See Also:
    getSourceFile

Class sqlj.runtime.profile.ref.ProfileImpl

# Class sqlj.runtime.profile.ref.ProfileImpl

    java.lang.Object
       |
       +----sqlj.runtime.profile.Profile
               |
               +----sqlj.runtime.profile.ref.ProfileImpl

public class ProfileImpl
extends Profile

The ProfileImpl class provides a concrete implementation of the Profile class. A profile is a resource which contains the "constant" information describing a set of sql operations. It also provides a mechanism to add a JDBC connection to a profile, and in so doing, create a "ConnectedProfile" which can be used to create executable statement objects corresponding to the sql statements contained within the profile.

## Constructor Index

o ProfileImpl(String, String, EntryInfo[], Loader, String)
  Creates a new profile instance having the given profile name, context name, set of entries and loader.

## Method Index

o deregisterCustomization(Customization)
  Drop a customization from the profile's list.
o getConnectedProfile(Connection)
  Resolves the contents of this profile with the passed JDBC connection and returns the result.
o getContextName()
  Returns the fully qualified name of the connection context for this profile.
o getCustomizations()
o getDefaultProfile(Connection, ProfileData)
  Returns a default connected profile object.
o getProfileData()
o getProfileName()
o getTimestamp()
  Returns the creation time of the profile, as given by System.currentTimeMillis.
o registerCustomization(Customization)
  Registers a customization for this profile instance.
o registerCustomization(Customization, Customization)
  Registers a customization for this profile instance.
o replaceCustomization(Customization, Customization)
  Registers a customization for this profile instance.

## Constructors

o ProfileImpl

     public ProfileImpl(String profileName,
                        String contextName,
                        EntryInfo entries[],
                        Loader loader,
                        String sourceFile)

  Creates a new profile instance having the given profile name, context name, set of entries and loader. The profile timestamp is created based on the current system time.

  Note that this method should only be used to create new profiles. To instantiate an existing profile object, use the `instantiate` method. This constructor is used at translation time to create a new profile for serialization.

  Parameters:
    profileName - the fully qualified name of the profile
    contextName - the fully qualified name of the connection context associated with the profile.
    entries - the profile data contents for this profile
    loader - the loader to associate with this instance of the profile
    sourceFile - the name of the source file producing this profile, null if not available.
  See Also:
    instantiate, currentTimeMillis

## Methods

o getProfileName

     public String getProfileName()

  Returns:
    the fully qualified name of the profile.
  Overrides:
    getProfileName in class Profile

o getContextName

     public String getContextName()

  Returns the fully qualified name of the connection context for this profile.

  Overrides:
    getContextName in class Profile
  See Also:
    getContextName

o getTimestamp

     public long getTimestamp()

  Returns the creation time of the profile, as given by System.currentTimeMillis.

  Returns:
    the timestamp of the profile.
  Overrides:
    getTimestamp in class Profile
  See Also:
    getTimestamp

o getProfileData

     public ProfileData getProfileData()

  Returns:
    a data object describing each of the sql operations contained in this profile.
  Overrides:
    getProfileData in class Profile
  See Also:
    getProfileData

o getConnectedProfile

     public ConnectedProfile getConnectedProfile(Connection conn) throws SQLException

  Resolves the contents of this profile with the passed JDBC connection and returns the result. The implementation of this method will return the connected-profile associated with the first registered customization that accepts the passed connection. If no customization is found that accepts the connection, a default connected-profile implementation based on JDBC dynamic sql will be returned.

  Parameters:
    conn - a jdbc Connection over which to perform operations.
  Returns:
    the result of attaching this profile to the given connection.
  Throws: SQLException
    if a connected-profile cannot be created for the supplied connection.
  Overrides:
    getConnectedProfile in class Profile
  See Also:
    Customization, getDefaultProfile, getConnectedProfile

o getDefaultProfile

     public static ConnectedProfile getDefaultProfile(Connection conn,
                                                      ProfileData data)

  Returns a default connected profile object. The passed JDBC connection parameter specifies the connection over which to execute operations. The passed ProfileData parameter specifies the data on which to operate.

  The default connected profile has the following properties:

  - The JDBC model of dynamic sql execution is used to create statement objects; a statement type of PREPARED will be mapped to a `prepareStatement` call on the associated JDBC connection object, passing the sql string of the appropriate profile entry as an argument. Any out parameters are registered using `registerOutParameter` calls on the JDBC statement created; the sql type stored in the type info of the appropriate profile entry is used during registration.
  - Transaction control entries are handled by the connection; when a statement object is created whose role appears as COMMIT in the profile entry, the execution of that statement will invoke a `commit` method on the asscoiated JDBC connection; execution of a statement whose role was ROLLBACK invokes a `rollback` method on the connection; execution of a statement whose role was SET_TRANSACTION invokes `setReadOnly` and `setIsolationLevel` methods on the connection.
  - Statements containing a WHERE CURRENT OF clause (profile entry role is POSITIONED) are executed by dynamically creating a new statement object with the runtime name of the cursor parameter substituted for the '?' in the original sql string.

  Note: A profile customization may create and maintain a modified version of the profile data object associated with a particular profile instance. In such cases, this method may be used to create a connected profile which applies the default semantics to custom data.

  Parameters:
    conn - the JDBC connection upon which to create the connected profile.
    data - the profile data object upon which the resulting connected profile will operate.
  Returns:
    s a default connected profile object
  See Also:
    JDBCProfile, TransactionControlProfile, PositionedProfile, IterConvertProfile

o registerCustomization

     public void registerCustomization(Customization customization)

  Registers a customization for this profile instance. The customization is added after all currently registered customizations.

  Generally, a runtime environment will not call this method directly. Rather, this method may be called by customization utilities which operate on application profiles during an "installation" phase.

  Throws: NullPointerException
    if the customization argument is null
  Overrides:
    registerCustomization in class Profile

o registerCustomization

     public void registerCustomization(Customization newCustomization,
                                       Customization nextCustomization)

  Registers a customization for this profile instance. The new customization is added to the list just prior to the next customization argument. If the next customization is not currently registered, an exception is raised.

  Generally, a runtime environment will not call this method directly. Rather, this method may be called by customization utilities which operate on application profiles during an "installation" phase.

  Parameters:
    newCustomization - the customization to register
    nextCustomization - the customization before which to add the new customization
  Throws: NullPointerException
    if the new customization argument is null
  Throws: IllegalArgumentException
    if the next customization argument is not currently registered
  Overrides:
    registerCustomization in class Profile

o replaceCustomization

     public void replaceCustomization(Customization newCustomization,
                                      Customization oldCustomization)

  Registers a customization for this profile instance. The new customization is added to the list in place of the old customization argument. The new customization retains the position of the old customization. If the old customization is not currently registered, an exception is raised.

  Generally, a runtime environment will not call this method directly. Rather, this method may be called by customization utilities which operate on application profiles during an "installation" phase.

  Parameters:
    newCustomization - the customization to register
    oldCustomization - the customization to replace
  Throws: NullPointerException
    if the new customization argument is null
  Throws: IllegalArgumentException
    if the old customization argument is not currently registered
  Overrides:
    replaceCustomization in class Profile

o deregisterCustomization

     public void deregisterCustomization(Customization customization)

  Drop a customization from the profile's list.

  Throws: IllegalArgumentException
    if the customization argument is not currently registered
  Overrides:
    deregisterCustomization in class Profile

o getCustomizations

     public Enumeration getCustomizations()

  Returns:
    an enumeration of all customizations currently registered with the profile.
  Overrides:
    getCustomizations in class Profile

Class sqlj.runtime.profile.ref.ProfileWrapper

# Class sqlj.runtime.profile.ref.ProfileWrapper

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.ProfileWrapper

public class ProfileWrapper
extends Object
implements ConnectedProfile

This class is the superclass of all classes that augment the functionality of connected profiles. These connected profiles sit on top of (wrap) an already existing connected profile (the underlying connected profile), but provide additional functionality.

The class ProfileWrapper itself overrides all methods of ConnectedProfile with versions that pass all requests to the underlying connected profile. Subclasses of ProfileWrapper may further override some of these methods as well as provide additional methods and fields.

## Variable Index

o baseProfile
  The underlying connected profile.

## Constructor Index

o ProfileWrapper(ConnectedProfile)
  Creates an connected profile wrapper built on top of the specified connected profile.

## Method Index

o close()
  Calls the `close` method on the underlying connected profile.
o getConnection()
  Returns the result of calling the `getConnection` method on the underlying connected profile.
o getProfileData()
  Returns the result of calling the `getProfileData` method on the underlying connected profile.
o getStatement(int)
  Returns the result of calling the `getStatement` method on the underlying connected profile.
o getWrappedProfile()
  Returns the underlying connected profile to which all method implementations are deferred.
o setWrappedProfile(ConnectedProfile)
  Returns true if the underlying connected profile can be replaced with the passed connected profile, false otherwise.

## Variables

o baseProfile

     protected ConnectedProfile baseProfile

  The underlying connected profile.

## Constructors

o ProfileWrapper

     public ProfileWrapper(ConnectedProfile profile)

  Creates an connected profile wrapper built on top of the specified connected profile.

  Parameters:
    profile - the underlying connected profile.

## Methods

o getWrappedProfile

     public ConnectedProfile getWrappedProfile()

  Returns the underlying connected profile to which all method implementations are deferred.

o setWrappedProfile

     public boolean setWrappedProfile(ConnectedProfile newProfile)

  Returns true if the underlying connected profile can be replaced with the passed connected profile, false otherwise. If true is returned, then the underlying connected profile will be replaced with the passed profile. If false is returned, the underlying profile is left unchanged. This method is useful for adding profile layering between existing layers as opposed to strictly to the top layer.

  Note: the default implementation will always replace the underlying connected profile. Subclasses should override this method if non-default behavior is required.

o getProfileData

     public ProfileData getProfileData()

  Returns the result of calling the `getProfileData` method on the underlying connected profile.

o getConnection

     public Connection getConnection()

  Returns the result of calling the `getConnection` method on the underlying connected profile.

o getStatement

     public RTStatement getStatement(int ndx) throws SQLException

  Returns the result of calling the `getStatement` method on the underlying connected profile.

  Throws: SQLException
    if an error occurs in the wrapped profile

o close

     public void close() throws SQLException

  Calls the `close` method on the underlying connected profile.

  Throws: SQLException
    if an error occurs in the wrapped profile

Class sqlj.runtime.profile.ref.RTResultSetJDBC

# Class sqlj.runtime.profile.ref.RTResultSetJDBC

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.RTResultSetJDBC

public class RTResultSetJDBC
extends Object
implements RTResultSet

This class implements the RTResultSet interface using a JDBC ResultSet.

## Variable Index

o rs
  The underlying JDBC result set with which this class is implemented

## Constructor Index

o RTResultSetJDBC(ResultSet)
  Creates a new RTResultSet that uses the passed ResultSet to implement its methods.

## Method Index

o close()
  Calls the `close` method on the underlying result set.
o finalize()
  finalizes the super object and calls close if this iterator has not already been closed.
o findColumn(String)
  Returns the result of calling the `findColumn` method on the underlying result set.
o getAsciiStreamWrapper(int)
  Fetches an InputStream using the `getAsciiStream` method of the underlying result set.
o getBigDecimal(int)
  Fetches a BigDecimal from the underlying result set using `getObject`.
o getBinaryStreamWrapper(int)
  Fetches an InputStream using the `getBinaryStream` method of the underlying result set.
o getBooleanNoNull(int)
  Fetches the result using the `getBoolean` method of the underlying result set.
o getBooleanWrapper(int)
  Fetches a primitive type using the `getBoolean` method of the underlying result set.
o getByteNoNull(int)
  Fetches the result using the `getByte` method of the underlying result set.
o getBytes(int)
  Returns the result of calling the `getBytes` method on the underlying result set.
o getByteWrapper(int)
  Fetches a primitive type using the `getByte` method of the underlying result set.
o getColumnCount()
  Returns the column count using the result set meta data `getColumnCount` method.
o getCursorName()
  Returns the result of calling the `getCursorName` method on the underlying result set.
o getDate(int)
  Returns the result of calling the `getDate` method on the underlying result set.
o getDoubleNoNull(int)
  Fetches the result using the `getDouble` method of the underlying result set.
o getDoubleWrapper(int)
  Fetches a primitive type using the `getDouble` method of the underlying result set.
o getFloatNoNull(int)
  Fetches the result using the `getFloat` method of the underlying result set.
o getFloatWrapper(int)
  Fetches a primitive type using the `getFloat` method of the underlying result set.
o getIntNoNull(int)
  Fetches the result using the `getInt` method of the underlying result set.
o getIntWrapper(int)
  Fetches a primitive type using the `getInt` method of the underlying result set.
o getJDBCResultSet()
  Returns the underlying result set to which all method implementations are deferred.
o getLongNoNull(int)
  Fetches the result using the `getLong` method of the underlying result set.
o getLongWrapper(int)
  Fetches a primitive type using the `getLong` method of the underlying result set.
o getObject(int, Class)
  Fetches the object from the underlying result set using `getObject`.
o getShortNoNull(int)
  Fetches the result using the `getShort` method of the underlying result set.
o getShortWrapper(int)
  Fetches a primitive type using the `getShort` method of the underlying result set.
o getString(int)
  Returns the result of calling the `getString` method on the underlying result set.
o getTime(int)
  Returns the result of calling the `getTime` method on the underlying result set.
o getTimestamp(int)
  Returns the result of calling the `getTimestamp` method on the underlying result set.
o getUnicodeStreamWrapper(int)
  Fetches an InputStream using the `getUnicodeStream` method of the underlying result set.
o isClosed()
  Returns true is `close` has been called, false otherwise.
o isValidRow()
  Returns true iff the result set if currently positioned on a row.
o next()
  Returns the result of calling the `next` method on the underlying result set.

## Variables

o rs

     protected ResultSet rs

  The underlying JDBC result set with which this class is implemented

## Constructors

o RTResultSetJDBC

     public RTResultSetJDBC(ResultSet rs)

  Creates a new RTResultSet that uses the passed ResultSet to implement its methods.

  Parameters:
    rs - the underlying JDBC result set

## Methods

o getJDBCResultSet

     public ResultSet getJDBCResultSet()

  Returns the underlying result set to which all method implementations are deferred.

o next

     public boolean next() throws SQLException

  Returns the result of calling the `next` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o getCursorName

     public String getCursorName() throws SQLException

  Returns the result of calling the `getCursorName` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o findColumn

     public int findColumn(String columnName) throws SQLException

  Returns the result of calling the `findColumn` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o getString

     public String getString(int columnIndex) throws SQLException

  Returns the result of calling the `getString` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o getBytes

     public byte[] getBytes(int columnIndex) throws SQLException

  Returns the result of calling the `getBytes` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o getDate

     public Date getDate(int columnIndex) throws SQLException

  Returns the result of calling the `getDate` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o getTime

     public Time getTime(int columnIndex) throws SQLException

  Returns the result of calling the `getTime` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o getTimestamp

     public Timestamp getTimestamp(int columnIndex) throws SQLException

  Returns the result of calling the `getTimestamp` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o getBooleanNoNull

     public boolean getBooleanNoNull(int columnIndex) throws SQLException

  Fetches the result using the `getBoolean` method of the underlying result set. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the column is null
  Throws: SQLException
    if an error occurs in the underlying result set

o getByteNoNull

     public byte getByteNoNull(int columnIndex) throws SQLException

  Fetches the result using the `getByte` method of the underlying result set. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the column is null
  Throws: SQLException
    if an error occurs in the underlying result set

o getShortNoNull

     public short getShortNoNull(int columnIndex) throws SQLException

  Fetches the result using the `getShort` method of the underlying result set. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the column is null
  Throws: SQLException
    if an error occurs in the underlying result set

o getIntNoNull

     public int getIntNoNull(int columnIndex) throws SQLException

  Fetches the result using the `getInt` method of the underlying result set. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the column is null
  Throws: SQLException
    if an error occurs in the underlying result set

o getLongNoNull

     public long getLongNoNull(int columnIndex) throws SQLException

  Fetches the result using the `getLong` method of the underlying result set. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the column is null
  Throws: SQLException
    if an error occurs in the underlying result set

o getFloatNoNull

     public float getFloatNoNull(int columnIndex) throws SQLException

  Fetches the result using the `getFloat` method of the underlying result set. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the column is null
  Throws: SQLException
    if an error occurs in the underlying result set

o getDoubleNoNull

     public double getDoubleNoNull(int columnIndex) throws SQLException

  Fetches the result using the `getDouble` method of the underlying result set. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the column is null
  Throws: SQLException
    if an error occurs in the underlying result set

o getBooleanWrapper

     public Boolean getBooleanWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getBoolean` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying result set

o getByteWrapper

     public Byte getByteWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getByte` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying result set

o getShortWrapper

     public Short getShortWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getShort` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying result set

o getIntWrapper

     public Integer getIntWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getInt` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying result set

o getLongWrapper

     public Long getLongWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getLong` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying result set

o getFloatWrapper

     public Float getFloatWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getFloat` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying result set

o getDoubleWrapper

     public Double getDoubleWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getDouble` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying result set

o getAsciiStreamWrapper

     public AsciiStream getAsciiStreamWrapper(int columnIndex) throws SQLException

  Fetches an InputStream using the `getAsciiStream` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise an AsciiStream is created and returned that wraps the fetched stream.

  Throws: SQLException
    if an error occurs in the underlying result set

o getBinaryStreamWrapper

     public BinaryStream getBinaryStreamWrapper(int columnIndex) throws SQLException

  Fetches an InputStream using the `getBinaryStream` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise a BinaryStream is created and returned that wraps the fetched stream.

  Throws: SQLException
    if an error occurs in the underlying result set

o getUnicodeStreamWrapper

     public UnicodeStream getUnicodeStreamWrapper(int columnIndex) throws SQLException

  Fetches an InputStream using the `getUnicodeStream` method of the underlying result set. If a subsequent call to `wasNull` returns true, null is returned. Otherwise a UnicodeStream is created and returned that wraps the fetched stream.

  Throws: SQLException
    if an error occurs in the underlying result set

o getObject

     public Object getObject(int columnIndex,
                             Class objectType) throws SQLException

  Fetches the object from the underlying result set using `getObject`. Verifies that the object fetched can be assigned to an argument having the passed class object type.

  Throws: SQLException
    if an error occurs in the underlying result set, or the object has an incompatible type

o getBigDecimal

     public BigDecimal getBigDecimal(int columnIndex) throws SQLException

  Fetches a BigDecimal from the underlying result set using `getObject`.

  Throws: SQLException
    if an error occurs in the underlying result set, or the object has an incompatible type

o getColumnCount

     public int getColumnCount() throws SQLException

  Returns the column count using the result set meta data `getColumnCount` method.

  Throws: SQLException
    if an error occurs in the underlying result set

o isValidRow

     public boolean isValidRow() throws SQLException

  Returns true iff the result set if currently positioned on a row.

  Throws: SQLException
    if an error occurs in the underlying result set

o isClosed

     public boolean isClosed() throws SQLException

  Returns true is `close` has been called, false otherwise.

  Throws: SQLException
    if an error occurs

o close

     public void close() throws SQLException

  Calls the `close` method on the underlying result set.

  Throws: SQLException
    if an error occurs in the wrapped result set

o finalize

     protected void finalize() throws Throwable

  finalizes the super object and calls close if this iterator has not already been closed.

  Throws: Throwable
    if an error occurs during finalization
  Overrides:
    finalize in class Object
  See Also:
    close

Class sqlj.runtime.profile.ref.RTResultSetWrapper

# Class sqlj.runtime.profile.ref.RTResultSetWrapper

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.RTResultSetWrapper

public class RTResultSetWrapper
extends Object
implements RTResultSet

This class is the superclass of all classes that augment the functionality of runtime result sets. These result sets sit on top of (wrap) an already existing result set (the underlying result set), but provide additional functionality.

The class RTResultSetWrapper itself overrides all methods of RTResultSet with versions that pass all requests to the underlying result set. Subclasses of RTResultSetWrapper may further override some of these methods as well as provide additional methods and fields.

## Variable Index

o rs
  The underlying result set.

## Constructor Index

o RTResultSetWrapper(RTResultSet)
  Creates a result set wrapper built on top of the specified result set.

## Method Index

o close()
  Makes a call to method `close` on the underlying result set.
o findColumn(String)
  Returns the result of calling method `findColumn` on the underlying result set.
o getAsciiStreamWrapper(int)
  Returns the result of calling method `getAsciiStreamWrapper` on the underlying result set.
o getBigDecimal(int)
  Returns the result of calling method `getBigDecimal` on the underlying result set.
o getBinaryStreamWrapper(int)
  Returns the result of calling method `getBinaryStreamWrapper` on the underlying result set.
o getBooleanNoNull(int)
  Returns the result of calling method `getBooleanNoNull` on the underlying result set.
o getBooleanWrapper(int)
  Returns the result of calling method `getBooleanWrapper` on the underlying result set.
o getByteNoNull(int)
  Returns the result of calling method `getByteNoNull` on the underlying result set.
o getBytes(int)
  Returns the result of calling method `getBytes` on the underlying result set.
o getByteWrapper(int)
  Returns the result of calling method `getByteWrapper` on the underlying result set.
o getColumnCount()
  Returns the result of calling method `getColumnCount` on the underlying result set.
o getCursorName()
  Returns the result of calling method `getCursorName` on the underlying result set.
o getDate(int)
  Returns the result of calling method `getDate` on the underlying result set.
o getDoubleNoNull(int)
  Returns the result of calling method `getDoubleNoNull` on the underlying result set.
o getDoubleWrapper(int)
  Returns the result of calling method `getDoubleWrapper` on the underlying result set.
o getFloatNoNull(int)
  Returns the result of calling method `getFloatNoNull` on the underlying result set.
o getFloatWrapper(int)
  Returns the result of calling method `getFloatWrapper` on the underlying result set.
o getIntNoNull(int)
  Returns the result of calling method `getIntNoNull` on the underlying result set.
o getIntWrapper(int)
  Returns the result of calling method `getIntWrapper` on the underlying result set.
o getJDBCResultSet()
  Returns the result of calling method `getJDBCResultSet` on the underlying result set.
o getLongNoNull(int)
  Returns the result of calling method `getLongNoNull` on the underlying result set.
o getLongWrapper(int)
  Returns the result of calling method `getLongWrapper` on the underlying result set.
o getObject(int, Class)
  Returns the result of calling method `getObject` on the underlying result set.
o getShortNoNull(int)
  Returns the result of calling method `getShortNoNull` on the underlying result set.
o getShortWrapper(int)
  Returns the result of calling method `getShortWrapper` on the underlying result set.
o getString(int)
  Returns the result of calling method `getString` on the underlying result set.
o getTime(int)
  Returns the result of calling method `getTime` on the underlying result set.
o getTimestamp(int)
  Returns the result of calling method `getTimestamp` on the underlying result set.
o getUnicodeStreamWrapper(int)
  Returns the result of calling method `getUnicodeStreamWrapper` on the underlying result set.
o getWrappedRTResultSet()
  Returns the underlying result set to which all method implementations are deferred.
o isClosed()
  Returns the result of calling method `isClosed` on the underlying result set.
o isValidRow()
  Returns the result of calling method `isValidRow` on the underlying result set.
o next()
  Returns the result of calling method `next` on the underlying result set.

## Variables

o rs

     protected RTResultSet rs

  The underlying result set.

## Constructors

o RTResultSetWrapper

     public RTResultSetWrapper(RTResultSet rs)

  Creates a result set wrapper built on top of the specified result set.

  Parameters:
    rs - the underlying result set.

## Methods

o getWrappedRTResultSet

     public RTResultSet getWrappedRTResultSet()

  Returns the underlying result set to which all method implementations are deferred.

o getJDBCResultSet

     public ResultSet getJDBCResultSet() throws SQLException

  Returns the result of calling method `getJDBCResultSet` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o next

     public boolean next() throws SQLException

  Returns the result of calling method `next` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getCursorName

     public String getCursorName() throws SQLException

  Returns the result of calling method `getCursorName` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o findColumn

     public int findColumn(String p0) throws SQLException

  Returns the result of calling method `findColumn` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getString

     public String getString(int p0) throws SQLException

  Returns the result of calling method `getString` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getBytes

     public byte[] getBytes(int p0) throws SQLException

  Returns the result of calling method `getBytes` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getDate

     public Date getDate(int p0) throws SQLException

  Returns the result of calling method `getDate` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getTime

     public Time getTime(int p0) throws SQLException

  Returns the result of calling method `getTime` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getTimestamp

     public Timestamp getTimestamp(int p0) throws SQLException

  Returns the result of calling method `getTimestamp` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getBooleanWrapper

     public Boolean getBooleanWrapper(int p0) throws SQLException

  Returns the result of calling method `getBooleanWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getByteWrapper

     public Byte getByteWrapper(int p0) throws SQLException

  Returns the result of calling method `getByteWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getShortWrapper

     public Short getShortWrapper(int p0) throws SQLException

  Returns the result of calling method `getShortWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getIntWrapper

     public Integer getIntWrapper(int p0) throws SQLException

  Returns the result of calling method `getIntWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getLongWrapper

     public Long getLongWrapper(int p0) throws SQLException

  Returns the result of calling method `getLongWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getFloatWrapper

     public Float getFloatWrapper(int p0) throws SQLException

  Returns the result of calling method `getFloatWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getDoubleWrapper

     public Double getDoubleWrapper(int p0) throws SQLException

  Returns the result of calling method `getDoubleWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getBooleanNoNull

     public boolean getBooleanNoNull(int p0) throws SQLException

  Returns the result of calling method `getBooleanNoNull` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getByteNoNull

     public byte getByteNoNull(int p0) throws SQLException

  Returns the result of calling method `getByteNoNull` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getShortNoNull

     public short getShortNoNull(int p0) throws SQLException

  Returns the result of calling method `getShortNoNull` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getIntNoNull

     public int getIntNoNull(int p0) throws SQLException

  Returns the result of calling method `getIntNoNull` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getLongNoNull

     public long getLongNoNull(int p0) throws SQLException

  Returns the result of calling method `getLongNoNull` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getFloatNoNull

     public float getFloatNoNull(int p0) throws SQLException

  Returns the result of calling method `getFloatNoNull` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getDoubleNoNull

     public double getDoubleNoNull(int p0) throws SQLException

  Returns the result of calling method `getDoubleNoNull` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getAsciiStreamWrapper

     public AsciiStream getAsciiStreamWrapper(int p0) throws SQLException

  Returns the result of calling method `getAsciiStreamWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getUnicodeStreamWrapper

     public UnicodeStream getUnicodeStreamWrapper(int p0) throws SQLException

  Returns the result of calling method `getUnicodeStreamWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getBinaryStreamWrapper

     public BinaryStream getBinaryStreamWrapper(int p0) throws SQLException

  Returns the result of calling method `getBinaryStreamWrapper` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getObject

     public Object getObject(int p0,
                             Class p1) throws SQLException

  Returns the result of calling method `getObject` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getBigDecimal

     public BigDecimal getBigDecimal(int p0) throws SQLException

  Returns the result of calling method `getBigDecimal` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o getColumnCount

     public int getColumnCount() throws SQLException

  Returns the result of calling method `getColumnCount` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o isValidRow

     public boolean isValidRow() throws SQLException

  Returns the result of calling method `isValidRow` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o isClosed

     public boolean isClosed() throws SQLException

  Returns the result of calling method `isClosed` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

o close

     public void close() throws SQLException

  Makes a call to method `close` on the underlying result set.

  Throws: SQLException
    if the call results in an exception

Class sqlj.runtime.profile.ref.RTStatementJDBCBase

# Class sqlj.runtime.profile.ref.RTStatementJDBCBase

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.RTStatementJDBCBase

public class RTStatementJDBCBase
extends Object

This class implements the portion of the RTStatement interface that pertains to PREPARED statements (no out-parameter support). It is implemented using a JDBC prepared statement.

## Variable Index

o preparedStmt
  The underlying JDBC prepared statement with which this class is implemented

## Constructor Index

o RTStatementJDBCBase(PreparedStatement)
  Creates a new statement base that uses the passed PreparedStatement to implement its methods.

## Method Index

o cancel()
  Calls the `cancel` method on the underlying prepared statement.
o clearWarnings()
  Calls the `clearWarnings` method on the underlying prepared statement.
o execute()
  Returns the result of calling the `execute` method on the underlying prepared statement.
o executeComplete()
  Called once the execution of this statement (and all the required gets) have been made.
o executeRTQuery()
  Returns the result of calling the `executeQuery` method on the underlying prepared statement.
o executeUpdate()
  Returns the result of calling the `executeUpdate` method on the underlying prepared statement.
o getJDBCPreparedStatement()
  Returns the underlying prepared statement with which this object was created.
o getMaxFieldSize()
  Returns the result of calling the `getMaxFieldSize` method on the underlying prepared statement.
o getMaxRows()
  Returns the result of calling the `getMaxRows` method on the underlying prepared statement.
o getMoreResults()
  Returns the result of calling the `getMoreResults` method on the underlying prepared statement.
o getQueryTimeout()
  Returns the result of calling the `getQueryTimeout` method on the underlying prepared statement.
o getResultSet()
  Returns the result of calling the `getResultSet` method on the underlying prepared statement.
o getUpdateCount()
  Returns the result of calling the `getUpdateCount` method on the underlying prepared statement.
o getWarnings()
  Returns the result of calling the `getWarnings` method on the underlying prepared statement.
o setAsciiStreamWrapper(int, AsciiStream)
  Calls the `setAsciiStream` method on the underlying statement, passing the InputStream and length of the passed stream parameter.
o setBigDecimal(int, BigDecimal)
  Calls the `setBigDecimal` method on the underlying prepared statement.
o setBinaryStreamWrapper(int, BinaryStream)
  Calls the `setBinaryStream` method on the underlying statement, passing the InputStream and length of the passed stream parameter.
o setBoolean(int, boolean)
  Calls the `setBoolean` method on the underlying prepared statement.
o setBooleanWrapper(int, Boolean)
  Converts the passed parameter to a primitive type and calls the `setBoolean` method on the underlying statement.
o setByte(int, byte)
  Calls the `setByte` method on the underlying prepared statement.
o setBytes(int, byte[])
  Calls the `setBytes` method on the underlying prepared statement.
o setByteWrapper(int, Byte)
  Converts the passed parameter to a primitive type and calls the `setByte` method on the underlying statement.
o setDate(int, Date)
  Calls the `setDate` method on the underlying prepared statement.
o setDouble(int, double)
  Calls the `setDouble` method on the underlying prepared statement.
o setDoubleWrapper(int, Double)
  Converts the passed parameter to a primitive type and calls the `setDouble` method on the underlying statement.
o setFloat(int, float)
  Calls the `setFloat` method on the underlying prepared statement.
o setFloatWrapper(int, Float)
  Converts the passed parameter to a primitive type and calls the `setFloat` method on the underlying statement.
o setInt(int, int)
  Calls the `setInt` method on the underlying prepared statement.
o setIntWrapper(int, Integer)
  Converts the passed parameter to a primitive type and calls the `setInt` method on the underlying statement.
o setLong(int, long)
  Calls the `setLong` method on the underlying prepared statement.
o setLongWrapper(int, Long)
  Converts the passed parameter to a primitive type and calls the `setLong` method on the underlying statement.
o setMaxFieldSize(int)
  Calls the `setMaxFieldSize` method on the underlying prepared statement.
o setMaxRows(int)
  Calls the `setMaxRows` method on the underlying prepared statement.
o setObject(int, Object)
  Calls the `setObject` method on the underlying prepared statement.
o setQueryTimeout(int)
  Calls the `setQueryTimeout` method on the underlying prepared statement.
o setShort(int, short)
  Calls the `setShort` method on the underlying prepared statement.
o setShortWrapper(int, Short)
  Converts the passed parameter to a primitive type and calls the `setShort` method on the underlying statement.
o setString(int, String)
  Calls the `setString` method on the underlying prepared statement.
o setTime(int, Time)
  Calls the `setTime` method on the underlying prepared statement.
o setTimestamp(int, Timestamp)
  Calls the `setTimestamp` method on the underlying prepared statement.
o setUnicodeStreamWrapper(int, UnicodeStream)
  Calls the `setUnicodeStream` method on the underlying statement, passing the InputStream and length of the passed stream parameter.

## Variables

o preparedStmt

     protected PreparedStatement preparedStmt

  The underlying JDBC prepared statement with which this class is implemented

## Constructors

o RTStatementJDBCBase

     public RTStatementJDBCBase(PreparedStatement preparedStmt)

  Creates a new statement base that uses the passed PreparedStatement to implement its methods.

  Parameters:
    preparedStmt - the underlying JDBC prepared statement

## Methods

o getJDBCPreparedStatement

     public PreparedStatement getJDBCPreparedStatement()

  Returns the underlying prepared statement with which this object was created. Note that unlike RTStatement, this method does not throw an exception since it always has a preparedStatement object.

o getMaxFieldSize

     public int getMaxFieldSize() throws SQLException

  Returns the result of calling the `getMaxFieldSize` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setMaxFieldSize

     public void setMaxFieldSize(int max) throws SQLException

  Calls the `setMaxFieldSize` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o getMaxRows

     public int getMaxRows() throws SQLException

  Returns the result of calling the `getMaxRows` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setMaxRows

     public void setMaxRows(int max) throws SQLException

  Calls the `setMaxRows` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o getQueryTimeout

     public int getQueryTimeout() throws SQLException

  Returns the result of calling the `getQueryTimeout` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setQueryTimeout

     public void setQueryTimeout(int seconds) throws SQLException

  Calls the `setQueryTimeout` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o cancel

     public void cancel() throws SQLException

  Calls the `cancel` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o getWarnings

     public SQLWarning getWarnings() throws SQLException

  Returns the result of calling the `getWarnings` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o clearWarnings

     public void clearWarnings() throws SQLException

  Calls the `clearWarnings` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o getResultSet

     public ResultSet getResultSet() throws SQLException

  Returns the result of calling the `getResultSet` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o getUpdateCount

     public int getUpdateCount() throws SQLException

  Returns the result of calling the `getUpdateCount` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o getMoreResults

     public boolean getMoreResults() throws SQLException

  Returns the result of calling the `getMoreResults` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o executeRTQuery

     public RTResultSet executeRTQuery() throws SQLException

  Returns the result of calling the `executeQuery` method on the underlying prepared statement. The result set is wrapped in an RTResultSetJDBC before being returned.

  Throws: SQLException
    is an error is raised by the wrapped statement
  See Also:
    RTResultSetJDBC

o executeUpdate

     public int executeUpdate() throws SQLException

  Returns the result of calling the `executeUpdate` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setBoolean

     public void setBoolean(int parameterIndex,
                            boolean x) throws SQLException

  Calls the `setBoolean` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setByte

     public void setByte(int parameterIndex,
                         byte x) throws SQLException

  Calls the `setByte` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setShort

     public void setShort(int parameterIndex,
                          short x) throws SQLException

  Calls the `setShort` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setInt

     public void setInt(int parameterIndex,
                        int x) throws SQLException

  Calls the `setInt` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setLong

     public void setLong(int parameterIndex,
                         long x) throws SQLException

  Calls the `setLong` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setFloat

     public void setFloat(int parameterIndex,
                          float x) throws SQLException

  Calls the `setFloat` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setDouble

     public void setDouble(int parameterIndex,
                           double x) throws SQLException

  Calls the `setDouble` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setBigDecimal

     public void setBigDecimal(int parameterIndex,
                               BigDecimal x) throws SQLException

  Calls the `setBigDecimal` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setString

     public void setString(int parameterIndex,
                           String x) throws SQLException

  Calls the `setString` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setBytes

     public void setBytes(int parameterIndex,
                          byte x[]) throws SQLException

  Calls the `setBytes` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setDate

     public void setDate(int parameterIndex,
                         Date x) throws SQLException

  Calls the `setDate` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setTime

     public void setTime(int parameterIndex,
                         Time x) throws SQLException

  Calls the `setTime` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setTimestamp

     public void setTimestamp(int parameterIndex,
                              Timestamp x) throws SQLException

  Calls the `setTimestamp` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o setObject

     public void setObject(int parameterIndex,
                           Object x) throws SQLException

  Calls the `setObject` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o execute

     public boolean execute() throws SQLException

  Returns the result of calling the `execute` method on the underlying prepared statement.

  Throws: SQLException
    is an error is raised by the wrapped statement

o executeComplete

     public void executeComplete() throws SQLException

  Called once the execution of this statement (and all the required gets) have been made. This is a gaurantee that no further calls will be made to this statement. Once executeComplete has been called, further calls to any other method and undefined and may result in a SQLException.

  If there are no open result sets on this statement, the underlying statement is closed. Otherwise, the close of the underlying statement will be delyaed until all open result sets on this statement have been closed.

  Throws: SQLException
    if an error occurs closing the underlying statement

o setBooleanWrapper

     public void setBooleanWrapper(int paramIndex,
                                   Boolean x) throws SQLException

  Converts the passed parameter to a primitive type and calls the `setBoolean` method on the underlying statement. If the passed parameter value is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed wrapper object.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setByteWrapper

     public void setByteWrapper(int paramIndex,
                                Byte x) throws SQLException

  Converts the passed parameter to a primitive type and calls the `setByte` method on the underlying statement. If the passed parameter value is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed wrapper object.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setShortWrapper

     public void setShortWrapper(int paramIndex,
                                 Short x) throws SQLException

  Converts the passed parameter to a primitive type and calls the `setShort` method on the underlying statement. If the passed parameter value is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed wrapper object.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setIntWrapper

     public void setIntWrapper(int paramIndex,
                               Integer x) throws SQLException

  Converts the passed parameter to a primitive type and calls the `setInt` method on the underlying statement. If the passed parameter value is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed wrapper object.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setLongWrapper

     public void setLongWrapper(int paramIndex,
                                Long x) throws SQLException

  Converts the passed parameter to a primitive type and calls the `setLong` method on the underlying statement. If the passed parameter value is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed wrapper object.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setFloatWrapper

     public void setFloatWrapper(int paramIndex,
                                 Float x) throws SQLException

  Converts the passed parameter to a primitive type and calls the `setFloat` method on the underlying statement. If the passed parameter value is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed wrapper object.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setDoubleWrapper

     public void setDoubleWrapper(int paramIndex,
                                  Double x) throws SQLException

  Converts the passed parameter to a primitive type and calls the `setDouble` method on the underlying statement. If the passed parameter value is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed wrapper object.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setAsciiStreamWrapper

     public void setAsciiStreamWrapper(int paramIndex,
                                       AsciiStream x) throws SQLException

  Calls the `setAsciiStream` method on the underlying statement, passing the InputStream and length of the passed stream parameter. If the passed stream is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed stream.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setBinaryStreamWrapper

     public void setBinaryStreamWrapper(int paramIndex,
                                        BinaryStream x) throws SQLException

  Calls the `setBinaryStream` method on the underlying statement, passing the InputStream and length of the passed stream parameter. If the passed stream is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed stream.

  Throws: SQLException
    if an error occurs in the underlying statement.

o setUnicodeStreamWrapper

     public void setUnicodeStreamWrapper(int paramIndex,
                                         UnicodeStream x) throws SQLException

  Calls the `setUnicodeStream` method on the underlying statement, passing the InputStream and length of the passed stream parameter. If the passed stream is null, calls `setNull` on the underlying statement using the default SQL type mapping for the passed stream.

  Throws: SQLException
    if an error occurs in the underlying statement.

Class sqlj.runtime.profile.ref.RTStatementJDBCCallable

# Class sqlj.runtime.profile.ref.RTStatementJDBCCallable

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.RTStatementJDBCBase
               |
               +----sqlj.runtime.profile.ref.RTStatementJDBCCallable

public class RTStatementJDBCCallable
extends RTStatementJDBCBase
implements RTStatement

This class implements the RTStatement interface using a JDBC callable statement. The superclass RTStatementJDBCBase handles all prepared statement related calls.

See Also:
  getStatementType

## Variable Index

o callableStmt
  The underlying JDBC callable statement with which this class is implemented

## Constructor Index

o RTStatementJDBCCallable(CallableStatement)
  Creates a new statement object that uses the passed CallableStatement to implement its methods.

## Method Index

o checkObjectClass(Object, Class)
  Verifies that the passed object can be assigned to an argument having the passed expected class type.
o getBigDecimal(int)
  Fetches a BigDecimal from the underlying statement using `getObject`.
o getBooleanNoNull(int)
  Fetches the result using the `getBoolean` method of the underlying statement.
o getBooleanWrapper(int)
  Fetches a primitive type using the `getBoolean` method of the underlying statement.
o getByteNoNull(int)
  Fetches the result using the `getByte` method of the underlying statement.
o getBytes(int)
  Returns the result of calling the `getBytes` method on the underlying callable statement.
o getByteWrapper(int)
  Fetches a primitive type using the `getByte` method of the underlying statement.
o getDate(int)
  Returns the result of calling the `getDate` method on the underlying callable statement.
o getDoubleNoNull(int)
  Fetches the result using the `getDouble` method of the underlying statement.
o getDoubleWrapper(int)
  Fetches a primitive type using the `getDouble` method of the underlying statement.
o getFloatNoNull(int)
  Fetches the result using the `getFloat` method of the underlying statement.
o getFloatWrapper(int)
  Fetches a primitive type using the `getFloat` method of the underlying statement.
o getIntNoNull(int)
  Fetches the result using the `getInt` method of the underlying statement.
o getIntWrapper(int)
  Fetches a primitive type using the `getInt` method of the underlying statement.
o getJDBCCallableStatement()
  Returns the underlying callable statement with which this object was created.
o getLongNoNull(int)
  Fetches the result using the `getLong` method of the underlying statement.
o getLongWrapper(int)
  Fetches a primitive type using the `getLong` method of the underlying statement.
o getObject(int, Class)
  Fetches the object from the underlying statement using `getObject`.
o getShortNoNull(int)
  Fetches the result using the `getShort` method of the underlying statement.
o getShortWrapper(int)
  Fetches a primitive type using the `getShort` method of the underlying statement.
o getString(int)
  Returns the result of calling the `getString` method on the underlying callable statement.
o getTime(int)
  Returns the result of calling the `getTime` method on the underlying callable statement.
o getTimestamp(int)
  Returns the result of calling the `getTimestamp` method on the underlying callable statement.
o registerOutParameter(int, int)
  Calls `registerOutParameter` on the underlying callable statement.
o registerOutParameters(EntryInfo)
  Registers the parameters on the underlying callable statement based on those described in the passed entry info object.

## Variables

o callableStmt

     protected CallableStatement callableStmt

  The underlying JDBC callable statement with which this class is implemented

## Constructors

o RTStatementJDBCCallable

     public RTStatementJDBCCallable(CallableStatement callableStmt)

  Creates a new statement object that uses the passed CallableStatement to implement its methods.

  Parameters:
    callableStmt - the underlying JDBC callable statement

## Methods

o getJDBCCallableStatement

     public CallableStatement getJDBCCallableStatement()

  Returns the underlying callable statement with which this object was created. Note that unlike RTStatement, this method does not throw an exception since it always has a callable statement object.

o registerOutParameters

     public void registerOutParameters(EntryInfo entryInfo) throws SQLException

  Registers the parameters on the underlying callable statement based on those described in the passed entry info object. For each OUT or INOUT parameter in the passed entry info object, `registerOutParameter` is called using the SQLType for that parameter.

  Parameters:
    entryInfo - the entry info object in which to find parameter information.
  Throws: SQLException
    if an error occurs during registration.
  See Also:
    getParamInfo, getMode, getSQLType

o registerOutParameter

     public void registerOutParameter(int paramIndex,
                                      int sqlType) throws SQLException

  Calls `registerOutParameter` on the underlying callable statement.

  Throws: SQLException
    if an error occurs during the call.

o getString

     public String getString(int parameterIndex) throws SQLException

  Returns the result of calling the `getString` method on the underlying callable statement.

  Throws: SQLException
    if an error is raised by the wrapped statement

o getBytes

     public byte[] getBytes(int parameterIndex) throws SQLException

  Returns the result of calling the `getBytes` method on the underlying callable statement.

  Throws: SQLException
    if an error is raised by the wrapped statement

o getDate

     public Date getDate(int parameterIndex) throws SQLException

  Returns the result of calling the `getDate` method on the underlying callable statement.

  Throws: SQLException
    if an error is raised by the wrapped statement

o getTime

     public Time getTime(int parameterIndex) throws SQLException

  Returns the result of calling the `getTime` method on the underlying callable statement.

  Throws: SQLException
    if an error is raised by the wrapped statement

o getTimestamp

     public Timestamp getTimestamp(int parameterIndex) throws SQLException

  Returns the result of calling the `getTimestamp` method on the underlying callable statement.

  Throws: SQLException
    if an error is raised by the wrapped statement

o getBooleanNoNull

     public boolean getBooleanNoNull(int parameterIndex) throws SQLException

  Fetches the result using the `getBoolean` method of the underlying statement. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the parameter is null
  Throws: SQLException
    if an error occurs in the underlying statement

o getByteNoNull

     public byte getByteNoNull(int parameterIndex) throws SQLException

  Fetches the result using the `getByte` method of the underlying statement. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the parameter is null
  Throws: SQLException
    if an error occurs in the underlying statement

o getShortNoNull

     public short getShortNoNull(int parameterIndex) throws SQLException

  Fetches the result using the `getShort` method of the underlying statement. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the parameter is null
  Throws: SQLException
    if an error occurs in the underlying statement

o getIntNoNull

     public int getIntNoNull(int parameterIndex) throws SQLException

  Fetches the result using the `getInt` method of the underlying statement. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the parameter is null
  Throws: SQLException
    if an error occurs in the underlying statement

o getLongNoNull

     public long getLongNoNull(int parameterIndex) throws SQLException

  Fetches the result using the `getLong` method of the underlying statement. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the parameter is null
  Throws: SQLException
    if an error occurs in the underlying statement

o getFloatNoNull

     public float getFloatNoNull(int parameterIndex) throws SQLException

  Fetches the result using the `getFloat` method of the underlying statement. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the parameter is null
  Throws: SQLException
    if an error occurs in the underlying statement

o getDoubleNoNull

     public double getDoubleNoNull(int parameterIndex) throws SQLException

  Fetches the result using the `getDouble` method of the underlying statement. If a subsequent call to `wasNull` returns true, a SQLNullException is raised. Otherwise the result is returned.

  Throws: SQLNullException
    if the parameter is null
  Throws: SQLException
    if an error occurs in the underlying statement

o getBooleanWrapper

     public Boolean getBooleanWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getBoolean` method of the underlying statement. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying statement

o getByteWrapper

     public Byte getByteWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getByte` method of the underlying statement. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying statement

o getShortWrapper

     public Short getShortWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getShort` method of the underlying statement. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying statement

o getIntWrapper

     public Integer getIntWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getInt` method of the underlying statement. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying statement

o getLongWrapper

     public Long getLongWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getLong` method of the underlying statement. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying statement

o getFloatWrapper

     public Float getFloatWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getFloat` method of the underlying statement. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying statement

o getDoubleWrapper

     public Double getDoubleWrapper(int columnIndex) throws SQLException

  Fetches a primitive type using the `getDouble` method of the underlying statement. If a subsequent call to `wasNull` returns true, null is returned. Otherwise the appropriate wrapper object is created and returned using the value of the fetched primitive type.

  Throws: SQLException
    if an error occurs in the underlying statement

o getObject

     public Object getObject(int columnIndex,
                             Class objectType) throws SQLException

  Fetches the object from the underlying statement using `getObject`. Verifies that the object fetched can be assigned to an argument having the passed class object type.

  Throws: SQLException
    if an error occurs in the underlying statement, or the object has an incompatible type
  See Also:
    checkObjectClass

o checkObjectClass

     public static void checkObjectClass(Object object,
                                         Class expectedType) throws SQLException

  Verifies that the passed object can be assigned to an argument having the passed expected class type. This is provided as a convenience for uniform error reporting in subclasses overriding the `getObject` method.

  If the passed object is null, no exception is raised.

  Parameters:
    object - the object to check
    expectedType - the class with which the object must be compatible
  Throws: SQLException
    if the object has an incompatible type

o getBigDecimal

     public BigDecimal getBigDecimal(int columnIndex) throws SQLException

  Fetches a BigDecimal from the underlying statement using `getObject`.

  Throws: SQLException
    if an error occurs in the underlying statement, or the object has an incompatible type

Class sqlj.runtime.profile.ref.RTStatementJDBCPrepared

# Class sqlj.runtime.profile.ref.RTStatementJDBCPrepared

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.RTStatementJDBCBase
               |
               +----sqlj.runtime.profile.ref.RTStatementJDBCPrepared

public class RTStatementJDBCPrepared
extends RTStatementJDBCBase
implements RTStatement

This class implements the RTStatement interface using a JDBC prepared statement. The superclass RTStatementJDBCBase handles all prepared statement related calls. The remaining callable statement "get" calls cannot be implemented using a JDBC prepared statement, so they all raise a runtime exception whenever called.

Note that in general, this object will only be used when the statement type in the profile indicates PREPARED. This means that the "get" methods should never be called, and therefore the runtime exceptions should never result.

See Also:
  getStatementType

## Constructor Index

o RTStatementJDBCPrepared(PreparedStatement)
  Creates a new statement object that uses the passed PreparedStatement to implement its methods.

## Method Index

o getBigDecimal(int)
  Results in an "unexcepted method call" exception.
o getBooleanNoNull(int)
  Results in an "unexcepted method call" exception.
o getBooleanWrapper(int)
  Results in an "unexcepted method call" exception.
o getByteNoNull(int)
  Results in an "unexcepted method call" exception.
o getBytes(int)
  Results in an "unexcepted method call" exception.
o getByteWrapper(int)
  Results in an "unexcepted method call" exception.
o getDate(int)
  Results in an "unexcepted method call" exception.
o getDoubleNoNull(int)
  Results in an "unexcepted method call" exception.
o getDoubleWrapper(int)
  Results in an "unexcepted method call" exception.
o getFloatNoNull(int)
  Results in an "unexcepted method call" exception.
o getFloatWrapper(int)
  Results in an "unexcepted method call" exception.
o getIntNoNull(int)
  Results in an "unexcepted method call" exception.
o getIntWrapper(int)
  Results in an "unexcepted method call" exception.
o getJDBCCallableStatement()
  Results in an exception.
o getLongNoNull(int)
  Results in an "unexcepted method call" exception.
o getLongWrapper(int)
  Results in an "unexcepted method call" exception.
o getObject(int, Class)
  Results in an "unexcepted method call" exception.
o getShortNoNull(int)
  Results in an "unexcepted method call" exception.
o getShortWrapper(int)
  Results in an "unexcepted method call" exception.
o getString(int)
  Results in an "unexcepted method call" exception.
o getTime(int)
  Results in an "unexcepted method call" exception.
o getTimestamp(int)
  Results in an "unexcepted method call" exception.

## Constructors

o RTStatementJDBCPrepared

     public RTStatementJDBCPrepared(PreparedStatement preparedStmt)

  Creates a new statement object that uses the passed PreparedStatement to implement its methods. Any "get" methods result in an exception.

  Parameters:
    preparedStmt - the underlying JDBC prepared statement

## Methods

o getJDBCCallableStatement

     public CallableStatement getJDBCCallableStatement() throws SQLException

  Results in an exception. There is no callable statement available for this object.

  Throws: SQLException
    anytime this method is called

o getString

     public String getString(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getBytes

     public byte[] getBytes(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getDate

     public Date getDate(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getTime

     public Time getTime(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getTimestamp

     public Timestamp getTimestamp(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getBooleanNoNull

     public boolean getBooleanNoNull(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getByteNoNull

     public byte getByteNoNull(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getShortNoNull

     public short getShortNoNull(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getIntNoNull

     public int getIntNoNull(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getLongNoNull

     public long getLongNoNull(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getFloatNoNull

     public float getFloatNoNull(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getDoubleNoNull

     public double getDoubleNoNull(int parameterIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getBooleanWrapper

     public Boolean getBooleanWrapper(int columnIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getByteWrapper

     public Byte getByteWrapper(int columnIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getShortWrapper

     public Short getShortWrapper(int columnIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getIntWrapper

     public Integer getIntWrapper(int columnIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getLongWrapper

     public Long getLongWrapper(int columnIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getFloatWrapper

     public Float getFloatWrapper(int columnIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getDoubleWrapper

     public Double getDoubleWrapper(int columnIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getObject

     public Object getObject(int columnIndex,
                             Class objectType) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

o getBigDecimal

     public BigDecimal getBigDecimal(int columnIndex) throws SQLException

  Results in an "unexcepted method call" exception.

  Throws: SQLException
    anytime this method is called

Class sqlj.runtime.profile.ref.RTStatementWrapper

# Class sqlj.runtime.profile.ref.RTStatementWrapper

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.RTStatementWrapper

public class RTStatementWrapper
extends Object
implements RTStatement

This class is the superclass of all classes that augment the functionality of runtime executable statements. These statements sit on top of (wrap) an already existing statement (the underlying statement), but provide additional functionality.

The class RTStatementWrapper itself overrides all methods of RTStatement with versions that pass all requests to the underlying statement. Subclasses of RTStatementWrapper may further override some of these methods as well as provide additional methods and fields.

## Variable Index

o stmt
  The underlying statement.

## Constructor Index

o RTStatementWrapper(RTStatement)
  Creates a statement wrapper built on top of the specified statement.

## Method Index

o cancel()
  Makes a call to method `cancel` on the underlying statement.
o clearWarnings()
  Makes a call to method `clearWarnings` on the underlying statement.
o execute()
  Returns the result of calling method `execute` on the underlying statement.
o executeComplete()
  Makes a call to method `executeComplete` on the underlying statement.
o executeRTQuery()
  Returns the result of calling method `executeRTQuery` on the underlying statement.
o executeUpdate()
  Returns the result of calling method `executeUpdate` on the underlying statement.
o getBigDecimal(int)
  Returns the result of calling method `getBigDecimal` on the underlying statement.
o getBooleanNoNull(int)
  Returns the result of calling method `getBooleanNoNull` on the underlying statement.
o getBooleanWrapper(int)
  Returns the result of calling method `getBooleanWrapper` on the underlying statement.
o getByteNoNull(int)
  Returns the result of calling method `getByteNoNull` on the underlying statement.
o getBytes(int)
  Returns the result of calling method `getBytes` on the underlying statement.
o getByteWrapper(int)
  Returns the result of calling method `getByteWrapper` on the underlying statement.
o getDate(int)
  Returns the result of calling method `getDate` on the underlying statement.
o getDoubleNoNull(int)
  Returns the result of calling method `getDoubleNoNull` on the underlying statement.
o getDoubleWrapper(int)
  Returns the result of calling method `getDoubleWrapper` on the underlying statement.
o getFloatNoNull(int)
  Returns the result of calling method `getFloatNoNull` on the underlying statement.
o getFloatWrapper(int)
  Returns the result of calling method `getFloatWrapper` on the underlying statement.
o getIntNoNull(int)
  Returns the result of calling method `getIntNoNull` on the underlying statement.
o getIntWrapper(int)
  Returns the result of calling method `getIntWrapper` on the underlying statement.
o getJDBCCallableStatement()
  Returns the result of calling method `getJDBCCallableStatement` on the underlying statement.
o getJDBCPreparedStatement()
  Returns the result of calling method `getJDBCPreparedStatement` on the underlying statement.
o getLongNoNull(int)
  Returns the result of calling method `getLongNoNull` on the underlying statement.
o getLongWrapper(int)
  Returns the result of calling method `getLongWrapper` on the underlying statement.
o getMaxFieldSize()
  Returns the result of calling method `getMaxFieldSize` on the underlying statement.
o getMaxRows()
  Returns the result of calling method `getMaxRows` on the underlying statement.
o getMoreResults()
  Returns the result of calling method `getMoreResults` on the underlying statement.
o getObject(int, Class)
  Returns the result of calling method `getObject` on the underlying statement.
o getQueryTimeout()
  Returns the result of calling method `getQueryTimeout` on the underlying statement.
o getResultSet()
  Returns the result of calling method `getResultSet` on the underlying statement.
o getShortNoNull(int)
  Returns the result of calling method `getShortNoNull` on the underlying statement.
o getShortWrapper(int)
  Returns the result of calling method `getShortWrapper` on the underlying statement.
o getString(int)
  Returns the result of calling method `getString` on the underlying statement.
o getTime(int)
  Returns the result of calling method `getTime` on the underlying statement.
o getTimestamp(int)
  Returns the result of calling method `getTimestamp` on the underlying statement.
o getUpdateCount()
  Returns the result of calling method `getUpdateCount` on the underlying statement.
o getWarnings()
  Returns the result of calling method `getWarnings` on the underlying statement.
o getWrappedRTStatement()
  Returns the underlying statement to which all method implementations are deferred.
o setAsciiStreamWrapper(int, AsciiStream)
  Makes a call to method `setAsciiStreamWrapper` on the underlying statement.
o setBigDecimal(int, BigDecimal)
  Makes a call to method `setBigDecimal` on the underlying statement.
o setBinaryStreamWrapper(int, BinaryStream)
  Makes a call to method `setBinaryStreamWrapper` on the underlying statement.
o setBoolean(int, boolean)
  Makes a call to method `setBoolean` on the underlying statement.
o setBooleanWrapper(int, Boolean)
  Makes a call to method `setBooleanWrapper` on the underlying statement.
o setByte(int, byte)
  Makes a call to method `setByte` on the underlying statement.
o setBytes(int, byte[])
  Makes a call to method `setBytes` on the underlying statement.
o setByteWrapper(int, Byte)
  Makes a call to method `setByteWrapper` on the underlying statement.
o setDate(int, Date)
  Makes a call to method `setDate` on the underlying statement.
o setDouble(int, double)
  Makes a call to method `setDouble` on the underlying statement.
o setDoubleWrapper(int, Double)
  Makes a call to method `setDoubleWrapper` on the underlying statement.
o setFloat(int, float)
  Makes a call to method `setFloat` on the underlying statement.
o setFloatWrapper(int, Float)
  Makes a call to method `setFloatWrapper` on the underlying statement.
o setInt(int, int)
  Makes a call to method `setInt` on the underlying statement.
o setIntWrapper(int, Integer)
  Makes a call to method `setIntWrapper` on the underlying statement.
o setLong(int, long)
  Makes a call to method `setLong` on the underlying statement.
o setLongWrapper(int, Long)
  Makes a call to method `setLongWrapper` on the underlying statement.
o setMaxFieldSize(int)
  Makes a call to method `setMaxFieldSize` on the underlying statement.
o setMaxRows(int)
  Makes a call to method `setMaxRows` on the underlying statement.
o setObject(int, Object)
  Makes a call to method `setObject` on the underlying statement.
o setQueryTimeout(int)
  Makes a call to method `setQueryTimeout` on the underlying statement.
o setShort(int, short)
  Makes a call to method `setShort` on the underlying statement.
o setShortWrapper(int, Short)
  Makes a call to method `setShortWrapper` on the underlying statement.
o setString(int, String)
  Makes a call to method `setString` on the underlying statement.
o setTime(int, Time)
  Makes a call to method `setTime` on the underlying statement.
o setTimestamp(int, Timestamp)
  Makes a call to method `setTimestamp` on the underlying statement.
o setUnicodeStreamWrapper(int, UnicodeStream)
  Makes a call to method `setUnicodeStreamWrapper` on the underlying statement.

## Variables

o stmt

     protected RTStatement stmt

  The underlying statement.

## Constructors

o RTStatementWrapper

     public RTStatementWrapper(RTStatement stmt)

  Creates a statement wrapper built on top of the specified statement.

  Parameters:
    stmt - the underlying statement.

## Methods

o getWrappedRTStatement

     public RTStatement getWrappedRTStatement()

  Returns the underlying statement to which all method implementations are deferred.

o getJDBCPreparedStatement

     public PreparedStatement getJDBCPreparedStatement() throws SQLException

  Returns the result of calling method `getJDBCPreparedStatement` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getJDBCCallableStatement

     public CallableStatement getJDBCCallableStatement() throws SQLException

  Returns the result of calling method `getJDBCCallableStatement` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getMaxFieldSize

     public int getMaxFieldSize() throws SQLException

  Returns the result of calling method `getMaxFieldSize` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setMaxFieldSize

     public void setMaxFieldSize(int p0) throws SQLException

  Makes a call to method `setMaxFieldSize` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getMaxRows

     public int getMaxRows() throws SQLException

  Returns the result of calling method `getMaxRows` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setMaxRows

     public void setMaxRows(int p0) throws SQLException

  Makes a call to method `setMaxRows` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getQueryTimeout

     public int getQueryTimeout() throws SQLException

  Returns the result of calling method `getQueryTimeout` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setQueryTimeout

     public void setQueryTimeout(int p0) throws SQLException

  Makes a call to method `setQueryTimeout` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o cancel

     public void cancel() throws SQLException

  Makes a call to method `cancel` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getWarnings

     public SQLWarning getWarnings() throws SQLException

  Returns the result of calling method `getWarnings` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o clearWarnings

     public void clearWarnings() throws SQLException

  Makes a call to method `clearWarnings` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getResultSet

     public ResultSet getResultSet() throws SQLException

  Returns the result of calling method `getResultSet` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getUpdateCount

     public int getUpdateCount() throws SQLException

  Returns the result of calling method `getUpdateCount` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getMoreResults

     public boolean getMoreResults() throws SQLException

  Returns the result of calling method `getMoreResults` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o executeRTQuery

     public RTResultSet executeRTQuery() throws SQLException

  Returns the result of calling method `executeRTQuery` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o executeUpdate

     public int executeUpdate() throws SQLException

  Returns the result of calling method `executeUpdate` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setBoolean

     public void setBoolean(int p0,
                            boolean p1) throws SQLException

  Makes a call to method `setBoolean` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setByte

     public void setByte(int p0,
                         byte p1) throws SQLException

  Makes a call to method `setByte` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setShort

     public void setShort(int p0,
                          short p1) throws SQLException

  Makes a call to method `setShort` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setInt

     public void setInt(int p0,
                        int p1) throws SQLException

  Makes a call to method `setInt` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setLong

     public void setLong(int p0,
                         long p1) throws SQLException

  Makes a call to method `setLong` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setFloat

     public void setFloat(int p0,
                          float p1) throws SQLException

  Makes a call to method `setFloat` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setDouble

     public void setDouble(int p0,
                           double p1) throws SQLException

  Makes a call to method `setDouble` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setBooleanWrapper

     public void setBooleanWrapper(int p0,
                                   Boolean p1) throws SQLException

  Makes a call to method `setBooleanWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setByteWrapper

     public void setByteWrapper(int p0,
                                Byte p1) throws SQLException

  Makes a call to method `setByteWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setShortWrapper

     public void setShortWrapper(int p0,
                                 Short p1) throws SQLException

  Makes a call to method `setShortWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setIntWrapper

     public void setIntWrapper(int p0,
                               Integer p1) throws SQLException

  Makes a call to method `setIntWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setLongWrapper

     public void setLongWrapper(int p0,
                                Long p1) throws SQLException

  Makes a call to method `setLongWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setFloatWrapper

     public void setFloatWrapper(int p0,
                                 Float p1) throws SQLException

  Makes a call to method `setFloatWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setDoubleWrapper

     public void setDoubleWrapper(int p0,
                                  Double p1) throws SQLException

  Makes a call to method `setDoubleWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setBigDecimal

     public void setBigDecimal(int p0,
                               BigDecimal p1) throws SQLException

  Makes a call to method `setBigDecimal` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setString

     public void setString(int p0,
                           String p1) throws SQLException

  Makes a call to method `setString` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setBytes

     public void setBytes(int p0,
                          byte p1[]) throws SQLException

  Makes a call to method `setBytes` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setDate

     public void setDate(int p0,
                         Date p1) throws SQLException

  Makes a call to method `setDate` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setTime

     public void setTime(int p0,
                         Time p1) throws SQLException

  Makes a call to method `setTime` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setTimestamp

     public void setTimestamp(int p0,
                              Timestamp p1) throws SQLException

  Makes a call to method `setTimestamp` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setAsciiStreamWrapper

     public void setAsciiStreamWrapper(int p0,
                                       AsciiStream p1) throws SQLException

  Makes a call to method `setAsciiStreamWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setBinaryStreamWrapper

     public void setBinaryStreamWrapper(int p0,
                                        BinaryStream p1) throws SQLException

  Makes a call to method `setBinaryStreamWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setUnicodeStreamWrapper

     public void setUnicodeStreamWrapper(int p0,
                                         UnicodeStream p1) throws SQLException

  Makes a call to method `setUnicodeStreamWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o setObject

     public void setObject(int p0,
                           Object p1) throws SQLException

  Makes a call to method `setObject` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o execute

     public boolean execute() throws SQLException

  Returns the result of calling method `execute` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getString

     public String getString(int p0) throws SQLException

  Returns the result of calling method `getString` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getBytes

     public byte[] getBytes(int p0) throws SQLException

  Returns the result of calling method `getBytes` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getDate

     public Date getDate(int p0) throws SQLException

  Returns the result of calling method `getDate` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getTime

     public Time getTime(int p0) throws SQLException

  Returns the result of calling method `getTime` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getTimestamp

     public Timestamp getTimestamp(int p0) throws SQLException

  Returns the result of calling method `getTimestamp` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getBooleanNoNull

     public boolean getBooleanNoNull(int p0) throws SQLException

  Returns the result of calling method `getBooleanNoNull` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getByteNoNull

     public byte getByteNoNull(int p0) throws SQLException

  Returns the result of calling method `getByteNoNull` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getShortNoNull

     public short getShortNoNull(int p0) throws SQLException

  Returns the result of calling method `getShortNoNull` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getIntNoNull

     public int getIntNoNull(int p0) throws SQLException

  Returns the result of calling method `getIntNoNull` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getLongNoNull

     public long getLongNoNull(int p0) throws SQLException

  Returns the result of calling method `getLongNoNull` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getFloatNoNull

     public float getFloatNoNull(int p0) throws SQLException

  Returns the result of calling method `getFloatNoNull` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getDoubleNoNull

     public double getDoubleNoNull(int p0) throws SQLException

  Returns the result of calling method `getDoubleNoNull` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getBooleanWrapper

     public Boolean getBooleanWrapper(int p0) throws SQLException

  Returns the result of calling method `getBooleanWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getByteWrapper

     public Byte getByteWrapper(int p0) throws SQLException

  Returns the result of calling method `getByteWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getShortWrapper

     public Short getShortWrapper(int p0) throws SQLException

  Returns the result of calling method `getShortWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getIntWrapper

     public Integer getIntWrapper(int p0) throws SQLException

  Returns the result of calling method `getIntWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getLongWrapper

     public Long getLongWrapper(int p0) throws SQLException

  Returns the result of calling method `getLongWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getFloatWrapper

     public Float getFloatWrapper(int p0) throws SQLException

  Returns the result of calling method `getFloatWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getDoubleWrapper

     public Double getDoubleWrapper(int p0) throws SQLException

  Returns the result of calling method `getDoubleWrapper` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getObject

     public Object getObject(int p0,
                             Class p1) throws SQLException

  Returns the result of calling method `getObject` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o getBigDecimal

     public BigDecimal getBigDecimal(int p0) throws SQLException

  Returns the result of calling method `getBigDecimal` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

o executeComplete

     public void executeComplete() throws SQLException

  Makes a call to method `executeComplete` on the underlying statement.

  Throws: SQLException
    if the call results in an exception

Class sqlj.runtime.profile.ref.TransactionControlProfile

# Class sqlj.runtime.profile.ref.TransactionControlProfile

    java.lang.Object
       |
       +----sqlj.runtime.profile.ref.ProfileWrapper
               |
               +----sqlj.runtime.profile.ref.TransactionControlProfile

public class TransactionControlProfile
extends ProfileWrapper

An TransactionControlProfile is a connected profile wrapper which augments the functionality of the statement creation methods by intercepting any entries flagged as COMMIT, ROLLBACK, and SET_TRANSACTION, and handling the execute of such an entry by calling the appropriate method on the underlying connection object.

## Constructor Index

o TransactionControlProfile(ConnectedProfile)
  Creates a new transaction control profile that augments the functionality of the passed connected profile.
o TransactionControlProfile(ConnectedProfile, boolean, boolean, boolean)
  Creates a new transaction control profile that augments the functionality of the passed connected profile.

## Method Index

o getStatement(int)
  Returns an executable statement object representing the statement at index "ndx" in the profile, where "ndx" is 0 based.

## Constructors

o TransactionControlProfile

     public TransactionControlProfile(ConnectedProfile profile)

  Creates a new transaction control profile that augments the functionality of the passed connected profile. All statement types are intercepted.

  Parameters:
    profile - the connected profile to wrap

o TransactionControlProfile

     public TransactionControlProfile(ConnectedProfile profile,
                                      boolean handleCommit,
                                      boolean handleRollback,
                                      boolean handleSetTransaction)

  Creates a new transaction control profile that augments the functionality of the passed connected profile.

  Parameters:
    profile - the connected profile to wrap
    handleCommit - true if COMMIT should be intercepted, false otherwise.
    handleRollback - true if ROLLBACK should be intercepted, false otherwise.
    handleSetTransaction - true if SET_TRANSACTION statements should be intercepted, false otherwise.

## Methods

o getStatement

     public RTStatement getStatement(int ndx) throws SQLException

  Returns an executable statement object representing the statement at index "ndx" in the profile, where "ndx" is 0 based. If the role of the entry at the given index is not COMMIT, ROLLBACK, or SET_TRANSACTION, the statement is created using the `getStatement` method of the underlying connected profile.

  If the role is COMMIT, the object returned is a statement that, when executed, calls the `commit` method on the connection with which this connected profile was created.

  If the role is ROLLBACK, the object returned is a statement that, when executed, calls the `rollback` method on the connection with which this connected profile was created.

  If the role is SET_TRANSACTION, the object returned is a statement that, when executed, calls the `setTransactionIsolation` and `setReadOnly` methods on the connection with which this connected profile was created, passing values as described in the SetTransactionDescriptor value of the entry.

  It is assumed that COMMIT, ROLLBACK, and SET_TRANSACTION are always handled with PREPARED statements via the executeUpdate method. Moreover, it is assumed that such statements never recieve any input parameters. If the entry info describes otherwise, this method will raise an exception.

  Parameters:
    the - index of the statement to return, 0 based.
  Throws: SQLException
    if an error occurs preparing the statement.
  Overrides:
    getStatement in class ProfileWrapper
  See Also:
    getRole, COMMIT, ROLLBACK, SET_TRANSACTION, getStatementType, getExecuteType, getDescriptor, getTransactionDescriptor

Class sqlj.runtime.profile.ref.TypeInfoImpl

# Class sqlj.runtime.profile.ref.TypeInfoImpl

    java.lang.Object
       |
       +----sqlj.runtime.profile.TypeInfo
               |
               +----sqlj.runtime.profile.ref.TypeInfoImpl

public class TypeInfoImpl
extends TypeInfo

The TypeInfoImpl class provides a concreate implementation of the TypeInfo class. Type info objects describe the type of a parameter passed to a sql operation or column of a ResultSet produced by a sql operation. The type consists of the java type of the actual Java expression which appears in the original source file, its corrsponding JDBC sql type, the name of the variable or column producing the type (if available), its modality, and the index at which the parameter marker appears in the original SQL string.

See Also:
  getJavaType

## Constructor Index

o TypeInfoImpl(String, int, String)
  Creates a new type info instance having the given java class name, sql type, and name.
o TypeInfoImpl(String, int, String, int, int)
  Creates a new type info instance having the given java class name, sql type, name, mode, and marker index.

## Method Index

o getJavaTypeName()
  Returns the name of the Java Class representation of the type.
o getMarkerIndex()
  Returns the 0-based index of the '?' marker for this parameter in the sql string.
o getMode()
  Returns the modality of this parameter.
o getName()
  Returns the name of the variable or column producing this type.
o getSQLType()
  Returns the default mapping of this type as a SQL type, as defined in java.sql.Types.

## Constructors

o TypeInfoImpl

     public TypeInfoImpl(String javaClassName,
                         int sqlType,
                         String name,
                         int mode,
                         int markerIndex)

  Creates a new type info instance having the given java class name, sql type, name, mode, and marker index. The java class name is a fully qualified java class name as described in the `getJavaClassName` method. An exception is thrown if the parameters passed would cause an invalid type info object to be created.

  Parameters:
    javaClassName - the fully qualified name of the java class represented by this type
    sqlType - the sql type encoding of this type
    name - the name of the variable or column describeded by this type
    mode - the modality of the type
    markerIndex - the 0-based index of the marker in the SQL string corresponding to this parameter (-1 if not a parameter).
  Throws: IllegalArgumentException
    if the type created is invalid

o TypeInfoImpl

     public TypeInfoImpl(String javaClassName,
                         int sqlType,
                         String name)

  Creates a new type info instance having the given java class name, sql type, and name. The java class name is a fully qualified java class name as described in the `getJavaClassName` method. An exception is thrown if the parameters passed would cause an invalid type info object to be created.

  This constructor defaults the mode of the type created to OUT, and the marker index to -1. It is most often used for result types.

  Parameters:
    javaClassName - the fully qualified name of the java class represented by this type
    sqlType - the sql type encoding of this type
    name - the name of the variable or column describeded by this type
  Throws: IllegalArgumentException
    if the type created is invalid

## Methods

o getJavaTypeName

     public String getJavaTypeName()

  Returns the name of the Java Class representation of the type. Each type appears in the original source file as a Java expression (variable) or cursor column whose type can be determined at compile time.

  Returns:
    the name of the Java Class representation of the type.
  Overrides:
    getJavaTypeName in class TypeInfo
  See Also:
    getJavaType, getJavaTypeName

o getSQLType

     public int getSQLType()

  Returns the default mapping of this type as a SQL type, as defined in java.sql.Types.

  Returns:
    the default mapping of this type as a SQL type.
  Overrides:
    getSQLType in class TypeInfo
  See Also:
    getSQLType

o getName

     public String getName()

  Returns the name of the variable or column producing this type.

  Returns:
    the name of the variable or column producing this type.
  Overrides:
    getName in class TypeInfo
  See Also:
    getName

o getMode

     public int getMode()

  Returns the modality of this parameter.

  Overrides:
    getMode in class TypeInfo
  See Also:
    getMode

o getMarkerIndex

     public int getMarkerIndex()

  Returns the 0-based index of the '?' marker for this parameter in the sql string. Returns -1 if this object does not represent a parameter.

  Overrides:
    getMarkerIndex in class TypeInfo
  See Also:
    getSQLString