All Packages    This Package  Previous  Next  

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

All Packages    This Package  Previous  Next