Content for Apache OpenOffice version 3.4.
:: com :: sun :: star :: ucb ::
|
| service ContentResultSet |
- Description
- provides access to the children of a folder content.
It can be understand as a table containing a row for each child. The
table columns may contain values of properties of the children.
|
| Included Services - Summary |
| ::com::sun::star::sdbc::ResultSet |
can be implemented to provide a complete JDBC conform result set
interface for the implementation of this service.
(details)
|
| Exported Interfaces - Summary |
| ::com::sun::star::lang::XComponent |
must be implemented to make it possible to resolve cyclic object
references ( i.e. between an implementation of
::com::sun::star::beans::XPropertySet
- which may hold property change listeners - and
::com::sun::star::beans::XPropertyChangeListener
- which may hold the property set ).
(details)
|
| ::com::sun::star::sdbc::XResultSetMetaDataSupplier |
provides access to the result set meta data. Meta data are for
example the number of columns of the result set, information
on the data types of columns, column names, and more.
(details)
|
| ::com::sun::star::sdbc::XResultSet |
enables travelling through the result set members ( the contents ).
This interface mainly provides a cursor for the result set.
(details)
|
| ::com::sun::star::sdbc::XRow |
provides access to data of the content the cursor is pointing to.
(details)
|
| ::com::sun::star::sdbc::XCloseable |
makes it possible to abort running activities ( i.e. to cancel
retrieving data from a server ).
(details)
|
| ::com::sun::star::beans::XPropertySet |
holds properties of the resultset.
(details)
|
| XContentAccess |
provides access to the content identifier and the content object
itself.
(details)
|
| Properties' Summary |
long
CursorTravelMode |
[ OPTIONAL ]
controls the travel mode of the resultset cursor.
|
[ readonly ] long
RowCount |
contains the number of rows obtained (so far) from the data source. |
[ readonly ] boolean
IsRowCountFinal |
indicates that all rows of te resultset have been obtained. |
| Included Services - Details |
|
::com::sun::star::sdbc::ResultSet
- Description
- can be implemented to provide a complete JDBC conform result set
interface for the implementation of this service.
The implememtation of this service is optional.
|
|
| Exported Interfaces - Details |
|
::com::sun::star::lang::XComponent
- Description
- must be implemented to make it possible to resolve cyclic object
references ( i.e. between an implementation of
::com::sun::star::beans::XPropertySet
- which may hold property change listeners - and
::com::sun::star::beans::XPropertyChangeListener
- which may hold the property set ).
This interface is required.
|
|
|
::com::sun::star::sdbc::XResultSetMetaDataSupplier
- Description
- provides access to the result set meta data. Meta data are for
example the number of columns of the result set, information
on the data types of columns, column names, and more.
This interface is required.
|
|
|
::com::sun::star::sdbc::XResultSet
- Description
- enables travelling through the result set members ( the contents ).
This interface mainly provides a cursor for the result set.
Note that every method of this interface implementation additionally
may throw a ResultSetException ( which is derived from
::com::sun::star::sdbc::SQLException to be compatible
to that interface ). The new exception transports another exception,
which indicates the reason for the failure of the method call.
This interface is required.
|
|
|
::com::sun::star::sdbc::XRow
- Description
- provides access to data of the content the cursor is pointing to.
Note that every method of this interface implementation additionally
may throw a ResultSetException ( which is derived from
::com::sun::star::sdbc::SQLException to be compatible
to that interface ). The new exception transports another exception,
which indicates the reason for the failure of the method call.
This interface is required.
|
|
|
::com::sun::star::sdbc::XCloseable
- Description
- makes it possible to abort running activities ( i.e. to cancel
retrieving data from a server ).
Note that every method of this interface implementation additionally
may throw a ResultSetException ( which is derived from
::com::sun::star::sdbc::SQLException to be compatible
to that interface ). The new exception transports another exception,
which indicates the reason for the failure of the method call.
This interface is required.
|
|
|
::com::sun::star::beans::XPropertySet
- Description
- holds properties of the resultset.
This interface is required.
|
|
|
XContentAccess
- Description
- provides access to the content identifier and the content object
itself.
This interface is required.
|
|
| Properties' Details |
CursorTravelMode
long CursorTravelMode;
- Usage Restrictions
- optional
- Description
- controls the travel mode of the resultset cursor.
There are two possible travel modes:
| BLOCKING |
Each travel method of the resultset will not return until the
data for the new position were retrieved. |
| NONBLOCKING |
The implementation will throw a
CursorWouldBlockException, if the data for the new
position are not retrieved yet. |
The following pseudo-code illustrates the usage of a non-blocking
cursor:
bProcessedAllRows = false
while ( !bProcessedAllRows )
{
cursor.setPropertyValue( "CursorTravelMode", BLOCKING )
cursor.travelSomeWhere()
collectRowData()
cursor.setPropertyValue( "CursorTravelMode", NONBLOCKING )
bGoOn = true;
while ( bGoOn )
{
try
{
cursor.travelSomeWhere()
collectRowData()
}
catch ( CursorWouldBlockException )
{
// No more data at the moment.
bGoOn = false
}
}
doSomethingWithCollectedRowData()
bProcessedAllRows = ...
}
If this property is not supported, the implementation needs to provide
a blocking cursor.
The implementation initially needs to set the value of this property
to BLOCKING.
- See also
- CursorTravelMode
|
|
RowCount
[ readonly ] long RowCount;
- Description
- contains the number of rows obtained (so far) from the data source.
|
|
IsRowCountFinal
[ readonly ] boolean IsRowCountFinal;
- Description
- indicates that all rows of te resultset have been obtained.
|
|
Top of Page
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.
