interface XRow in module com::sun::star::sdbc::

(Global Index)

Syntax

interface XRow : com::sun::star::uno::XInterface ;

Description

is used to access data which is collected in a row. All methods raise a SQLException if a database access error occurs.

Method Summary

wasNull reports whether the last column read had a value of SQL NULL. Note that you must first call getXXX on a column to try to read its value and then call wasNull() to see if the value read was SQL NULL.

getString gets the value of a column in the current row as a string.

getBoolean gets the value of a column in the current row as boolean.

getByte get the value of a column in the current row as a byte.

getShort gets the value of a column in the current row as a short.

getInt get the value of a column in the current row as an integer.

getLong get the value of a column in the current row as a long.

getFloat gets the value of a column in the current row as a float.

getDouble gets the value of a column in the current row as a double.

getBytes gets the value of a column in the current row as a byte array. The bytes represent the raw values returned by the driver.

getDate gets the value of a column in the current row as a date object.

getTime gets the value of a column in the current row as a time object.

getTimestamp gets the value of a column in the current row as a datetime object.

getBinaryStream gets the value of a column in the current row as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY values.

getCharacterStream gets the value of a column in the current row as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY or LONGVARCHAR values.

getObject returns the value of a column in the current row as an object. This method uses the given Map object for the custom mapping of the SQL structure or distinct type that is being retrieved.

getRef gets a REF(<structured-type>) column value from the current row.

getBlob gets a BLOB value in the current row.

getClob gets a CLOB value in the current row of this ResultSet object.

getArray gets a SQL ARRAY value from the current row of this ResultSet object.

Known Services Which Export this Interface

com::sun::star::sdbc::CallableStatement

com::sun::star::sdbc::ResultSet

com::sun::star::ucb::ContentResultSet

Method Details



wasNull

Syntax

boolean wasNull ();
raises ( com::sun::star::sdbc::SQLException );

Description

reports whether the last column read had a value of SQL NULL. Note that you must first call getXXX on a column to try to read its value and then call wasNull() to see if the value read was SQL NULL.

Returns

true if last column read was SQL NULL and false otherwise

Throws

SQLException if a database access error occurs.

getString

Syntax

string getString (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a string.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getBoolean

Syntax

boolean getBoolean (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as boolean.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getByte

Syntax

byte getByte (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

get the value of a column in the current row as a byte.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getShort

Syntax

short getShort (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a short.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getInt

Syntax

long getInt (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

get the value of a column in the current row as an integer.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getLong

Syntax

hyper getLong (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

get the value of a column in the current row as a long.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getFloat

Syntax

float getFloat (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a float.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getDouble

Syntax

double getDouble (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a double.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getBytes

Syntax

sequence< byte > getBytes (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a byte array. The bytes represent the raw values returned by the driver.

Parameter columnIndex

the first column is 1, the second is 2, ...

Returns

the column value; if the value is SQL NULL, the result is empty.

Throws

SQLException if a database access error occurs.

getDate

Syntax

com::sun::star::util::Date getDate (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a date object.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getTime

Syntax

com::sun::star::util::Time getTime (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a time object.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getTimestamp

Syntax

com::sun::star::util::DateTime getTimestamp (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a datetime object.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getBinaryStream

Syntax

com::sun::star::io::XInputStream getBinaryStream (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY values.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return 0 when the method XInputStream::available() is called whether there is data available or not.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getCharacterStream

Syntax

com::sun::star::io::XInputStream getCharacterStream (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets the value of a column in the current row as a stream of uninterpreted bytes. The value can then be read in chunks from the stream. This method is particularly suitable for retrieving large LONGVARBINARY or LONGVARCHAR values.

Note: All the data in the returned stream must be read prior to getting the value of any other column. The next call to a get method implicitly closes the stream. Also, a stream may return 0 when the method XInputStream::available() is called whether there is data available or not.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getObject

Syntax

any getObject (
long columnIndex,
com::sun::star::container::XNameAccess typeMap )
raises ( com::sun::star::sdbc::SQLException );

Description

returns the value of a column in the current row as an object. This method uses the given Map object for the custom mapping of the SQL structure or distinct type that is being retrieved.

Parameter columnIndex

the first column is 1, the second is 2,

Parameter typeMap

the map of types which should be used to get the column value

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getRef

Syntax

com::sun::star::sdbc::XRef getRef (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets a REF(&lt;structured-type&gt;) column value from the current row.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getBlob

Syntax

com::sun::star::sdbc::XBlob getBlob (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets a BLOB value in the current row.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getClob

Syntax

com::sun::star::sdbc::XClob getClob (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets a CLOB value in the current row of this ResultSet object.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.

getArray

Syntax

com::sun::star::sdbc::XArray getArray (
long columnIndex )
raises ( com::sun::star::sdbc::SQLException );

Description

gets a SQL ARRAY value from the current row of this ResultSet object.

Parameter columnIndex

the first column is 1, the second is 2,

Returns

the column value; if the value is SQL NULL, the result is null

Throws

SQLException if a database access error occurs.
Top of Page