Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

service ResultSet
Description
provides access to a table of data. A ResultSet object is usually generated by executing a Statement.

A ResultSet maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The 'next' method moves the cursor to the next row.

The getXXX methods retrieve column values for the current row. You can retrieve values using either the index number of the column. Columns are numbered from 1.

For maximum portability, ResultSet columns within each row should be read in left-to-right order and each column should be read only once.

For the getXXX methods, the SDBC driver attempts to convert the underlying data to the specified type and returns a suitable value.

Column names used as input to the findColumn method are case insensitive. When several columns have the same name, then the value of the first matching column will be returned. The column name option is designed to be used when column names are used in the SQL query. For columns that are NOT explicitly named in the query, it is best to use column numbers. If column names are used, there is no way for the programmer to guarantee that they actually refer to the intended columns.

A ResultSet is automatically closed (disposed) by the Statement that generated it when that Statement is closed, re-executed, or used to retrieve the next result from a sequence of multiple results.

The number, types, and properties of a ResultSet's columns are provided by the ResultSetMetaData object returned by the getMetaData method.

Developers Guide
Database - Result Sets

Exported Interfaces - Summary
::com::sun::star::lang::XComponent

optional for implementation; controls the releasing of resources and the notification of registered listeners. (details)

XCloseable

freeing all resources of a result set. (details)

::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
XWarningsSupplier

controls the chaining of warnings, which may occur on every call to the connected database. (details)

XResultSetMetaDataSupplier

provides the access to the result set description.

XResultSet

is the interface for navigating on the rows on a result set.

XResultSetUpdate

is the interface for updating row data to the database. (details)

XRow

is the interface for accessing the data of the current row.

XColumnLocate

is used for locating a column by it's name.

XRowUpdate

is the interface for updating the data of the current row. (details)

Properties' Summary
[ readonly ] string
CursorName
[ OPTIONAL ]
defines the SQL cursor name that will be used by subsequent Statement execute methods.  
[ readonly ] long
ResultSetConcurrency
retrieves the result set concurrency.  
[ readonly ] long
ResultSetType
determines the result set type.  
long
FetchDirection
retrieves the direction for fetching rows from database tables that is the default for result sets generated from this ::com::sun::star::sdbcx::Statement object.
If this Statement object has not set a fetch direction, the return value is implementation-specific.  
long
FetchSize
retrieves the number of result set rows that is the default fetch size for result sets generated from this ::com::sun::star::sdbcx::Statement object.
If this ::com::sun::star::sdbcx::Statement object has not set a fetch size, the return value is implementation-specific.  
Exported Interfaces - Details
::com::sun::star::lang::XComponent
Usage Restrictions
optional
Description
optional for implementation; controls the releasing of resources and the notification of registered listeners.
XCloseable
Usage Restrictions
optional
Description
freeing all resources of a result set.

The creating statement will still be open after disposing.

This interface is mandatory only for JDBC conformance, otherwise it is optional.

::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
XWarningsSupplier
Usage Restrictions
optional
Description
controls the chaining of warnings, which may occur on every call to the connected database.

Chained warnings from previous calls will be cleared before processing a new call.

This interface is mandatory only for JDBC conformance, otherwise it is optional.

XResultSetMetaDataSupplier
Description
provides the access to the result set description.
XResultSet
Description
is the interface for navigating on the rows on a result set.
XResultSetUpdate
Usage Restrictions
optional
Description
is the interface for updating row data to the database.

The implementation is optional.

XRow
Description
is the interface for accessing the data of the current row.
XColumnLocate
Description
is used for locating a column by it's name.
XRowUpdate
Usage Restrictions
optional
Description
is the interface for updating the data of the current row.

The implementation is optional.

Properties' Details
CursorName
[ readonly ] string CursorName;
Usage Restrictions
optional
Description
defines the SQL cursor name that will be used by subsequent Statement execute methods.

This name can then be used in SQL positioned update/delete statements to identify the current row in the ResultSet generated by this statement. If the database doesn't support positioned update/delete, this property is a noop. To insure that a cursor has the proper isolation level to support updates, the cursor's SELECT statement should be of the form 'select for update ...'. If the 'for update' phrase is omitted, positioned updates may fail.

Note: By definition, positioned update/delete execution must be done by a different Statement than the one which generated the ResultSet being used for positioning. Also, cursor names must be unique within a connection.

ResultSetConcurrency
[ readonly ] long ResultSetConcurrency;
Description
retrieves the result set concurrency.
See also
ResultSetConcurrency
ResultSetType
[ readonly ] long ResultSetType;
Description
determines the result set type.
See also
ResultSetType
FetchDirection
long FetchDirection;
Description
retrieves the direction for fetching rows from database tables that is the default for result sets generated from this ::com::sun::star::sdbcx::Statement object.
If this Statement object has not set a fetch direction, the return value is implementation-specific.
FetchSize
long FetchSize;
Description
retrieves the number of result set rows that is the default fetch size for result sets generated from this ::com::sun::star::sdbcx::Statement object.
If this ::com::sun::star::sdbcx::Statement object has not set a fetch size, the return value is implementation-specific.

 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.