org.apache.derby.catalog
Class GetProcedureColumns

java.lang.Object
  org.apache.derby.vti.VTITemplateBase
      org.apache.derby.vti.VTITemplate
          org.apache.derby.catalog.GetProcedureColumns

All Implemented Interfaces:

java.sql.ResultSet, java.sql.Wrapper

public class GetProcedureColumns
extends VTITemplate

Use of VirtualTableInterface to provide support for DatabaseMetaData.getProcedureColumns().

This class is called from a Query constructed in java/org.apache.derby.impl.jdbc/metadata.properties:

    
The VTI will return columns 3-14, an extra column to the specification
    METHOD_ID is returned to distinguish between overloaded methods.

  

        
PROCEDURE_CAT String => procedure catalog (may be null)
        
PROCEDURE_SCHEM String => procedure schema (may be null)
        
PROCEDURE_NAME String => procedure name
        
COLUMN_NAME String => column/parameter name 
        
COLUMN_TYPE Short => kind of column/parameter:
      

      
 procedureColumnUnknown - nobody knows
      
 procedureColumnIn - IN parameter
      
 procedureColumnInOut - INOUT parameter
      
 procedureColumnOut - OUT parameter
      
 procedureColumnReturn - procedure return value
      
 procedureColumnResult - result column in ResultSet
      
  
DATA_TYPE int => SQL type from java.sql.Types
        
TYPE_NAME String => SQL type name, for a UDT type the
  type name is fully qualified
        
PRECISION int => precision
        
LENGTH int => length in bytes of data
        
SCALE short => scale
        
RADIX short => radix
        
NULLABLE short => can it contain NULL?
      

      
 procedureNoNulls - does not allow NULL values
      
 procedureNullable - allows NULL values
      
 procedureNullableUnknown - nullability unknown
      
        
REMARKS String => comment describing parameter/column
        
METHOD_ID Short => Derby extra column (overloading)
        
PARAMETER_ID Short => Derby extra column (output order)
  









Field Summary




private static ResultColumnDescriptor[]
columnInfo



           



private  java.lang.String
columnName



           



private  short
columnType



           



private  boolean
isFunction



           



private  boolean
isProcedure



           



private static java.sql.ResultSetMetaData
metadata



           



private  short
method_count



           



private  short
nullable



           



private  short
param_number



           



private  int
paramCursor



           



private  RoutineAliasInfo
procedure



           



private  int
returnedTableColumnCount



           



private  int
rowCount



           



private  TypeDescriptor
sqlType



           



private  TypeDescriptor
tableFunctionReturnType



           


 
Fields inherited from interface java.sql.ResultSet
CLOSE_CURSORS_AT_COMMIT, CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, HOLD_CURSORS_OVER_COMMIT, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE
 



Constructor Summary
GetProcedureColumns(AliasInfo aliasInfo,
                    java.lang.String aliasType)



           
 



Method Summary




 void
close()



           



 int
getInt(int column)



           



 java.sql.ResultSetMetaData
getMetaData()



           



 short
getShort(int column)



           



 java.lang.String
getString(int column)



           



 boolean
next()



           



private  int
translate(int val)



           


 
Methods inherited from class org.apache.derby.vti.VTITemplate
getBigDecimal, getBigDecimal, getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLong, getObject, getShort, getString, getTime, getTimestamp
 
Methods inherited from class org.apache.derby.vti.VTITemplateBase
absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getByte, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, getDate, getDate, getDouble, getFetchDirection, getFetchSize, getFloat, getLong, getObject, getObject, getObject, getRef, getRef, getRow, getStatement, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertRow, isAfterLast, isBeforeFirst, isFirst, isLast, last, moveToCurrentRow, moveToInsertRow, notImplemented, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, updateArray, updateArray, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateRef, updateRef, updateRow, updateShort, updateShort, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNull
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.sql.ResultSet
getHoldability, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getRowId, getRowId, getSQLXML, getSQLXML, isClosed, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBlob, updateBlob, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateClob, updateClob, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNString, updateNString, updateRowId, updateRowId, updateSQLXML, updateSQLXML
 
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
 





Field Detail



isProcedure
private boolean isProcedure







isFunction
private boolean isFunction







rowCount
private int rowCount







returnedTableColumnCount
private int returnedTableColumnCount







tableFunctionReturnType
private TypeDescriptor tableFunctionReturnType







procedure
private RoutineAliasInfo procedure







paramCursor
private int paramCursor







method_count
private short method_count







param_number
private short param_number







sqlType
private TypeDescriptor sqlType







columnName
private java.lang.String columnName







columnType
private short columnType







nullable
private final short nullable







columnInfo
private static final ResultColumnDescriptor[] columnInfo







metadata
private static final java.sql.ResultSetMetaData metadata








Constructor Detail



GetProcedureColumns
public GetProcedureColumns(AliasInfo aliasInfo,
                           java.lang.String aliasType)
                    throws java.sql.SQLException



Throws:
java.sql.SQLException





Method Detail



translate
private int translate(int val)








getMetaData
public java.sql.ResultSetMetaData getMetaData()


Specified by:
getMetaData in interface java.sql.ResultSet
Overrides:
getMetaData in class VTITemplateBase








next
public boolean next()
             throws java.sql.SQLException


Specified by:
next in interface java.sql.ResultSet
Specified by:
next in class VTITemplate



Throws:
java.sql.SQLException





getString
public java.lang.String getString(int column)
                           throws java.sql.SQLException


Specified by:
getString in interface java.sql.ResultSet
Overrides:
getString in class VTITemplateBase



Throws:
java.sql.SQLException





getInt
public int getInt(int column)
           throws java.sql.SQLException


Specified by:
getInt in interface java.sql.ResultSet
Overrides:
getInt in class VTITemplateBase



Throws:
java.sql.SQLException





getShort
public short getShort(int column)
               throws java.sql.SQLException


Specified by:
getShort in interface java.sql.ResultSet
Overrides:
getShort in class VTITemplateBase



Throws:
java.sql.SQLException





close
public void close()


Specified by:
close in interface java.sql.ResultSet
Specified by:
close in class VTITemplate