org.apache.derby.vti
Class VTITemplate

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

All Implemented Interfaces:

java.sql.ResultSet, java.sql.Wrapper

Direct Known Subclasses:

ContainedRoles, ErrorLogReader, ErrorMessages, ForeignTableVTI, GetProcedureColumns, ImportAbstract, LockTable, SpaceTable, StatementCache, StatementDuration, StringColumnVTI, TransactionTable

public abstract class VTITemplate
extends VTITemplateBase

An abstract implementation of ResultSet that is useful when writing table functions, read-only VTIs (virtual table interface), and the ResultSets returned by executeQuery in read-write VTI classes. This class implements most of the methods of the JDBC 3.0 interface java.sql.ResultSet, each one throwing a SQLException with the name of the method. A concrete subclass can then just implement the methods not implemented here and override any methods it needs to implement for correct functionality.

The methods not implemented here are

• next()
• close()
• getMetaData()

For table functions and virtual tables, the database engine only calls methods defined in the JDBC 2.0 definition of java.sql.ResultSet.
Classes that implement a JDBC 2.0 conformant java.sql.ResultSet can be used as table functions and virtual tables.

Field Summary

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

VTITemplate()

Method Summary

abstract void	close()
java.math.BigDecimal	getBigDecimal(java.lang.String columnName)
java.math.BigDecimal	getBigDecimal(java.lang.String columnName, int scale)
boolean	getBoolean(java.lang.String columnName)
byte	getByte(java.lang.String columnName)
byte[]	getBytes(java.lang.String columnName)
java.sql.Date	getDate(java.lang.String columnName)
double	getDouble(java.lang.String columnName)
float	getFloat(java.lang.String columnName)
int	getInt(java.lang.String columnName)
long	getLong(java.lang.String columnName)
java.lang.Object	getObject(java.lang.String columnName)
short	getShort(java.lang.String columnName)
java.lang.String	getString(java.lang.String columnName)
java.sql.Time	getTime(java.lang.String columnName)
java.sql.Timestamp	getTimestamp(java.lang.String columnName)
abstract boolean	next()

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, getInt, getLong, getMetaData, getObject, getObject, getObject, getRef, getRef, getRow, getShort, getStatement, getString, 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

Constructor Detail

VTITemplate

public VTITemplate()

Method Detail

next

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

Specified by:

next in interface java.sql.ResultSet

Overrides:

next in class VTITemplateBase

Throws:

java.sql.SQLException

close

public abstract void close()
                    throws java.sql.SQLException

Specified by:

close in interface java.sql.ResultSet

Overrides:

close in class VTITemplateBase

Throws:

java.sql.SQLException

getString

public java.lang.String getString(java.lang.String columnName)
                           throws java.sql.SQLException

Specified by:

getString in interface java.sql.ResultSet

Overrides:

getString in class VTITemplateBase

Throws:

java.sql.SQLException

getBoolean

public boolean getBoolean(java.lang.String columnName)
                   throws java.sql.SQLException

Specified by:

getBoolean in interface java.sql.ResultSet

Overrides:

getBoolean in class VTITemplateBase

Throws:

java.sql.SQLException

getByte

public byte getByte(java.lang.String columnName)
             throws java.sql.SQLException

Specified by:

getByte in interface java.sql.ResultSet

Overrides:

getByte in class VTITemplateBase

Throws:

java.sql.SQLException

getShort

public short getShort(java.lang.String columnName)
               throws java.sql.SQLException

Specified by:

getShort in interface java.sql.ResultSet

Overrides:

getShort in class VTITemplateBase

Throws:

java.sql.SQLException

getInt

public int getInt(java.lang.String columnName)
           throws java.sql.SQLException

Specified by:

getInt in interface java.sql.ResultSet

Overrides:

getInt in class VTITemplateBase

Throws:

java.sql.SQLException

getLong

public long getLong(java.lang.String columnName)
             throws java.sql.SQLException

Specified by:

getLong in interface java.sql.ResultSet

Overrides:

getLong in class VTITemplateBase

Throws:

java.sql.SQLException

getFloat

public float getFloat(java.lang.String columnName)
               throws java.sql.SQLException

Specified by:

getFloat in interface java.sql.ResultSet

Overrides:

getFloat in class VTITemplateBase

Throws:

java.sql.SQLException

getDouble

public double getDouble(java.lang.String columnName)
                 throws java.sql.SQLException

Specified by:

getDouble in interface java.sql.ResultSet

Overrides:

getDouble in class VTITemplateBase

Throws:

java.sql.SQLException

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String columnName,
                                          int scale)
                                   throws java.sql.SQLException

Specified by:

getBigDecimal in interface java.sql.ResultSet

Overrides:

getBigDecimal in class VTITemplateBase

Throws:

java.sql.SQLException

getBytes

public byte[] getBytes(java.lang.String columnName)
                throws java.sql.SQLException

Specified by:

getBytes in interface java.sql.ResultSet

Overrides:

getBytes in class VTITemplateBase

Throws:

java.sql.SQLException

getDate

public java.sql.Date getDate(java.lang.String columnName)
                      throws java.sql.SQLException

Specified by:

getDate in interface java.sql.ResultSet

Overrides:

getDate in class VTITemplateBase

Throws:

java.sql.SQLException

getTime

public java.sql.Time getTime(java.lang.String columnName)
                      throws java.sql.SQLException

Specified by:

getTime in interface java.sql.ResultSet

Overrides:

getTime in class VTITemplateBase

Throws:

java.sql.SQLException

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String columnName)
                                throws java.sql.SQLException

Specified by:

getTimestamp in interface java.sql.ResultSet

Overrides:

getTimestamp in class VTITemplateBase

Throws:

java.sql.SQLException

getObject

public java.lang.Object getObject(java.lang.String columnName)
                           throws java.sql.SQLException

Specified by:

getObject in interface java.sql.ResultSet

Overrides:

getObject in class VTITemplateBase

Throws:

java.sql.SQLException

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String columnName)
                                   throws java.sql.SQLException

Specified by:

getBigDecimal in interface java.sql.ResultSet

Overrides:

getBigDecimal in class VTITemplateBase

Throws:

java.sql.SQLException