com.orindasoft.pub
Class ReadOnlyRowSet

java.lang.Object
  |
  +--com.orindasoft.pub.ReadOnlyRowSet

Direct Known Subclasses:

WriteableRowSet

public class ReadOnlyRowSet

extends java.lang.Object

A class for representing a ResultSet or set of stored procedure parameters.

Detailed information on this class is available Orinda Software

Constructor Summary

ReadOnlyRowSet(java.lang.Object[] theData, java.lang.String[] columnNames, java.lang.String[] columnOracleDatatypeNames, int[] underlyingOracleDatatypes, int[] columnJavaDatatypes, long[] columnLengths, int[] columnDecimalPlaces, LogInterface theLog, java.io.File downloadedFileDir, boolean keepFiles)
Create a ReadOnlyRowSet that is based on user defined data rather than a ResultSet.

ReadOnlyRowSet(java.sql.ResultSet theResultSet, java.lang.String theQuery, int maxRows, LogInterface theLog)
Create a ReadOnlyRowSet that is based on a ResultSet.

ReadOnlyRowSet(java.sql.ResultSet theResultSet, java.lang.String theQuery, int maxRows, LogInterface theLog, java.io.File downloadedFileDir, boolean keepFiles, java.lang.String tempFilePrefix, java.lang.String tempFileSuffix)
Create a ReadOnlyRowSet that is based on a ResultSet.

ReadOnlyRowSet(java.sql.ResultSet theResultSet, java.lang.String theQuery, int maxRows, LogInterface theLog, java.io.File downloadedFileDir, boolean keepFiles, java.lang.String tempFilePrefix, java.lang.String tempFileSuffix, boolean keepLobs)
Create a ReadOnlyRowSet that is based on a ResultSet.

ReadOnlyRowSet(java.sql.ResultSet theResultSet, java.lang.String theQuery, int maxRows, LogInterface theLog, java.io.File downloadedFileDir, boolean keepFiles, java.lang.String tempFilePrefix, java.lang.String tempFileSuffix, boolean keepLobs, boolean useByteArraysForLongsAndLOBS)
Create a ReadOnlyRowSet that is based on a ResultSet.

Method Summary

boolean	checkColumnName(java.lang.String theColumnName) Make sure that theColumnName is a valid column.
int	deleteGeneratedFiles() Delete all files in this ReadOnlyRowSet This is a cleanup method that you can use when the underlying cursor contained one or more LOB columns and you need to explicitly remove the resulting files.
boolean	first() Move to first row of the RowSet.
oracle.sql.BFILE	getBFILE(int columnId) Get column columnId as a oracle.sql.BFILE Object This method will only work if 'keepLobs' was set to true.
oracle.sql.BFILE	getBFILE(java.lang.String theColumnName) Get column columnId as a oracle.sql.BFILE Object This method will only work if 'keepLobs' was set to true.
java.math.BigDecimal	getBigDecimal(int columnId) Get column columnId as a java.math.BigDecimal Object
java.math.BigDecimal	getBigDecimal(java.lang.String theColumnName) Get column columnId as a java.math.BigDecimal Object
oracle.sql.BLOB	getBLOB(int columnId) Get column columnId as a oracle.sql.BLOB Object This method will only work if 'keepLobs' was set to true.
oracle.sql.BLOB	getBLOB(java.lang.String theColumnName) Get column columnId as a oracle.sql.BLOB Object This method will only work if 'keepLobs' was set to true.
boolean	getBoolean(int columnId) Get column columnId as a boolean.
boolean	getBoolean(java.lang.String theColumnName) Get column columnId as a boolean.
java.lang.Boolean	getBooleanObj(int columnId) Get column columnId as a Boolean Object
java.lang.Boolean	getBooleanObj(java.lang.String theColumnName) Get column columnId as a Boolean Object
byte	getByte(int columnId) Get column columnId as a byte.
byte	getByte(java.lang.String theColumnName) Get column columnId as a byte.
byte[]	getByteArray(int columnId) Get column columnId as a byte[] Object
byte[]	getByteArray(java.lang.String theColumnName) Get column columnId as a byte[] Object
java.lang.Byte	getByteObj(int columnId) Get column columnId as a Byte Object
java.lang.Byte	getByteObj(java.lang.String theColumnName) Get column columnId as a Byte Object
char[]	getCharArray(int columnId) Get column columnId as a char[] Object
char[]	getCharArray(java.lang.String theColumnName) Get column columnId as a char[] Object
oracle.sql.CLOB	getCLOB(int columnId) Get column columnId as a oracle.sql.CLOB Object This method will only work if 'keepLobs' was set to true.
oracle.sql.CLOB	getCLOB(java.lang.String theColumnName) Get column columnId as a oracle.sql.CLOB Object This method will only work if 'keepLobs' was set to true.
int	getColumnId(java.lang.String theColumnName) Get the position of a named column in rows of the underlying result set.
java.lang.String	getColumnName(int theColumnId) Get the name of a column.
java.lang.String	getColumnNamesAsString(java.lang.String delimiter) Return the row's column names in the form of a delimited string
java.lang.String[]	getColumnNamesAsStringArray() Return the row's column names in the form of a string Array
java.lang.String[]	getColumnOracleDatatypeNames() Return the Oracle data types of the the columns as an array of String
java.lang.Object[]	getCurrentRow() Return current row as an array of Object
int	getCurrentRowNumber() Return the current row number
java.sql.Date	getDate(int columnId) Get column columnId as a java.sql.Date
java.sql.Date	getDate(java.lang.String theColumnName) Get column columnId as a java.sql.Date
double	getDouble(int columnId) Get column columnId as a double.
double	getDouble(java.lang.String theColumnName) Get column columnId as a double.
java.lang.Double	getDoubleObj(int columnId) Get column columnId as a Double Object
java.lang.Double	getDoubleObj(java.lang.String theColumnName) Get column columnId as a Double Object
java.util.Date	getExpireDate() Set how long the result will remain up to date.
java.io.File	getFile(int columnId, java.io.File outputFile) Get a long text or binary column columnId as a File BLOBS, CLOBS and LONGS are downloaded to File's if in a ResultSet used to create a ReadOnlyRowSet.
java.io.File	getFile(java.lang.String theColumnName, java.io.File outputFile) Get a long text or binary column columnId as a File BLOBS, CLOBS and LONGS are downloaded to File's if in a ResultSet used to create a ReadOnlyRowSet.
float	getFloat(int columnId) Get column columnId as a float.
float	getFloat(java.lang.String theColumnName) Get column columnId as a float.
java.lang.Float	getFloatObj(int columnId) Get column columnId as a Float Object
java.lang.Float	getFloatObj(java.lang.String theColumnName) Get column columnId as a Float Object
int	getInt(int columnId) Get column columnId as an int.
int	getInt(java.lang.String theColumnName) Get column columnId as an int.
java.lang.Integer	getIntegerObj(int columnId) Get column columnId as a Integer Object
java.lang.Integer	getIntegerObj(java.lang.String theColumnName) Get column columnId as a Integer Object
long	getLong(int columnId) Get column columnId as a long.
long	getLong(java.lang.String theColumnName) Get column columnId as a long.
java.lang.Long	getLongObj(int columnId) Get column columnId as a Long Object
java.lang.Long	getLongObj(java.lang.String theColumnName) Get column columnId as a Long Object
java.lang.Object	getObject(int columnId) Get column columnId as an Object.
java.lang.Object	getObject(java.lang.String theColumnName) Get column columnId as an Object.
oracle.sql.OPAQUE	getOpaque(int columnId) Get column columnId as an oracle.sql.OPAQUE.
oracle.sql.OPAQUE	getOpaque(java.lang.String theColumnName) Get column columnId as an oracle.sql.OPAQUE.
java.lang.String	getRowAsString(java.lang.String delimiter, java.lang.String unprintableFieldMessage) Return the entire row in the form of a delimited string
short	getShort(int columnId) Get column columnId as a short.
short	getShort(java.lang.String theColumnName) Get column columnId as a short.
java.lang.Short	getShortObj(int columnId) Get column columnId as a Short Object
java.lang.Short	getShortObj(java.lang.String theColumnName) Get column columnId as a Short Object
java.lang.String	getString(int columnId) Get column columnId as a String.
java.lang.String	getString(java.lang.String theColumnName) Get column columnId as a String.
java.lang.String	getTempFileSuffix() Get the prefix used for generating temporary files
java.sql.Timestamp	getTimestamp(int columnId) Get column columnId as a java.sql.Timestamp
oracle.sql.TIMESTAMP	getTIMESTAMP(int columnId) Get column columnId as a TIMESTAMP Object
java.sql.Timestamp	getTimestamp(java.lang.String theColumnName) Get column columnId as a java.sql.Timestamp
oracle.sql.TIMESTAMP	getTIMESTAMP(java.lang.String theColumnName) Get column columnId as a oracle.sql.TIMESTAMP Object
oracle.sql.TIMESTAMPLTZ	getTIMESTAMPLTZ(int columnId) Get column columnId as a TIMESTAMPLTZ Object
oracle.sql.TIMESTAMPLTZ	getTIMESTAMPLTZ(java.lang.String theColumnName) Get column columnId as a oracle.sql.TIMESTAMPLTZ Object
oracle.sql.TIMESTAMPTZ	getTIMESTAMPTZ(int columnId) Get column columnId as a TIMESTAMPTZ Object
oracle.sql.TIMESTAMPTZ	getTIMESTAMPTZ(java.lang.String theColumnName) Get column columnId as a oracle.sql.TIMESTAMPTZ Object
WriteableRowSet	getWriteableRowSet()
boolean	hasExpired() Set how long the result will remain up to date.
boolean	hitMemLimit() Identify when we had to stop adding rows to the ResultSet because we ran out of memory.
boolean	hitRowLimit() Identify when we had to stop adding rows to the ResultSet because we reached the limit on the number of rows that are to be stored.
boolean	isNull(int columnId) Return true if the column is null.
boolean	isNull(java.lang.String theColumnName) Return true if the column is null.
boolean	last() Move to last row of the RowSet.
boolean	nextRow() Move to next row of the RowSet.
boolean	prevRow() Move to previous row of the RowSet.
boolean	setCurrentRowNumber(int newCurrentRowNumber) Move to a specific row of the RowSet.
void	setExpireDate(long theExpireDate) Set how long the result will remain up to date.
void	setNumberFormat(java.text.NumberFormat newNumberFormat) Change the way Numbers are converted to Strings
void	setTempFileSuffix(java.lang.String tempFileSuffix) Set the suffix used for generating temporary files
void	setTimestampFormat(java.lang.String newTimestampFormat) Change the way Timestamps are converted to Strings
int	size() Return the number of rows
java.lang.String	toString() Return a String representation of the start of the row set
int	width() Return the number of columns

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReadOnlyRowSet

public ReadOnlyRowSet(java.lang.Object[] theData,
                      java.lang.String[] columnNames,
                      java.lang.String[] columnOracleDatatypeNames,
                      int[] underlyingOracleDatatypes,
                      int[] columnJavaDatatypes,
                      long[] columnLengths,
                      int[] columnDecimalPlaces,
                      LogInterface theLog,
                      java.io.File downloadedFileDir,
                      boolean keepFiles)

Create a ReadOnlyRowSet that is based on user defined data rather than a ResultSet. This constructor is used to create a rowset based on a set of parameters for a stored procedure call.

Parameters:

Object[] - theData An array of Object that contains another array of Object. The inner arrays are all of the the same length and map to a row of columns.

String[] - columnNames

String[] - columnOracleDatatypes

int[] - underlyingOracleDatatypes

int[] - columnJavaDatatypes

LogInterface - theLog

File - downloadedFileDir A directory to keep files containing clobs and blobs

ReadOnlyRowSet

public ReadOnlyRowSet(java.sql.ResultSet theResultSet,
                      java.lang.String theQuery,
                      int maxRows,
                      LogInterface theLog)
               throws CSException

Create a ReadOnlyRowSet that is based on a ResultSet.

Parameters:

ResultSet - theResultSet

String - theQuery

int - maxRows

LogInterface - theLog

Throws:

CSException -

ReadOnlyRowSet

public ReadOnlyRowSet(java.sql.ResultSet theResultSet,
                      java.lang.String theQuery,
                      int maxRows,
                      LogInterface theLog,
                      java.io.File downloadedFileDir,
                      boolean keepFiles,
                      java.lang.String tempFilePrefix,
                      java.lang.String tempFileSuffix)
               throws CSException

Create a ReadOnlyRowSet that is based on a ResultSet.

Parameters:

ResultSet - theResultSet

String - theQuery

int - maxRows Maximum number of rows that will be retrieved. The JDBC driver will stop returning rows after about 30,000.

LogInterface - theLog

File - A directory where downloaded CLOBS and BLOBS will be stored.

boolean - keepFiles Whether generated files are kept or deleted when the JVM exits

String - tempFilePrefix Prefix for generated temporary files.

String - tempFileSuffix Suffix for generated temporary files.

Throws:

CSException -

ReadOnlyRowSet

public ReadOnlyRowSet(java.sql.ResultSet theResultSet,
                      java.lang.String theQuery,
                      int maxRows,
                      LogInterface theLog,
                      java.io.File downloadedFileDir,
                      boolean keepFiles,
                      java.lang.String tempFilePrefix,
                      java.lang.String tempFileSuffix,
                      boolean keepLobs)
               throws CSException

Create a ReadOnlyRowSet that is based on a ResultSet.

Parameters:

ResultSet - theResultSet

String - theQuery

int - maxRows Maximum number of rows that will be retrieved. The JDBC driver will stop returning rows after about 30,000.

LogInterface - theLog

File - A directory where downloaded CLOBS and BLOBS will be stored.

boolean - keepFiles Whether generated files are kept or deleted when the JVM exits

String - tempFilePrefix Prefix for generated temporary files.

String - tempFileSuffix Suffix for generated temporary files.

boolean - keepLobs Whether lobs suchs as CLOBS and BLOBS are turned into Files on retrieval

Throws:

CSException -

Since:

2.0.1505 'keepLobs' added.

ReadOnlyRowSet

public ReadOnlyRowSet(java.sql.ResultSet theResultSet,
                      java.lang.String theQuery,
                      int maxRows,
                      LogInterface theLog,
                      java.io.File downloadedFileDir,
                      boolean keepFiles,
                      java.lang.String tempFilePrefix,
                      java.lang.String tempFileSuffix,
                      boolean keepLobs,
                      boolean useByteArraysForLongsAndLOBS)
               throws CSException

Create a ReadOnlyRowSet that is based on a ResultSet.

Parameters:

ResultSet - theResultSet

String - theQuery

int - maxRows Maximum number of rows that will be retrieved. The JDBC driver will stop returning rows after about 30,000.

LogInterface - theLog

File - A directory where downloaded CLOBS and BLOBS will be stored.

boolean - keepFiles Whether generated files are kept or deleted when the JVM exits

String - tempFilePrefix Prefix for generated temporary files.

String - tempFileSuffix Suffix for generated temporary files.

boolean - keepLobs Whether lobs suchs as CLOBS and BLOBS are turned into Files on retrieval

Throws:

CSException -

Since:

2.0.1505 'keepLobs' added.

Method Detail

getColumnId

public int getColumnId(java.lang.String theColumnName)

Get the position of a named column in rows of the underlying result set. Return the Id of the first value in columnNames that matches theColumnName. Note that there is nothing that prevents a column name being used multiple times withing a result set, in which case the id of the first matching column will be returned.

Parameters:

String - theColumnName The name of the column whose id you are looking for.

Returns:

An int which identifies the first occurance of columnName

getColumnName

public java.lang.String getColumnName(int theColumnId)
                               throws CSInvalidColumnIdException

Get the name of a column. Return the Name of the value in columnNames that for theColumnId.

Parameters:

int - theColumnId The id of the column whose name you are looking for.

Returns:

A String which is the column name

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 1.

getCurrentRowNumber

public int getCurrentRowNumber()

Return the current row number

Returns:

int the current row number.

size

public int size()

Return the number of rows

Returns:

int the number of rows

width

public int width()

Return the number of columns

Returns:

int the number of columns

hitRowLimit

public boolean hitRowLimit()

Identify when we had to stop adding rows to the ResultSet because we reached the limit on the number of rows that are to be stored.

Returns:

boolean true if we reached maxRows when we were created.

hitMemLimit

public boolean hitMemLimit()

Identify when we had to stop adding rows to the ResultSet because we ran out of memory.

Returns:

boolean true if we reached minimumFreeMemoryBytes when we were created.

Since:

6.0.2615 hitMemLimit no longer stops query being read.

setCurrentRowNumber

public boolean setCurrentRowNumber(int newCurrentRowNumber)

Move to a specific row of the RowSet.

Parameters:

int - newCurrentRowNumber the new row number.

Returns:

true if newCurrentRowNumber is a valid row

nextRow

public boolean nextRow()

Move to next row of the RowSet.

Returns:

true if the RowSet has 1 or more rows and we weren't already on the last row

prevRow

public boolean prevRow()

Move to previous row of the RowSet.

Returns:

true if the RowSet has 1 or more rows and we weren't already on the first row

first

public boolean first()

Move to first row of the RowSet.

Returns:

true if the RowSet has 1 or more rows

last

public boolean last()

Move to last row of the RowSet.

Returns:

true if the RowSet has 1 or more rows

getDate

public java.sql.Date getDate(java.lang.String theColumnName)
                      throws CSInvalidColumnIdException,
                             CSNoDataInRowSetException,
                             CSDBInvalidDatatypeCastException

Get column columnId as a java.sql.Date

Parameters:

String - theColumnName The name of the column

Returns:

java.sql.Date the Value of column #columnId if it can be turned into a Date.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 1.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId can not be turned into a date

getDate

public java.sql.Date getDate(int columnId)
                      throws CSInvalidColumnIdException,
                             CSNoDataInRowSetException,
                             CSDBInvalidDatatypeCastException

Get column columnId as a java.sql.Date

Parameters:

int - columnId the ID of the column

Returns:

java.sql.Date the Value of column #columnId if it can be turned into a Date.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 1.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId can not be turned into a date

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String theColumnName)
                                throws CSInvalidColumnIdException,
                                       CSNoDataInRowSetException,
                                       CSDBInvalidDatatypeCastException

Get column columnId as a java.sql.Timestamp

Parameters:

String - theColumnName The name of the column

Returns:

java.util.Date the Value of column #columnId if it can be turned into a Date.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 1.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId can not be turned into a date

getTimestamp

public java.sql.Timestamp getTimestamp(int columnId)
                                throws CSInvalidColumnIdException,
                                       CSNoDataInRowSetException,
                                       CSDBInvalidDatatypeCastException

Get column columnId as a java.sql.Timestamp

Parameters:

int - theColumnId The id of the column

Returns:

java.util.Date the Value of column #columnId if it can be turned into a Date.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 1.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId can not be turned into a date

isNull

public boolean isNull(java.lang.String theColumnName)
               throws CSInvalidColumnIdException,
                      CSNoDataInRowSetException

Return true if the column is null.

Parameters:

String - theColumnName The name of the column

Returns:

true is this column is null

Throws:

CSInvalidColumnIdException - If the columnId is not that of a valid column

CSNoDataInRowSetException - If there are no rows.

isNull

public boolean isNull(int columnId)
               throws CSInvalidColumnIdException,
                      CSNoDataInRowSetException

Return true if the column is null.

Parameters:

int - columnId The column Id

Returns:

true is this column is null

Throws:

CSInvalidColumnIdException - If the columnId is not that of a valid column

CSNoDataInRowSetException - If there are no rows.

getBooleanObj

public java.lang.Boolean getBooleanObj(java.lang.String theColumnName)
                                throws CSInvalidColumnIdException,
                                       CSNoDataInRowSetException,
                                       CSDBInvalidDatatypeCastException

Get column columnId as a Boolean Object

Parameters:

String - theColumnName The name of the column

Returns:

true If the underlying column is a number with a value of zero.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Boolean

CSNoDataInRowSetException - if there are no rows in this rowset.

getBooleanObj

public java.lang.Boolean getBooleanObj(int columnId)
                                throws CSInvalidColumnIdException,
                                       CSNoDataInRowSetException,
                                       CSDBInvalidDatatypeCastException

Get column columnId as a Boolean Object

Parameters:

int - columnId The number of the column.

Returns:

true If the underlying column is a number with a value of zero.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Boolean or the column is a number that is too big too fit into a Boolean.

CSNoDataInRowSetException - if there are no rows in this rowset.

getTIMESTAMP

public oracle.sql.TIMESTAMP getTIMESTAMP(java.lang.String theColumnName)
                                  throws CSInvalidColumnIdException,
                                         CSNoDataInRowSetException,
                                         CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.TIMESTAMP Object

Parameters:

String - theColumnName The name of the column

Returns:

an oracle.sql.TIMESTAMP.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a TIMESTAMP

CSNoDataInRowSetException - if there are no rows in this rowset.

getTIMESTAMP

public oracle.sql.TIMESTAMP getTIMESTAMP(int columnId)
                                  throws CSInvalidColumnIdException,
                                         CSNoDataInRowSetException,
                                         CSDBInvalidDatatypeCastException

Get column columnId as a TIMESTAMP Object

Parameters:

int - columnId The number of the column.

Returns:

an oracle.sql.TIMESTAMP.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a TIMESTAMP

CSNoDataInRowSetException - if there are no rows in this rowset.

getTIMESTAMPTZ

public oracle.sql.TIMESTAMPTZ getTIMESTAMPTZ(java.lang.String theColumnName)
                                      throws CSInvalidColumnIdException,
                                             CSNoDataInRowSetException,
                                             CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.TIMESTAMPTZ Object

Parameters:

String - theColumnName The name of the column

Returns:

an oracle.sql.TIMESTAMPTZ.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a TIMESTAMPTZ

CSNoDataInRowSetException - if there are no rows in this rowset.

getTIMESTAMPTZ

public oracle.sql.TIMESTAMPTZ getTIMESTAMPTZ(int columnId)
                                      throws CSInvalidColumnIdException,
                                             CSNoDataInRowSetException,
                                             CSDBInvalidDatatypeCastException

Get column columnId as a TIMESTAMPTZ Object

Parameters:

int - columnId The number of the column.

Returns:

an oracle.sql.TIMESTAMPTZ.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a TIMESTAMPTZ

CSNoDataInRowSetException - if there are no rows in this rowset.

getTIMESTAMPLTZ

public oracle.sql.TIMESTAMPLTZ getTIMESTAMPLTZ(java.lang.String theColumnName)
                                        throws CSInvalidColumnIdException,
                                               CSNoDataInRowSetException,
                                               CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.TIMESTAMPLTZ Object

Parameters:

String - theColumnName The name of the column

Returns:

an oracle.sql.TIMESTAMPLTZ.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a TIMESTAMPLTZ

CSNoDataInRowSetException - if there are no rows in this rowset.

getTIMESTAMPLTZ

public oracle.sql.TIMESTAMPLTZ getTIMESTAMPLTZ(int columnId)
                                        throws CSInvalidColumnIdException,
                                               CSNoDataInRowSetException,
                                               CSDBInvalidDatatypeCastException

Get column columnId as a TIMESTAMPLTZ Object

Parameters:

int - columnId The number of the column.

Returns:

an oracle.sql.TIMESTAMPLTZ.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a TIMESTAMPLTZ or the column is a number that is too big too fit into a TIMESTAMPLTZ.

CSNoDataInRowSetException - if there are no rows in this rowset.

getBoolean

public boolean getBoolean(java.lang.String theColumnName)
                   throws CSInvalidColumnIdException,
                          CSNoDataInRowSetException,
                          CSDBInvalidDatatypeCastException,
                          CSAttemptToGetNullException

Get column columnId as a boolean.

Parameters:

String - theColumnName The name of the column

Returns:

true If the underlying column is a number with a value of zero.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a boolean or the column is a number that is too big too fit into a boolean.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getBoolean

public boolean getBoolean(int columnId)
                   throws CSInvalidColumnIdException,
                          CSNoDataInRowSetException,
                          CSDBInvalidDatatypeCastException,
                          CSAttemptToGetNullException

Get column columnId as a boolean.

Parameters:

int - columnId The number of the column.

Returns:

true If the underlying column is a number with a value of zero.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a boolean or the column is a number that is too big too fit into a boolean.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getByteObj

public java.lang.Byte getByteObj(java.lang.String theColumnName)
                          throws CSInvalidColumnIdException,
                                 CSNoDataInRowSetException,
                                 CSDBInvalidDatatypeCastException

Get column columnId as a Byte Object

Parameters:

String - theColumnName The name of the column

Returns:

Byte the Value of column #columnId if it can be turned into a Byte.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Byte or the column is a number that is too big too fit into a Byte.

CSNoDataInRowSetException - if there are no rows in this rowset.

getByteObj

public java.lang.Byte getByteObj(int columnId)
                          throws CSInvalidColumnIdException,
                                 CSNoDataInRowSetException,
                                 CSDBInvalidDatatypeCastException

Get column columnId as a Byte Object

Parameters:

int - columnId The number of the column.

Returns:

Byte the Value of column #columnId if it can be turned into a Byte.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Byte or the column is a number that is too big too fit into a Byte.

CSNoDataInRowSetException - if there are no rows in this rowset.

getByte

public byte getByte(java.lang.String theColumnName)
             throws CSInvalidColumnIdException,
                    CSNoDataInRowSetException,
                    CSDBInvalidDatatypeCastException,
                    CSAttemptToGetNullException

Get column columnId as a byte.

Parameters:

String - theColumnName The name of the column

Returns:

byte the Value of column #columnId if it can be turned into a byte.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a byte or the column is a number that is too big too fit into a byte.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getByte

public byte getByte(int columnId)
             throws CSInvalidColumnIdException,
                    CSNoDataInRowSetException,
                    CSDBInvalidDatatypeCastException,
                    CSAttemptToGetNullException

Get column columnId as a byte.

Parameters:

int - columnId The number of the column.

Returns:

byte the Value of column #columnId if it can be turned into a byte.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a byte or the column is a number that is too big too fit into a byte.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getShortObj

public java.lang.Short getShortObj(java.lang.String theColumnName)
                            throws CSInvalidColumnIdException,
                                   CSNoDataInRowSetException,
                                   CSDBInvalidDatatypeCastException

Get column columnId as a Short Object

Parameters:

String - theColumnName The name of the column

Returns:

Short the Value of column #columnId if it can be turned into a Short.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Short or the column is a number that is too big too fit into a Short.

CSNoDataInRowSetException - if there are no rows in this rowset.

getShortObj

public java.lang.Short getShortObj(int columnId)
                            throws CSInvalidColumnIdException,
                                   CSNoDataInRowSetException,
                                   CSDBInvalidDatatypeCastException

Get column columnId as a Short Object

Parameters:

int - columnId The number of the column.

Returns:

Short the Value of column #columnId if it can be turned into a Short.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Short or the column is a number that is too big too fit into a Short.

CSNoDataInRowSetException - if there are no rows in this rowset.

getShort

public short getShort(java.lang.String theColumnName)
               throws CSInvalidColumnIdException,
                      CSNoDataInRowSetException,
                      CSDBInvalidDatatypeCastException,
                      CSAttemptToGetNullException

Get column columnId as a short.

Parameters:

String - theColumnName The name of the column

Returns:

short the Value of column #columnId if it can be turned into a short.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a short or the column is a number that is too big too fit into a short.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getShort

public short getShort(int columnId)
               throws CSInvalidColumnIdException,
                      CSNoDataInRowSetException,
                      CSDBInvalidDatatypeCastException,
                      CSAttemptToGetNullException

Get column columnId as a short.

Parameters:

int - columnId The number of the column.

Returns:

short the Value of column #columnId if it can be turned into a short.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a short or the column is a number that is too big too fit into a short.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getIntegerObj

public java.lang.Integer getIntegerObj(java.lang.String theColumnName)
                                throws CSInvalidColumnIdException,
                                       CSNoDataInRowSetException,
                                       CSDBInvalidDatatypeCastException

Get column columnId as a Integer Object

Parameters:

String - theColumnName The name of the column

Returns:

Integer the Value of column #columnId if it can be turned into a Integer.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Integer or the column is a number that is too big too fit into a Integer.

CSNoDataInRowSetException - if there are no rows in this rowset.

getIntegerObj

public java.lang.Integer getIntegerObj(int columnId)
                                throws CSInvalidColumnIdException,
                                       CSNoDataInRowSetException,
                                       CSDBInvalidDatatypeCastException

Get column columnId as a Integer Object

Parameters:

int - columnId The number of the column.

Returns:

Integer the Value of column #columnId if it can be turned into a Integer.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Integer or the column is a number that is too big too fit into a Integer.

CSNoDataInRowSetException - if there are no rows in this rowset.

getInt

public int getInt(java.lang.String theColumnName)
           throws CSInvalidColumnIdException,
                  CSNoDataInRowSetException,
                  CSDBInvalidDatatypeCastException,
                  CSAttemptToGetNullException

Get column columnId as an int.

Parameters:

String - theColumnName The name of the column

Returns:

int the Value of column #columnId if it can be turned into a int.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a int or the column is a number that is too big too fit into a int.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getInt

public int getInt(int columnId)
           throws CSInvalidColumnIdException,
                  CSNoDataInRowSetException,
                  CSDBInvalidDatatypeCastException,
                  CSAttemptToGetNullException

Get column columnId as an int.

Parameters:

int - columnId The number of the column.

Returns:

int the Value of column #columnId if it can be turned into a int.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a int or the column is a number that is too big too fit into a int.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getLongObj

public java.lang.Long getLongObj(java.lang.String theColumnName)
                          throws CSInvalidColumnIdException,
                                 CSNoDataInRowSetException,
                                 CSDBInvalidDatatypeCastException

Get column columnId as a Long Object

Parameters:

String - theColumnName The name of the column

Returns:

Long the Value of column #columnId if it can be turned into a Long.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Long or the column is a number that is too big too fit into a Long.

CSNoDataInRowSetException - if there are no rows in this rowset.

getLongObj

public java.lang.Long getLongObj(int columnId)
                          throws CSInvalidColumnIdException,
                                 CSNoDataInRowSetException,
                                 CSDBInvalidDatatypeCastException

Get column columnId as a Long Object

Parameters:

int - columnId The number of the column.

Returns:

Long the Value of column #columnId if it can be turned into a Long.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Long or the column is a number that is too big too fit into a Long.

CSNoDataInRowSetException - if there are no rows in this rowset.

getLong

public long getLong(java.lang.String theColumnName)
             throws CSInvalidColumnIdException,
                    CSNoDataInRowSetException,
                    CSDBInvalidDatatypeCastException,
                    CSAttemptToGetNullException

Get column columnId as a long.

Parameters:

String - theColumnName The name of the column

Returns:

long the Value of column #columnId if it can be turned into a long.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a long or the column is a number that is too big too fit into a long.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getLong

public long getLong(int columnId)
             throws CSInvalidColumnIdException,
                    CSNoDataInRowSetException,
                    CSDBInvalidDatatypeCastException,
                    CSAttemptToGetNullException

Get column columnId as a long.

Parameters:

int - columnId The number of the column.

Returns:

long the Value of column #columnId if it can be turned into a long.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a long or the column is a number that is too big too fit into a long.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getFloatObj

public java.lang.Float getFloatObj(java.lang.String theColumnName)
                            throws CSInvalidColumnIdException,
                                   CSNoDataInRowSetException,
                                   CSDBInvalidDatatypeCastException

Get column columnId as a Float Object

Parameters:

String - theColumnName The name of the column

Returns:

Float the Value of column #columnId if it can be turned into a Float.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Float or the column is a number that is too big too fit into a Float.

CSNoDataInRowSetException - if there are no rows in this rowset.

getFloatObj

public java.lang.Float getFloatObj(int columnId)
                            throws CSInvalidColumnIdException,
                                   CSNoDataInRowSetException,
                                   CSDBInvalidDatatypeCastException

Get column columnId as a Float Object

Parameters:

int - columnId The number of the column.

Returns:

Float the Value of column #columnId if it can be turned into a Float.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Float or the column is a number that is too big too fit into a Float.

CSNoDataInRowSetException - if there are no rows in this rowset.

getFloat

public float getFloat(java.lang.String theColumnName)
               throws CSInvalidColumnIdException,
                      CSNoDataInRowSetException,
                      CSDBInvalidDatatypeCastException,
                      CSAttemptToGetNullException

Get column columnId as a float.

Parameters:

String - theColumnName The name of the column

Returns:

float the Value of column #columnId if it can be turned into a float.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a float or the column is a number that is too big too fit into a float.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getFloat

public float getFloat(int columnId)
               throws CSInvalidColumnIdException,
                      CSNoDataInRowSetException,
                      CSDBInvalidDatatypeCastException,
                      CSAttemptToGetNullException

Get column columnId as a float.

Parameters:

int - columnId The number of the column.

Returns:

float the Value of column #columnId if it can be turned into a float.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a float or the column is a number that is too big too fit into a float.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getDoubleObj

public java.lang.Double getDoubleObj(java.lang.String theColumnName)
                              throws CSInvalidColumnIdException,
                                     CSNoDataInRowSetException,
                                     CSDBInvalidDatatypeCastException

Get column columnId as a Double Object

Parameters:

String - theColumnName The name of the column

Returns:

Double the Value of column #columnId if it can be turned into a Double.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Double

CSNoDataInRowSetException - if there are no rows in this rowset.

getDoubleObj

public java.lang.Double getDoubleObj(int columnId)
                              throws CSInvalidColumnIdException,
                                     CSNoDataInRowSetException,
                                     CSDBInvalidDatatypeCastException

Get column columnId as a Double Object

Parameters:

int - columnId The number of the column.

Returns:

Double the Value of column #columnId if it can be turned into a Double.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a Double

CSNoDataInRowSetException - if there are no rows in this rowset.

getDouble

public double getDouble(java.lang.String theColumnName)
                 throws CSInvalidColumnIdException,
                        CSNoDataInRowSetException,
                        CSDBInvalidDatatypeCastException,
                        CSAttemptToGetNullException

Get column columnId as a double.

Parameters:

String - theColumnName The name of the column

Returns:

double the Value of column #columnId if it can be turned into a double.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a double or the column is a number that is too big too fit into a double.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getDouble

public double getDouble(int columnId)
                 throws CSInvalidColumnIdException,
                        CSNoDataInRowSetException,
                        CSDBInvalidDatatypeCastException,
                        CSAttemptToGetNullException

Get column columnId as a double.

Parameters:

int - columnId The number of the column.

Returns:

double the Value of column #columnId if it can be turned into a double.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a double or the column is a number that is too big too fit into a double.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSAttemptToGetNullException - if the value of columnId is null

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String theColumnName)
                                   throws CSInvalidColumnIdException,
                                          CSNoDataInRowSetException,
                                          CSDBInvalidDatatypeCastException

Get column columnId as a java.math.BigDecimal Object

Parameters:

String - theColumnName The name of the column

Returns:

java.math.BigDecimal the Value of column #columnId if it can be turned into a java.math.BigDecimal.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a java.math.BigDecimal

CSNoDataInRowSetException - if there are no rows in this rowset.

getBigDecimal

public java.math.BigDecimal getBigDecimal(int columnId)
                                   throws CSInvalidColumnIdException,
                                          CSNoDataInRowSetException,
                                          CSDBInvalidDatatypeCastException

Get column columnId as a java.math.BigDecimal Object

Parameters:

int - columnId The number of the column.

Returns:

java.math.BigDecimal the Value of column #columnId if it can be turned into a java.math.BigDecimal.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a java.math.BigDecimal

CSNoDataInRowSetException - if there are no rows in this rowset.

getString

public java.lang.String getString(java.lang.String theColumnName)
                           throws CSInvalidColumnIdException,
                                  CSNoDataInRowSetException,
                                  CSDBInvalidDatatypeCastException,
                                  CSUnsupportedDatatypeException

Get column columnId as a String. Numbers will be formatted. Dates will be formatted according to theTimeStampFormat.

Parameters:

String - theColumnName The name of the column

Returns:

String the Value of column #columnId if it can be turned into a string.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 0.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be turned into a String.

CSUnsupportedDatatypeException - if columnId is not of a data type that we support.

getString

public java.lang.String getString(int columnId)
                           throws CSInvalidColumnIdException,
                                  CSNoDataInRowSetException,
                                  CSDBInvalidDatatypeCastException,
                                  CSUnsupportedDatatypeException

Get column columnId as a String. Numbers will be formatted. Dates will be formatted according to theTimeStampFormat.

Parameters:

int - columnId The number of the column.

Returns:

String the Value of column #columnId if it can be turned into a string.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 0.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be turned into a String.

CSUnsupportedDatatypeException - if columnId is not of a data type that we support.

getCharArray

public char[] getCharArray(java.lang.String theColumnName)
                    throws CSInvalidColumnIdException,
                           CSNoDataInRowSetException,
                           CSDBInvalidDatatypeCastException,
                           CSUnsupportedDatatypeException

Get column columnId as a char[] Object

Parameters:

String - theColumnName The name of the column

Returns:

char[] the Value of column #columnId if it can be turned into a char[].

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a char[]

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

v6.0.2770

getCharArray

public char[] getCharArray(int columnId)
                    throws CSInvalidColumnIdException,
                           CSNoDataInRowSetException,
                           CSDBInvalidDatatypeCastException,
                           CSUnsupportedDatatypeException

Get column columnId as a char[] Object

Parameters:

int - columnId The number of the column.

Returns:

char[] the Value of column #columnId if it can be turned into a char[].

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a char[]

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

v6.0.2770

getByteArray

public byte[] getByteArray(java.lang.String theColumnName)
                    throws CSInvalidColumnIdException,
                           CSNoDataInRowSetException,
                           CSDBInvalidDatatypeCastException,
                           CSUnsupportedDatatypeException

Get column columnId as a byte[] Object

Parameters:

String - theColumnName The name of the column

Returns:

byte[] the Value of column #columnId if it can be turned into a byte[].

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a byte[]

CSNoDataInRowSetException - if there are no rows in this rowset.

getByteArray

public byte[] getByteArray(int columnId)
                    throws CSInvalidColumnIdException,
                           CSNoDataInRowSetException,
                           CSDBInvalidDatatypeCastException,
                           CSUnsupportedDatatypeException

Get column columnId as a byte[] Object

Parameters:

int - columnId The number of the column.

Returns:

byte[] the Value of column #columnId if it can be turned into a byte[].

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a byte[]

CSNoDataInRowSetException - if there are no rows in this rowset.

getObject

public java.lang.Object getObject(java.lang.String theColumnName)
                           throws CSInvalidColumnIdException,
                                  CSNoDataInRowSetException,
                                  CSDBInvalidDatatypeCastException,
                                  CSUnsupportedDatatypeException

Get column columnId as an Object.

Parameters:

String - the name of the column.

Returns:

Object the Value of column #columnId if it can be turned into an Object.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 0.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be turned into a String.

CSUnsupportedDatatypeException - if columnId is not of a data type that we support.

getObject

public java.lang.Object getObject(int columnId)
                           throws CSInvalidColumnIdException,
                                  CSNoDataInRowSetException,
                                  CSDBInvalidDatatypeCastException,
                                  CSUnsupportedDatatypeException

Get column columnId as an Object.

Parameters:

int - columnId The number of the column.

Returns:

Object the Value of column #columnId if it can be turned into an Object.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 0.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be turned into a String.

CSUnsupportedDatatypeException - if columnId is not of a data type that we support.

getOpaque

public oracle.sql.OPAQUE getOpaque(java.lang.String theColumnName)
                            throws CSInvalidColumnIdException,
                                   CSNoDataInRowSetException,
                                   CSDBInvalidDatatypeCastException,
                                   CSUnsupportedDatatypeException

Get column columnId as an oracle.sql.OPAQUE.

Parameters:

String - the name of the column.

Returns:

oracle.sql.OPAQUE the Value of column #columnId if it can be turned into an oracle.sql.OPAQUE.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 0.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be turned into a String.

CSUnsupportedDatatypeException - if columnId is not of a data type that we support.

getOpaque

public oracle.sql.OPAQUE getOpaque(int columnId)
                            throws CSInvalidColumnIdException,
                                   CSNoDataInRowSetException,
                                   CSDBInvalidDatatypeCastException,
                                   CSUnsupportedDatatypeException

Get column columnId as an oracle.sql.OPAQUE.

Parameters:

int - columnId The number of the column.

Returns:

oracle.sql.OPAQUE the Value of column #columnId if it can be turned into an oracle.sql.OPAQUE.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 0.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be turned into a String.

CSUnsupportedDatatypeException - if columnId is not of a data type that we support.

getRowAsString

public java.lang.String getRowAsString(java.lang.String delimiter,
                                       java.lang.String unprintableFieldMessage)
                                throws CSNoDataInRowSetException

Return the entire row in the form of a delimited string

Parameters:

String - delimiter a delimiter such as ":"

String - unprintableFieldMessage a label such as "unprintable"

Returns:

The row in the form of a text String.

Throws:

CSNoDataInRowSetException - if there are no rows in this rowset.

getColumnNamesAsString

public java.lang.String getColumnNamesAsString(java.lang.String delimiter)

Return the row's column names in the form of a delimited string

Parameters:

String - delimiter a delimiter such as ":"

getColumnNamesAsStringArray

public java.lang.String[] getColumnNamesAsStringArray()

Return the row's column names in the form of a string Array

Returns:

String[]

getColumnOracleDatatypeNames

public java.lang.String[] getColumnOracleDatatypeNames()

Return the Oracle data types of the the columns as an array of String

Returns:

String[]

Since:

JDBCWizard V5.0.2177

checkColumnName

public boolean checkColumnName(java.lang.String theColumnName)

Make sure that theColumnName is a valid column.

Parameters:

String - theColumnName The name of a supposedly valid column

Returns:

true if we can match this column name to a column

setTimestampFormat

public void setTimestampFormat(java.lang.String newTimestampFormat)

Change the way Timestamps are converted to Strings

Parameters:

String - newTimestampFormat

setNumberFormat

public void setNumberFormat(java.text.NumberFormat newNumberFormat)

Change the way Numbers are converted to Strings

Parameters:

NumberFormat - newNumberFormat

getCurrentRow

public java.lang.Object[] getCurrentRow()
                                 throws CSNoDataInRowSetException

Return current row as an array of Object

Returns:

Object[] A one dimensional Object array containing the current row.

Throws:

CSNoDataInRowSetException - if the rowset is empty.

getBFILE

public oracle.sql.BFILE getBFILE(java.lang.String theColumnName)
                          throws CSInvalidColumnIdException,
                                 CSNoDataInRowSetException,
                                 CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.BFILE Object This method will only work if 'keepLobs' was set to true.

Parameters:

String - theColumnName The name of the column

Returns:

oracle.sql.BFILE the Value of column #columnId if it can be turned into a oracle.sql.BFILE.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a oracle.sql.BFILE

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

2.0.1505

getBFILE

public oracle.sql.BFILE getBFILE(int columnId)
                          throws CSInvalidColumnIdException,
                                 CSNoDataInRowSetException,
                                 CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.BFILE Object This method will only work if 'keepLobs' was set to true.

Parameters:

int - columnId The number of the column.

Returns:

oracle.sql.BFILE the Value of column #columnId if it can be turned into a oracle.sql.BFILE.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a oracle.sql.BFILE

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

2.0.1505

getBLOB

public oracle.sql.BLOB getBLOB(java.lang.String theColumnName)
                        throws CSInvalidColumnIdException,
                               CSNoDataInRowSetException,
                               CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.BLOB Object This method will only work if 'keepLobs' was set to true.

Parameters:

String - theColumnName The name of the column

Returns:

oracle.sql.BLOB the Value of column #columnId if it can be turned into a oracle.sql.BLOB.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a oracle.sql.BLOB

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

2.0.1505

getBLOB

public oracle.sql.BLOB getBLOB(int columnId)
                        throws CSInvalidColumnIdException,
                               CSNoDataInRowSetException,
                               CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.BLOB Object This method will only work if 'keepLobs' was set to true.

Parameters:

int - columnId The number of the column.

Returns:

oracle.sql.BLOB the Value of column #columnId if it can be turned into a oracle.sql.BLOB.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a oracle.sql.BLOB

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

2.0.1505

getCLOB

public oracle.sql.CLOB getCLOB(java.lang.String theColumnName)
                        throws CSInvalidColumnIdException,
                               CSNoDataInRowSetException,
                               CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.CLOB Object This method will only work if 'keepLobs' was set to true.

Parameters:

String - theColumnName The name of the column

Returns:

oracle.sql.CLOB the Value of column #columnId if it can be turned into a oracle.sql.CLOB.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a oracle.sql.CLOB

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

2.0.1505

getCLOB

public oracle.sql.CLOB getCLOB(int columnId)
                        throws CSInvalidColumnIdException,
                               CSNoDataInRowSetException,
                               CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.CLOB Object This method will only work if 'keepLobs' was set to true.

Parameters:

int - columnId The number of the column.

Returns:

oracle.sql.CLOB the Value of column #columnId if it can be turned into a oracle.sql.CLOB.

Throws:

CSInvalidColumnIdException - if columnId is not of a data type that we can handle.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be converted to a oracle.sql.CLOB

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

2.0.1505

getFile

public java.io.File getFile(java.lang.String theColumnName,
                            java.io.File outputFile)
                     throws CSException,
                            CSInvalidColumnIdException,
                            CSNoDataInRowSetException,
                            CSDBInvalidDatatypeCastException

Get a long text or binary column columnId as a File BLOBS, CLOBS and LONGS are downloaded to File's if in a ResultSet used to create a ReadOnlyRowSet. This method allows the calling application to obtain a File Object which points to the temporary file containing the long object in question. If the parameter tempFileName is that of a valid file that does not exist then the contents of the temporary file will be coppied to a new file called tempFileName, which will then be returned instead.

Parameters:

String - theColumnName The name of the column

File - tempFile The File you want the data stored in. If this parameter is null you get the temporary file that was created when we unloaded the result set.

Object[] - tempRow The current Row.

Returns:

String the Value of column #columnId if it can be turned into a string.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 1.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be turned into a String.

CSException - if we hit a problem retrieving the Long field. If this happens we store an Exception rather than a File. This avoids throwing Exceptions when the object is being constructed and allows the application to survive if thr failure to retrieve a Long Field which may or may not be used.

getFile

public java.io.File getFile(int columnId,
                            java.io.File outputFile)
                     throws CSException,
                            CSInvalidColumnIdException,
                            CSNoDataInRowSetException,
                            CSDBInvalidDatatypeCastException

Get a long text or binary column columnId as a File BLOBS, CLOBS and LONGS are downloaded to File's if in a ResultSet used to create a ReadOnlyRowSet. This method allows the calling application to obtain a File Object which points to the temporary file containing the long object in question. If the parameter tempFileName is that of a valid file that does not exist then the contents of the temporary file will be coppied to a new file called tempFileName, which will then be returned instead.

Parameters:

int - columnId The number of the column.

File - tempFile The File you want the data stored in. If this parameter is null you get the temporary file that was created when we unloaded the result set.

Object[] - tempRow The current Row.

Returns:

String the Value of column #columnId if it can be turned into a string.

Throws:

CSInvalidColumnIdException - if columnId is not the id of a valid column. Column numbering starts at 1.

CSNoDataInRowSetException - if there are no rows in this rowset.

CSDBInvalidDatatypeCastException - if columnId is not of a data type that can be turned into a String.

CSException - if we hit a problem retrieving the Long field. If this happens we store an Exception rather than a File. This avoids throwing Exceptions when the object is being constructed and allows the application to survive if thr failure to retrieve a Long Field which may or may not be used.

setExpireDate

public void setExpireDate(long theExpireDate)

Set how long the result will remain up to date.

Parameters:

long - theExpireDate An arbitrary expiration date expressed in 1000'ths of a second from now

getExpireDate

public java.util.Date getExpireDate()

Set how long the result will remain up to date.

Parameters:

java.util.Date - theExpireDate An arbitrary expiration date

hasExpired

public boolean hasExpired()

Set how long the result will remain up to date.

Parameters:

java.util.Date - theExpireDate An arbitrary expiration date

setTempFileSuffix

public void setTempFileSuffix(java.lang.String tempFileSuffix)

Set the suffix used for generating temporary files

getTempFileSuffix

public java.lang.String getTempFileSuffix()

Get the prefix used for generating temporary files

getWriteableRowSet

public WriteableRowSet getWriteableRowSet()

toString

public java.lang.String toString()

Return a String representation of the start of the row set

Overrides:

toString in class java.lang.Object

Returns:

A newline and colon deliminated String containing the first 30,000 characters of the ReadOnlyRowSet.

deleteGeneratedFiles

public int deleteGeneratedFiles()

Delete all files in this ReadOnlyRowSet This is a cleanup method that you can use when the underlying cursor contained one or more LOB columns and you need to explicitly remove the resulting files.

Returns:

int a count of the files deleted