Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: sdb ::
service DataAccessDescriptor
Description descriptor for accessing basic data access objects. Various components interacting with the database access world require to specify (or provide themself) an object such as a query, a table, a result set, a connection to a data source, a column within a table, and so on. All of these objects are usually not specified with a single property, but with a set of properties, and for various objects, various (but not always different) properties are needed. The DataAccessDescriptor describes the super set of the properties for the most common data access objects. Every component providing or requiring a DataAccessDescriptor for some functionality is urged to specify which properties are mandatory, and which ones optional. Additionally, it's free to specify any additional requirements about the relations of properties. Since version OpenOffice.org 1.1.1

Properties' Summary
DataSourceName | [ OPTIONAL ] specifies the name of the datasource to access.
ActiveConnection | [ OPTIONAL ] is a connection to use.
Command | [ OPTIONAL ] specifies the command to execute to retrieve a result set.
CommandType | [ OPTIONAL ] specifies the type of the command to be executed to retrieve a result set.
Filter | [ OPTIONAL ] specifies an addtional filter to optinally use.
EscapeProcessing | [ OPTIONAL ] specifies if the Command should be analyzed on the client side before sending it to the database server.
ResultSet | [ OPTIONAL ] specifies an already existent result set to use.
Selection | [ OPTIONAL ] specifies a selection to confine the records in a result set.
BookmarkSelection | [ OPTIONAL ] specifies how to interpret Selection
ColumnName | [ OPTIONAL ] specifies a column name.
Column | [ OPTIONAL ] specifies a column object

Properties' Details
DataSourceName
string DataSourceName; [ OPTIONAL ] Description specifies the name of the datasource to access. This data source is usually used to create a Connection . If no DataSourceName is given, then an ActiveConnection is reuqired. See also DatabaseContext See also ActiveConnection
ActiveConnection
::com::sun::star::sdbc::XConnection ActiveConnection; [ OPTIONAL ] Description is a connection to use. This object is guaranteed to be a ::com::sun::star::sdbc::Connection , but usually it will be a Connection from the module com::sun::star::sdb. Especially in the case where no DataSourceName is given, but CommandType is CommandType::QUERY , the ActiveConnection needs to fully support the Connection service, to actually retrieve the query specified by Command If no ActiveConnection is given, then a DataSourceName is required. See also DataSourceName
Command
string Command; [ OPTIONAL ] Description specifies the command to execute to retrieve a result set. This property is only meaningfull together with the CommandType property, thus either both or none of them are present. See also CommandType
CommandType
long CommandType; [ OPTIONAL ] Description specifies the type of the command to be executed to retrieve a result set. Command needs to be interpreted depending on the value of this property. This property is only meaningfull together with the Command property, thus either both or none of them are present. See also CommandType
Filter
string Filter; [ OPTIONAL ] Description specifies an addtional filter to optinally use. The Filter string has to form a SQL WHERE-clause, without the WHERE-string itself. If a DataSourceName , Command and CommandType are specified, a RowSet can be created with this information. If the results provided by the row set are to be additionally filtered, the Filter property can be used. Note that the Filter property does not make sense if a ResultSet has been specified in the DataAccessDescriptor. See also RowSet See also ResultSet
EscapeProcessing
boolean EscapeProcessing; [ OPTIONAL ] Description specifies if the Command should be analyzed on the client side before sending it to the database server. The default value of this property is true . By switching it to false , you can pass backend-specific SQL statements, which are not standard SQL, to your database. This property is usually present together with the Command and CommandType properties, and is evaluated if and only if CommandType equals CommandType::COMMAND .
ResultSet
::com::sun::star::sdbc::XResultSet ResultSet; [ OPTIONAL ] Description specifies an already existent result set to use. Usually, you use the properties DataSourceName (alternatively ActiveConnection ), Command and CommandType to specify how to obtain a result set. However, in scenarious where the provider of a DataAccessDescriptor has access to an already existent result set, it can pass it along for reusage. This is encouraged to increase performance. The object will at least support the ::com::sun::star::sdbc::ResultSet . Note that any superservices of ::com::sun::star::sdbc::ResultSet are also allowed. Especially, this member can denote an instance of the RowSet , or an instance obtained by calling XResultSetAccess::createResultSet on such a RowSet . This becomes important in conjunction with the Selection property. See also XResultSetAccess
Selection
sequence< any > Selection; [ OPTIONAL ] Description specifies a selection to confine the records in a result set. When you specify a result set either implicitly ( DataSourceName , Command , CommandType ) or explicitly ( ResultSet ), the set of results can be additionally refined with this property. The single elements of the Selection are either record numbers (see ::com::sun::star::sdbc::XResultSet::getRow ), or bookmarks (see ::com::sun::star::sdbcx::XRowLocate::getBookmark ). It is up to the component which provides or requires a DataAccessDescriptor to specify which of the two alternatives it expects. If it does not specify this, then the property BookmarkSelection becomes mandatory. If the elements specify bookmarks, and a ResultSet has been specified, then this result set is urged to support the ::com::sun::star::sdbcx::XRowLocate interface.
BookmarkSelection
boolean BookmarkSelection; [ OPTIONAL ] Description specifies how to interpret Selection If present, BookmarkSelection specifies the semantics of Selection . If not present, it's up to the implementing component to specify this semantics. If true , then the single elements of the array specified by Selection are bookmarks relative to the result set, if false , they're record numbers. See also ::com::sun::star::sdbcx::XRowLocate See also ::com::sun::star::sdbc::XResultSet See also XResultSetAccess
ColumnName
string ColumnName; [ OPTIONAL ] Description specifies a column name. This property is usually used together with the Command and CommandType properties. See also Column
Column
::com::sun::star::beans::XPropertySet Column; [ OPTIONAL ] Description specifies a column object For reasons of performance and saving resources, a supplier of an DataAccessDescriptor which is used to describe a column object can pass this object directly, instead of specifying it only implicitly with the ColumnName property. The object will at least support the ::com::sun::star::sdbcx::Column service, but more often it will even be a Column from the com::sun::star::sdb module.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.