Class ReadOnlyRowSet

java.lang.Object

com.mcpdbwizard.pub.ReadOnlyRowSet

Direct Known Subclasses:

WriteableRowSet

public class ReadOnlyRowSet
extends Object

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

Detailed information on this class is available here

Copyright 2003-2026 ATB Consultancy Services Ltd (formerly Orinda Software Ltd, Dublin, Ireland)

Version:

7

Author:

devteam@mcpdbwizard.com

Field Summary

Fields

Modifier and Type	Field	Description
protected int	colCount	How many columns are in this ReadOnlyRowSet
protected int[]	columnDecimalPlaces	An array containing the number of decimal places of each column that makes up this ReadOnlyRowSet
protected int[]	columnJavaDatatypes	An array containing the Data Type ids of the columns that make up this ReadOnlyRowSet.
protected long[]	columnLengths	An array containing the lengths of the columns that make up this ReadOnlyRowSet.
protected String[]	columnNames	An array containing the names of the columns that make up this ReadOnlyRowSet.
protected String[]	columnOracleDatatypeNames	An array containing the Oracle Data Type names of the columns that make up this ReadOnlyRowSet.
protected int	currentRowNumber	Which row we are currently on.
protected File	downloadedFileDir	The directory where longs, clobs, etc will be stored as files.
protected Date	expireDate	When the data in this ReadOnlyRowSet will expire.
protected boolean	hitMemLimit	A flag indicating that the JVm ran low on memory.
protected boolean	hitRowLimit	A flag indicating that we stopped adding rows because we hit maxRows, the limit specified in the constructor
protected boolean	keepFiles	boolean flag that specifies whether downloaded files will automaticly be deleted when the JVM exits or not
protected boolean	keepLobs	boolean flag that specifies whether lobs such as CLOBS, BLOBS and BFILES will be kept as Oracle objects or downloaded into Files.
protected long	minimumFreeMemoryBytes	How much memory has to be available for us to continue retrieving rows from a large query.
protected LongObjectLoader	objectUnloader	object Unloader
protected ArrayList	readOnlyRowSetData	An ArrayList used for storing the data in the ReadOnlyRowSet.
protected int	rowCount	How many rows are in this ReadOnlyRowSet
protected String	tempFilePrefix	The Prefix for downloaded files containing BLOB, CLOB and BFILE data
protected String	tempFileSuffix	The Suffix for downloaded files containing BLOB, CLOB and BFILE data
protected LogInterface	theLog	An instance of the LogInterface logging mechanism
protected NumberFormat	theNumberFormat	A number formatter used by the getString methods
protected SimpleDateFormat	theTimestampFormat	String format used when converting Timestamps to Strings
protected int[]	underlyingOracleDatatypes	An Array containing ints that map to core oracle datatypes in SqlUtil.
protected boolean	useByteArraysForLongsAndLOBS	boolean flag that specifies whether lobs such as CLOBS, BLOBS and BFILES and LONG columns will be kept as byte arrays.

Constructor Summary

Constructors

Constructor	Description
ReadOnlyRowSet(Object[] theData, String[] columnNames, String[] columnOracleDatatypeNames, int[] underlyingOracleDatatypes, int[] columnJavaDatatypes, long[] columnLengths, int[] columnDecimalPlaces, LogInterface theLog, File downloadedFileDir, boolean keepFiles)	Create a ReadOnlyRowSet that is based on user defined data rather than a ResultSet.
ReadOnlyRowSet(ResultSet theResultSet, String theQuery, int maxRows, LogInterface theLog)	Create a ReadOnlyRowSet that is based on a ResultSet.
ReadOnlyRowSet(ResultSet theResultSet, String theQuery, int maxRows, LogInterface theLog, File downloadedFileDir, boolean keepFiles, String tempFilePrefix, String tempFileSuffix)	Create a ReadOnlyRowSet that is based on a ResultSet.
ReadOnlyRowSet(ResultSet theResultSet, String theQuery, int maxRows, LogInterface theLog, File downloadedFileDir, boolean keepFiles, String tempFilePrefix, String tempFileSuffix, boolean keepLobs)	Create a ReadOnlyRowSet that is based on a ResultSet.
ReadOnlyRowSet(ResultSet theResultSet, String theQuery, int maxRows, LogInterface theLog, File downloadedFileDir, boolean keepFiles, String tempFilePrefix, String tempFileSuffix, boolean keepLobs, boolean useByteArraysForLongsAndLOBS)	Create a ReadOnlyRowSet that is based on a ResultSet.

Method Summary

Modifier and Type	Method	Description
boolean	checkColumnName(String theColumnName)	Make sure that theColumnName is a valid column.
protected void	checkRange(int columnId)	Make sure that columnId is a valid column.
protected void	checkRows()	Make sure that we have rows.
protected String	convertNumberToString(Object theNumberObject, NumberFormat theNumberFormat)	Utility method that will try to turn theNumberObject into a String.
protected Date	convertTIMESTAMPLTZToDate(Object theTIMESTAMPLTZObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPObject into a Date object.
protected String	convertTIMESTAMPLTZToString(Object theTIMESTAMPLTZObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPLTZObject into a oracle.sql.TIMESTAMPLTZ object and then a String.
protected Timestamp	convertTIMESTAMPLTZToTimestamp(Object theTIMESTAMPLTZObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPObject into a Date object.
protected Date	convertTIMESTAMPToDate(Object theTIMESTAMPObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPObject into a Date object.
protected String	convertTimestampToString(Object theDateObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theDateObject into a Date object and then a String.
protected String	convertTIMESTAMPToString(Object theTIMESTAMPObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPObject into a oracle.sql.TIMESTAMP object and then a String.
protected Timestamp	convertTIMESTAMPToTimestamp(Object theTIMESTAMPObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPObject into a Date object.
protected Date	convertTIMESTAMPTZToDate(Object theTIMESTAMPTZObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPTZObject into a oracle.sql.TIMESTAMPTZ object and then a String.
protected String	convertTIMESTAMPTZToString(Object theTIMESTAMPTZObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPTZObject into a oracle.sql.TIMESTAMPTZ object and then a String.
protected Timestamp	convertTIMESTAMPTZToTimestamp(Object theTIMESTAMPTZObject, SimpleDateFormat theTimestampFormat)	Utility method that will try to turn theTIMESTAMPObject into a Date object.
protected void	createInvalidDatatypeCastException(String theCastedoracleDatatype, String theCasteeJavaDatatype, String oracleColumnName)
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(String theColumnName)	Get column columnId as a oracle.sql.BFILE Object This method will only work if 'keepLobs' was set to true.
BigDecimal	getBigDecimal(int columnId)	Get column columnId as a java.math.BigDecimal Object
BigDecimal	getBigDecimal(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(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(String theColumnName)	Get column columnId as a boolean.
Boolean	getBooleanObj(int columnId)	Get column columnId as a Boolean Object
Boolean	getBooleanObj(String theColumnName)	Get column columnId as a Boolean Object
byte	getByte(int columnId)	Get column columnId as a byte.
byte	getByte(String theColumnName)	Get column columnId as a byte.
byte[]	getByteArray(int columnId)	Get column columnId as a byte[] Object
byte[]	getByteArray(String theColumnName)	Get column columnId as a byte[] Object
Byte	getByteObj(int columnId)	Get column columnId as a Byte Object
Byte	getByteObj(String theColumnName)	Get column columnId as a Byte Object
char[]	getCharArray(int columnId)	Get column columnId as a char[] Object
char[]	getCharArray(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(String theColumnName)	Get column columnId as a oracle.sql.CLOB Object This method will only work if 'keepLobs' was set to true.
int	getColumnId(String theColumnName)	Get the position of a named column in rows of the underlying result set.
String	getColumnName(int theColumnId)	Get the name of a column.
String	getColumnNamesAsString(String delimiter)	Return the row's column names in the form of a delimited string
String[]	getColumnNamesAsStringArray()	Return the row's column names in the form of a string Array
String[]	getColumnOracleDatatypeNames()	Return the Oracle data types of the the columns as an array of String
Object[]	getCurrentRow()	Return current row as an array of Object
int	getCurrentRowNumber()	Return the current row number
Date	getDate(int columnId)	Get column columnId as a java.sql.Date
Date	getDate(String theColumnName)	Get column columnId as a java.sql.Date
double	getDouble(int columnId)	Get column columnId as a double.
double	getDouble(String theColumnName)	Get column columnId as a double.
Double	getDoubleObj(int columnId)	Get column columnId as a Double Object
Double	getDoubleObj(String theColumnName)	Get column columnId as a Double Object
Date	getExpireDate()	Set how long the result will remain up to date.
File	getFile(int columnId, File outputFile)	Get a long text or binary column columnId as a File
File	getFile(String theColumnName, File outputFile)	Get a long text or binary column columnId as a File
float	getFloat(int columnId)	Get column columnId as a float.
float	getFloat(String theColumnName)	Get column columnId as a float.
Float	getFloatObj(int columnId)	Get column columnId as a Float Object
Float	getFloatObj(String theColumnName)	Get column columnId as a Float Object
int	getInt(int columnId)	Get column columnId as an int.
int	getInt(String theColumnName)	Get column columnId as an int.
Integer	getIntegerObj(int columnId)	Get column columnId as a Integer Object
Integer	getIntegerObj(String theColumnName)	Get column columnId as a Integer Object
oracle.sql.json.OracleJsonValue	getJSON(int columnId)	Get column columnId as an oracle.sql.json.OracleJsonValue.
oracle.sql.json.OracleJsonValue	getJSON(String theColumnName)	Get column theColumnName as an oracle.sql.json.OracleJsonValue.
long	getLong(int columnId)	Get column columnId as a long.
long	getLong(String theColumnName)	Get column columnId as a long.
Long	getLongObj(int columnId)	Get column columnId as a Long Object
Long	getLongObj(String theColumnName)	Get column columnId as a Long Object
Object	getObject(int columnId)	Get column columnId as an Object.
Object	getObject(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(String theColumnName)	Get column columnId as an oracle.sql.OPAQUE.
String	getRowAsString(String delimiter, 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(String theColumnName)	Get column columnId as a short.
Short	getShortObj(int columnId)	Get column columnId as a Short Object
Short	getShortObj(String theColumnName)	Get column columnId as a Short Object
String	getString(int columnId)	Get column columnId as a String.
String	getString(String theColumnName)	Get column columnId as a String.
String	getTempFileSuffix()	Get the prefix used for generating temporary files
Timestamp	getTimestamp(int columnId)	Get column columnId as a java.sql.Timestamp
Timestamp	getTimestamp(String theColumnName)	Get column columnId as a java.sql.Timestamp
oracle.sql.TIMESTAMP	getTIMESTAMP(int columnId)	Get column columnId as a TIMESTAMP Object
oracle.sql.TIMESTAMP	getTIMESTAMP(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(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(String theColumnName)	Get column columnId as a oracle.sql.TIMESTAMPTZ Object
double[]	getVector(int columnId)	Get column columnId as a double[] vector.
double[]	getVector(String theColumnName)	Get column theColumnName as a double[] vector.
byte[]	getVectorBinary(int columnId)	Get column columnId as a byte[] binary vector.
byte[]	getVectorBinary(String theColumnName)	Get column theColumnName as a byte[] binary vector.
SparseVector	getVectorSparse(int columnId)	Get column columnId as a SparseVector (a sparse VECTOR, Oracle 23ai).
SparseVector	getVectorSparse(String theColumnName)	Get column theColumnName as a SparseVector (a sparse VECTOR, Oracle 23ai).
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(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.
void	retainShallowestByIntColumn(String colName)	Keep only the rows whose integer column colName equals the MINIMUM value of that column across all current rows; drop the rest.
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(NumberFormat newNumberFormat)	Change the way Numbers are converted to Strings
void	setTempFileSuffix(String tempFileSuffix)	Set the suffix used for generating temporary files
void	setTimestampFormat(String newTimestampFormat)	Change the way Timestamps are converted to Strings
int	size()	Return the number of rows
String	toString()	Return a String representation of the start of the row set
protected Object	unloadObject(ResultSet theResultSet, int columnId, int oracleUnderlyingDatatype, boolean keepFiles)	Convert the object returned by the resultset into one we can use.
int	width()	Return the number of columns

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

theTimestampFormat

protected SimpleDateFormat theTimestampFormat

String format used when converting Timestamps to Strings

theNumberFormat

protected NumberFormat theNumberFormat

A number formatter used by the getString methods

colCount

protected int colCount

How many columns are in this ReadOnlyRowSet

rowCount

protected int rowCount

How many rows are in this ReadOnlyRowSet

currentRowNumber

protected int currentRowNumber

Which row we are currently on. The row number starts at 0. A value of -1 indicates no rows.

hitRowLimit

protected boolean hitRowLimit

A flag indicating that we stopped adding rows because we hit maxRows, the limit specified in the constructor

minimumFreeMemoryBytes

protected long minimumFreeMemoryBytes

How much memory has to be available for us to continue retrieving rows from a large query. The default value is 1M.. If free memory gets this low then it is probably because the JVM can't allocate any more.

hitMemLimit

protected boolean hitMemLimit

A flag indicating that the JVm ran low on memory.

Since:

6.0.2615 hitMemLimit no longer stops query being read.

columnNames

protected String[] columnNames

An array containing the names of the columns that make up this ReadOnlyRowSet. It is possible that the same name may appear more than once.

columnOracleDatatypeNames

protected String[] columnOracleDatatypeNames

An array containing the Oracle Data Type names of the columns that make up this ReadOnlyRowSet.

underlyingOracleDatatypes

protected int[] underlyingOracleDatatypes

An Array containing ints that map to core oracle datatypes in SqlUtil.

columnJavaDatatypes

protected int[] columnJavaDatatypes

An array containing the Data Type ids of the columns that make up this ReadOnlyRowSet. The ids match those specified in java.sql.Types

See Also:

• Types

columnLengths

protected long[] columnLengths

An array containing the lengths of the columns that make up this ReadOnlyRowSet.

We need to use a long as CLOBS and BLOBS can be 4GB in length.

columnDecimalPlaces

protected int[] columnDecimalPlaces

An array containing the number of decimal places of each column that makes up this ReadOnlyRowSet

readOnlyRowSetData

protected ArrayList readOnlyRowSetData

An ArrayList used for storing the data in the ReadOnlyRowSet. Each entry contains an Object array that holds the data for each row.

theLog

protected LogInterface theLog

An instance of the LogInterface logging mechanism

See Also:

• LogInterface

downloadedFileDir

protected File downloadedFileDir

The directory where longs, clobs, etc will be stored as files. It is recommended that you have one per JVM at an absolute minimum. One per session is better.

expireDate

protected Date expireDate

When the data in this ReadOnlyRowSet will expire.

This is used by the caching mechanism to determine when we the data has reached its sell by date and needs to be refreshed.

tempFilePrefix

protected String tempFilePrefix

The Prefix for downloaded files containing BLOB, CLOB and BFILE data

tempFileSuffix

protected String tempFileSuffix

The Suffix for downloaded files containing BLOB, CLOB and BFILE data

keepFiles

protected boolean keepFiles

boolean flag that specifies whether downloaded files will automaticly be deleted when the JVM exits or not

keepLobs

protected boolean keepLobs

boolean flag that specifies whether lobs such as CLOBS, BLOBS and BFILES will be kept as Oracle objects or downloaded into Files.

Since:

2.0.1505

useByteArraysForLongsAndLOBS

protected boolean useByteArraysForLongsAndLOBS

boolean flag that specifies whether lobs such as CLOBS, BLOBS and BFILES and LONG columns will be kept as byte arrays. This only works if keepFiles == false.

Since:

5.0.2314

objectUnloader

protected LongObjectLoader objectUnloader

object Unloader

Constructor Details

ReadOnlyRowSet

public ReadOnlyRowSet(Object[] theData,
 String[] columnNames,
 String[] columnOracleDatatypeNames,
 int[] underlyingOracleDatatypes,
 int[] columnJavaDatatypes,
 long[] columnLengths,
 int[] columnDecimalPlaces,
 LogInterface theLog,
 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:

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.

columnNames -

columnOracleDatatypeNames -

underlyingOracleDatatypes -

columnJavaDatatypes -

theLog -

downloadedFileDir - A directory to keep files containing clobs and blobs

ReadOnlyRowSet

public ReadOnlyRowSet(ResultSet theResultSet,
 String theQuery,
 int maxRows,
 LogInterface theLog)
               throws CSException

Create a ReadOnlyRowSet that is based on a ResultSet.

Parameters:

theResultSet -

theQuery -

maxRows -

theLog -

Throws:

CSException

ReadOnlyRowSet

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

Create a ReadOnlyRowSet that is based on a ResultSet.

Parameters:

theResultSet -

theQuery -

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

theLog -

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

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

tempFilePrefix - Prefix for generated temporary files.

tempFileSuffix - Suffix for generated temporary files.

Throws:

CSException

ReadOnlyRowSet

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

Create a ReadOnlyRowSet that is based on a ResultSet.

Parameters:

theResultSet -

theQuery -

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

theLog -

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

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

tempFilePrefix - Prefix for generated temporary files.

tempFileSuffix - Suffix for generated temporary files.

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

Throws:

CSException

Since:

2.0.1505 'keepLobs' added., 5.0.2314 default for 'useByteArraysForLongsAndLOBS' added.

ReadOnlyRowSet

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

Create a ReadOnlyRowSet that is based on a ResultSet.

Parameters:

theResultSet -

theQuery -

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

theLog -

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

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

tempFilePrefix - Prefix for generated temporary files.

tempFileSuffix - Suffix for generated temporary files.

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

Throws:

CSException

Since:

2.0.1505 'keepLobs' added., 5.0.2314 'useByteArraysForLongsAndLOBS' added., 6.0.2615 hitMemLimit no longer stops query being read.

Method Details

getColumnId

public int getColumnId(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:

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

Returns:

An int which identifies the first occurance of columnName -1 If no match is made.

retainShallowestByIntColumn

public void retainShallowestByIntColumn(String colName)

Keep only the rows whose integer column colName equals the MINIMUM value of that column across all current rows; drop the rest. Operates in place (rebuilds the backing row list and resets the cursor to the first row).

Used by the generator to reduce a PL/SQL record's argument rowset to its DIRECT fields (shallowest DATA_LEVEL), dropping the deeper rows that belong to nested records/types -- those are generated from their own, separately-built classes. A no-op when every row already shares the same value (e.g. a flat record: byte-identical output). Non-integer / null values in the column are treated as the minimum (never dropped).

Parameters:

colName - the integer column to key on (typically "DATA_LEVEL")

getColumnName

public String getColumnName(int theColumnId)
                     throws CSInvalidColumnIdException

Get the name of a column.

Return the Name of the value in columnNames that for theColumnId.

Parameters:

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.

unloadObject

protected Object unloadObject(ResultSet theResultSet,
 int columnId,
 int oracleUnderlyingDatatype,
 boolean keepFiles)

Convert the object returned by the resultset into one we can use.

Parameters:

theResultSet - We need this as we may have to cast it to OracleResultSet.

columnId - Which column we want to get.

oracleUnderlyingDatatype - The underlying oracle datatype. We pass it in to avoid having to find out what it is twice.

keepFiles - Whether any Files generated by retrieving Lobs should be kept when the program finishes. The default behaviour is to delete them.

Returns:

null If the column is null or a zero-length Long field. String If the column is a text string of some kind. java.sql.Timestamp If the column is a Date field. BigDecimal If the column is a number field. File If the column is a valid Long object with a length > 0. Exception If something went wrong, Usually with a BFILE retrieval.

Since:

4.0.1794 DATE Columns are now explicitly casted to java.sql.TimeStamp., 5.0.2314 A value of true for useByteArraysForLongsAndLOBS will lead to downloaded LONG and LOB columns being stored in byte arrays.

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. boolean false if we did not reach 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. boolean false if we did not reach 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:

newCurrentRowNumber - the new row number.

Returns:

true if newCurrentRowNumber is a valid row false if newCurrentRowNumber is less than zero or higher than size() - 1.

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 Date getDate(String theColumnName)
             throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a java.sql.Date

Parameters:

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 Date getDate(int columnId)
             throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a java.sql.Date

Parameters:

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 Timestamp getTimestamp(String theColumnName)
                       throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a java.sql.Timestamp

Parameters:

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 Timestamp getTimestamp(int columnId)
                       throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a java.sql.Timestamp

Parameters:

columnId - 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(String theColumnName)
               throws CSInvalidColumnIdException,
CSNoDataInRowSetException

Return true if the column is null.

Parameters:

theColumnName - The name of the column

Returns:

true is this column is null false is this column is not 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:

columnId - The column Id

Returns:

true is this column is null false is this column is not null

Throws:

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

CSNoDataInRowSetException - If there are no rows.

getBooleanObj

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

Get column columnId as a Boolean Object

Parameters:

theColumnName - The name of the column

Returns:

true If the underlying column is a number with a value of zero. false If the underlying column is a number with a value of zero. true If the underlying column is a String with a value of "Y","y","T" or "t". false If the underlying column is a number with a value of "N","n","F","f",""

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 Boolean getBooleanObj(int columnId)
                      throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Boolean Object

Parameters:

columnId - The number of the column.

Returns:

true If the underlying column is a number with a value of zero. false If the underlying column is a number with a value of zero. true If the underlying column is a String with a value of "Y","y","T" or "t". false If the underlying column is a number with a value of "N","n","F","f",""

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(String theColumnName)
                                  throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.TIMESTAMP Object

Parameters:

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:

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(String theColumnName)
                                      throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.TIMESTAMPTZ Object

Parameters:

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:

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(String theColumnName)
                                        throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a oracle.sql.TIMESTAMPLTZ Object

Parameters:

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:

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(String theColumnName)
                   throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSAttemptToGetNullException

Get column columnId as a boolean.

Parameters:

theColumnName - The name of the column

Returns:

true If the underlying column is a number with a value of zero. false If the underlying column is a number with a value of zero. true If the underlying column is a String with a value of "Y","y","T" or "t". false If the underlying column is a number with a value of "N","n","F","f",""

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:

columnId - The number of the column.

Returns:

true If the underlying column is a number with a value of zero. false If the underlying column is a number with a value of zero. true If the underlying column is a String with a value of "Y","y","T" or "t". false If the underlying column is a number with a value of "N","n","F","f",""

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 Byte getByteObj(String theColumnName)
                throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Byte Object

Parameters:

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 Byte getByteObj(int columnId)
                throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Byte Object

Parameters:

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(String theColumnName)
             throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSAttemptToGetNullException

Get column columnId as a byte.

Parameters:

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:

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 Short getShortObj(String theColumnName)
                  throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Short Object

Parameters:

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 Short getShortObj(int columnId)
                  throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Short Object

Parameters:

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(String theColumnName)
               throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSAttemptToGetNullException

Get column columnId as a short.

Parameters:

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:

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 Integer getIntegerObj(String theColumnName)
                      throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Integer Object

Parameters:

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 Integer getIntegerObj(int columnId)
                      throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Integer Object

Parameters:

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(String theColumnName)
           throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSAttemptToGetNullException

Get column columnId as an int.

Parameters:

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:

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 Long getLongObj(String theColumnName)
                throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Long Object

Parameters:

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 Long getLongObj(int columnId)
                throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Long Object

Parameters:

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(String theColumnName)
             throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSAttemptToGetNullException

Get column columnId as a long.

Parameters:

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:

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 Float getFloatObj(String theColumnName)
                  throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Float Object

Parameters:

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 Float getFloatObj(int columnId)
                  throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Float Object

Parameters:

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(String theColumnName)
               throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSAttemptToGetNullException

Get column columnId as a float.

Parameters:

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:

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 Double getDoubleObj(String theColumnName)
                    throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Double Object

Parameters:

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 Double getDoubleObj(int columnId)
                    throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a Double Object

Parameters:

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(String theColumnName)
                 throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSAttemptToGetNullException

Get column columnId as a double.

Parameters:

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:

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 BigDecimal getBigDecimal(String theColumnName)
                         throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a java.math.BigDecimal Object

Parameters:

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 BigDecimal getBigDecimal(int columnId)
                         throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a java.math.BigDecimal Object

Parameters:

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 String getString(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:

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 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:

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(String theColumnName)
                    throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSUnsupportedDatatypeException

Get column columnId as a char[] Object

Parameters:

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.

CSUnsupportedDatatypeException

Since:

v6.0.2770

getCharArray

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

Get column columnId as a char[] Object

Parameters:

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.

CSUnsupportedDatatypeException

Since:

v6.0.2770

getByteArray

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

Get column columnId as a byte[] Object

Parameters:

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.

CSUnsupportedDatatypeException

getByteArray

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

Get column columnId as a byte[] Object

Parameters:

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.

CSUnsupportedDatatypeException

getObject

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

Get column columnId as an Object.

Parameters:

theColumnName - 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 Object getObject(int columnId)
                 throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSUnsupportedDatatypeException

Get column columnId as an Object.

Parameters:

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(String theColumnName)
                            throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException,
CSUnsupportedDatatypeException

Get column columnId as an oracle.sql.OPAQUE.

Parameters:

theColumnName - 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:

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 String getRowAsString(String delimiter,
 String unprintableFieldMessage)
                      throws CSNoDataInRowSetException

Return the entire row in the form of a delimited string

Parameters:

delimiter - a delimiter such as ":"

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 String getColumnNamesAsString(String delimiter)

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

Parameters:

delimiter - a delimiter such as ":"

getColumnNamesAsStringArray

public String[] getColumnNamesAsStringArray()

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

Returns:

String[]

getColumnOracleDatatypeNames

public String[] getColumnOracleDatatypeNames()

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

Returns:

String[]

Since:

V5.0.2177

checkRange

protected void checkRange(int columnId)
                   throws CSInvalidColumnIdException

Make sure that columnId is a valid column.

Parameters:

columnId - The Id of a supposedly valid column

Throws:

CSInvalidColumnIdException - in advance to prevent ArrayIndexOutOfBoundsException later.

checkColumnName

public boolean checkColumnName(String theColumnName)

Make sure that theColumnName is a valid column.

Parameters:

theColumnName - The name of a supposedly valid column

Returns:

true if we can match this column name to a column true otherwise

checkRows

protected void checkRows()
                  throws CSNoDataInRowSetException

Make sure that we have rows.

Throws:

CSNoDataInRowSetException - if we don't have any rows.

setTimestampFormat

public void setTimestampFormat(String newTimestampFormat)

Change the way Timestamps are converted to Strings

Parameters:

newTimestampFormat -

setNumberFormat

public void setNumberFormat(NumberFormat newNumberFormat)

Change the way Numbers are converted to Strings

Parameters:

newNumberFormat -

getCurrentRow

public 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.

convertTimestampToString

protected String convertTimestampToString(Object theDateObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theDateObject into a Date object and then a String.

Parameters:

theDateObject - An object which is supposed to be an instance of java.sql.Date or java.sql.Timestamp

theTimestampFormat - The date/time format we are using.

Returns:

String A date formatted into a string.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMP

convertTIMESTAMPToString

protected String convertTIMESTAMPToString(Object theTIMESTAMPObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPObject into a oracle.sql.TIMESTAMP object and then a String.

Parameters:

theTIMESTAMPObject - An object which is supposed to be an instance of oracle.sql.TIMESTAMP

theTimestampFormat - The date/time format we are using.

Returns:

String A date formated into a string.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMP

convertTIMESTAMPToDate

protected Date convertTIMESTAMPToDate(Object theTIMESTAMPObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPObject into a Date object.

Parameters:

theTIMESTAMPObject - An object which is supposed to be an instance of oracle.sql.TIMESTAMP

theTimestampFormat - The date/time format we are using.

Returns:

Date A date.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMP

convertTIMESTAMPToTimestamp

protected Timestamp convertTIMESTAMPToTimestamp(Object theTIMESTAMPObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPObject into a Date object.

Parameters:

theTIMESTAMPObject - An object which is supposed to be an instance of oracle.sql.TIMESTAMP

theTimestampFormat - The date/time format we are using.

Returns:

Date A date.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMP

convertTIMESTAMPTZToTimestamp

protected Timestamp convertTIMESTAMPTZToTimestamp(Object theTIMESTAMPTZObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPObject into a Date object.

Parameters:

theTIMESTAMPTZObject - An object which is supposed to be an instance of oracle.sql.TIMESTAMP

theTimestampFormat - The date/time format we are using.

Returns:

Date A date.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMP

convertTIMESTAMPLTZToTimestamp

protected Timestamp convertTIMESTAMPLTZToTimestamp(Object theTIMESTAMPLTZObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPObject into a Date object.

Parameters:

theTIMESTAMPLTZObject - object which is supposed to be an instance of oracle.sql.TIMESTAMP

theTimestampFormat - The date/time format we are using.

Returns:

Date A date.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMP

convertTIMESTAMPLTZToDate

protected Date convertTIMESTAMPLTZToDate(Object theTIMESTAMPLTZObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPObject into a Date object.

Parameters:

theTIMESTAMPLTZObject - An object which is supposed to be an instance of oracle.sql.TIMESTAMP

theTimestampFormat - The date/time format we are using.

Returns:

Date A date.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMP

convertTIMESTAMPTZToString

protected String convertTIMESTAMPTZToString(Object theTIMESTAMPTZObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPTZObject into a oracle.sql.TIMESTAMPTZ object and then a String.

Parameters:

theTIMESTAMPTZObject - An object which is supposed to be an instance of oracle.sql.TIMESTAMPTZ

theTimestampFormat - The date/time format we are using.

Returns:

String A date formated into a string.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMPTZ

convertTIMESTAMPTZToDate

protected Date convertTIMESTAMPTZToDate(Object theTIMESTAMPTZObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPTZObject into a oracle.sql.TIMESTAMPTZ object and then a String.

Parameters:

theTIMESTAMPTZObject - An object which is supposed to be an instance of oracle.sql.TIMESTAMPTZ

theTimestampFormat - The date/time format we are using.

Returns:

String A date formated into a string.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMPTZ

convertTIMESTAMPLTZToString

protected String convertTIMESTAMPLTZToString(Object theTIMESTAMPLTZObject,
 SimpleDateFormat theTimestampFormat)

Utility method that will try to turn theTIMESTAMPLTZObject into a oracle.sql.TIMESTAMPLTZ object and then a String.

Parameters:

theTIMESTAMPLTZObject - An object which is supposed to be an instance of oracle.sql.TIMESTAMPLTZ

theTimestampFormat - The date/time format we are using.

Returns:

String A date formated into a string.

See Also:

• LogInterface.DEFAULT_TIME_FORMAT_STRING
• Date
• Timestamp
• TIMESTAMPLTZ

convertNumberToString

protected String convertNumberToString(Object theNumberObject,
 NumberFormat theNumberFormat)
                                throws CSDBInvalidDatatypeCastException

Utility method that will try to turn theNumberObject into a String.

This method used the current Number Format to convert a number field to A String.

Parameters:

theNumberObject - An object which is supposed to be an instance of java.sql.Date or java.sql.Timestamp

theNumberFormat - A Valid number format

Returns:

String A Number formatted into a string.

Throws:

CSDBInvalidDatatypeCastException

See Also:

• NumberFormat

getBFILE

public oracle.sql.BFILE getBFILE(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:

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:

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(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:

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:

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(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:

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:

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

getJSON

public oracle.sql.json.OracleJsonValue getJSON(String theColumnName)
                                        throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column theColumnName as an oracle.sql.json.OracleJsonValue.

For native JSON columns (Oracle 21c+). The returned value can be navigated as an OracleJsonObject / OracleJsonArray, or rendered back to JSON text with getString(int) / toString().

Parameters:

theColumnName - The name of the column

Returns:

oracle.sql.json.OracleJsonValue the value of the column, or null.

Throws:

CSInvalidColumnIdException - if theColumnName is not a valid column.

CSDBInvalidDatatypeCastException - if the column is not a JSON column.

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

Oracle 21c

getJSON

public oracle.sql.json.OracleJsonValue getJSON(int columnId)
                                        throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as an oracle.sql.json.OracleJsonValue.

Parameters:

columnId - The number of the column.

Returns:

oracle.sql.json.OracleJsonValue the value of the column, or null.

Throws:

CSInvalidColumnIdException - if columnId is out of range.

CSDBInvalidDatatypeCastException - if the column is not a JSON column.

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

Oracle 21c

getVector

public double[] getVector(String theColumnName)
                   throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column theColumnName as a double[] vector.

For VECTOR columns (Oracle 23ai). FLOAT32 / FLOAT64 / INT8 storage is converted to double by the driver.

Parameters:

theColumnName - The name of the column

Returns:

double[] the vector value of the column, or null.

Throws:

CSInvalidColumnIdException - if theColumnName is not a valid column.

CSDBInvalidDatatypeCastException - if the column is not a VECTOR column.

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

Oracle 23ai

getVector

public double[] getVector(int columnId)
                   throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a double[] vector.

Parameters:

columnId - The number of the column.

Returns:

double[] the vector value of the column, or null.

Throws:

CSInvalidColumnIdException - if columnId is out of range.

CSDBInvalidDatatypeCastException - if the column is not a VECTOR column.

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

Oracle 23ai

getVectorBinary

public byte[] getVectorBinary(String theColumnName)
                       throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column theColumnName as a byte[] binary vector.

For binary (bit-packed) VECTOR columns (Oracle 23ai): VECTOR(n, BINARY) stores n bits as n/8 bytes, which the driver cannot represent as a double[]. Distinct from getVector(String) (dense FLOAT32/FLOAT64/INT8 vectors, read as double[]).

Parameters:

theColumnName - The name of the column

Returns:

byte[] the binary vector value of the column, or null.

Throws:

CSInvalidColumnIdException - if theColumnName is not a valid column.

CSDBInvalidDatatypeCastException - if the column is not a binary VECTOR column.

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

Oracle 23ai

getVectorBinary

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

Get column columnId as a byte[] binary vector.

Parameters:

columnId - The number of the column.

Returns:

byte[] the binary vector value of the column, or null.

Throws:

CSInvalidColumnIdException - if columnId is out of range.

CSDBInvalidDatatypeCastException - if the column is not a binary VECTOR column.

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

Oracle 23ai

getVectorSparse

public SparseVector getVectorSparse(String theColumnName)
                             throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column theColumnName as a SparseVector (a sparse VECTOR, Oracle 23ai).

Parameters:

theColumnName - The name of the column

Returns:

the sparse vector value, or null

Throws:

CSInvalidColumnIdException - if theColumnName is not a valid column.

CSDBInvalidDatatypeCastException - if the column is not a sparse VECTOR column.

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

Oracle 23ai

getVectorSparse

public SparseVector getVectorSparse(int columnId)
                             throws CSInvalidColumnIdException,
CSNoDataInRowSetException,
CSDBInvalidDatatypeCastException

Get column columnId as a SparseVector (a sparse VECTOR, Oracle 23ai). The sparse structure is preserved (not densified) — see the VECTOR unload in the row loader.

Parameters:

columnId - The number of the column.

Returns:

the sparse vector value, or null

Throws:

CSInvalidColumnIdException - if columnId is out of range.

CSDBInvalidDatatypeCastException - if the column is not a sparse VECTOR column.

CSNoDataInRowSetException - if there are no rows in this rowset.

Since:

Oracle 23ai

getFile

public File getFile(String theColumnName,
 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:

theColumnName - The name of the column

outputFile - 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.

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 File getFile(int columnId,
 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:

columnId - The number of the column.

outputFile - 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.

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.

createInvalidDatatypeCastException

protected void createInvalidDatatypeCastException(String theCastedoracleDatatype,
 String theCasteeJavaDatatype,
 String oracleColumnName)
                                           throws CSDBInvalidDatatypeCastException

Throws:

CSDBInvalidDatatypeCastException

getExpireDate

public Date getExpireDate()

Set how long the result will remain up to date.

setExpireDate

public void setExpireDate(long theExpireDate)

Set how long the result will remain up to date.

Parameters:

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

hasExpired

public boolean hasExpired()

Set how long the result will remain up to date.

getTempFileSuffix

public String getTempFileSuffix()

Get the prefix used for generating temporary files

setTempFileSuffix

public void setTempFileSuffix(String tempFileSuffix)

Set the suffix used for generating temporary files

getWriteableRowSet

public WriteableRowSet getWriteableRowSet()

toString

public String toString()

Return a String representation of the start of the row set

Overrides:

toString in class 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