Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: sdbc ::
interface XRow
Description is used to access data which is collected in a row. All methods raise a SQLException if a database access error occurs. Developers Guide Database - Using the getXXX Methods

Methods' 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(&lt;structured-type&gt;) 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.

Methods' Details
wasNull
boolean
wasNull()
raises( | 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
string
getString( | [in] long | columnIndex )
raises( | 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
boolean
getBoolean( | [in] long | columnIndex )
raises( | 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
byte
getByte( | [in] long | columnIndex )
raises( | 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
short
getShort( | [in] long | columnIndex )
raises( | 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
long
getInt( | [in] long | columnIndex )
raises( | 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
hyper
getLong( | [in] long | columnIndex )
raises( | 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
float
getFloat( | [in] long | columnIndex )
raises( | 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
double
getDouble( | [in] long | columnIndex )
raises( | 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
sequence< byte >
getBytes( | [in] long | columnIndex )
raises( | 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
::com::sun::star::util::Date
getDate( | [in] long | columnIndex )
raises( | 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
::com::sun::star::util::Time
getTime( | [in] long | columnIndex )
raises( | 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
::com::sun::star::util::DateTime
getTimestamp( | [in] long | columnIndex )
raises( | 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
::com::sun::star::io::XInputStream
getBinaryStream( | [in] long | columnIndex )
raises( | 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 ::com::sun::star::io::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
::com::sun::star::io::XInputStream
getCharacterStream( | [in] long | columnIndex )
raises( | 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 ::com::sun::star::io::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
any
getObject( | [in] long | columnIndex,
| [in] ::com::sun::star::container::XNameAccess | typeMap )
raises( | 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
XRef
getRef( | [in] long | columnIndex )
raises( | 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
XBlob
getBlob( | [in] long | columnIndex )
raises( | 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
XClob
getClob( | [in] long | columnIndex )
raises( | 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
XArray
getArray( | [in] long | columnIndex )
raises( | 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

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.