Extending Database Drivers

Apache OpenOffice Developer's Guide

Database Access

< Previous Section

Next Section >

• Architecture
• Example: Querying the Bibliography Database

• Data Sources in Apache OpenOffice API

• DataSources

• The DataSource Service
• Queries

• Adding and Editing Predefined Queries
• Runtime Settings For Predefined Queries
• The SingleSelectQueryComposer
• The SQLQueryComposer

• Forms and Reports
• Document Links
• Tables and Columns

• Connections

• Connecting Through a DataSource
• Connecting Using the DriverManager and a Database URL
• Connecting Through a Specific Driver
• Driver Specifics

• The SDBC Driver for JDBC
• The SDBC Driver for ODBC
• The SDBC Driver for Adabas D
• The SDBC Driver for ADO
• The SDBC Driver for dBase
• The SDBC Driver for Flat File Formats
• The SDBC Driver for Apache OpenOffice Calc Files
• The SDBC Driver for address books
• The SDBC Driver for embedded HSQL databases

• Connection Pooling
• Piggyback Connections

• Manipulating the Data

• The RowSet Service

• Usage
• Events and Other Notifications
• Clones of the RowSet Service

• Statements

• Creating Statements
• Inserting and Updating Data
• Getting Data from a Table

• Result Sets

• Retrieving Values from Result Sets
• Moving the Result Set Cursor
• Using the getXXX Methods
• Scrollable Result Sets
• Modifiable Result Sets
• Update
• Insert
• Delete
• Seeing Changes in Result Sets

• ResultSetMetaData
• Using Prepared Statements
• PreparedStatement From DataSource Queries

• Database Design

• Using DDL to Change the Database Design
• Using SDBCX to Access the Database Design

• Catalog Service
• Table Service
• Column Service
• Index Service
• Key Service
• View Service
• Group Service
• User Service
• The Descriptor Pattern
• Adding an Index
• Creating a User
• Adding a Group

• Using DBMS Features

• Stored Procedures

• Writing Database Drivers

• SDBC Driver
• Driver Service
• Connection Service
• XDatabaseMetaData Interface
• Statements
• Support Scalar Functions

• Open Group CLI Numeric Functions
• Open Group CLI String Functions
• Open Group CLI Time and Date Functions
• Open Group CLI System Functions
• Open Group CLI Conversion Functions

• Handling Unsupported Functionality
• Extending Database Drivers

< Previous Page

Next Page >

In the following section, extending existing SDBC drivers by extensions is described. These section is valid from since: OOo 3.3

Most drivers miss to support special features like to alter view definitions or to add or drop key of a table. Therefor these interfaces

• com.sun.star.sdb.tools.XViewSupport
• com.sun.star.sdb.tools.XTableRename
• com.sun.star.sdb.tools.XTableAlteration
• com.sun.star.sdb.tools.XKeyAlteration
• com.sun.star.sdb.tools.XIndexAlteration

can be implemented by an extension.

To enable the needed feature the extension has to extend the properties entry of the configuration of the driver. The configuration entry below the properties entry will be checked and if the service name can be instantiated it will be used to do the job. Below you'll see a table of mapping from configuration entry to service name.

Configuration name	Interface name which has to to be implemented
ViewSupportServiceName	com.sun.star.sdb.tools.XViewSupport
TableAlterationServiceName	com.sun.star.sdb.tools.XTableAlteration
TableRenameServiceName	com.sun.star.sdb.tools.XTableRename
IndexAlterationServiceName	com.sun.star.sdb.tools.XIndexAlteration
KeyAlterationServiceName	com.sun.star.sdb.tools.XKeyAlteration

In favor to allow to get the definition of queries, forms and reports from other locations as the default file format specification, an extension may implement a service which implement the following named interfaces. The configuration entries are named

• CommandDefinitionSupplier
• FormSupplier
• ReportSupplier

which all have to implement the interfaces

• com.sun.star.container.XNameAccess
• com.sun.star.container.XNameContainer
• com.sun.star.ucb.XContent
• com.sun.star.container.XChild
• com.sun.star.container.XContainer
• com.sun.star.container.XContainerApproveBroadcaster
• com.sun.star.lang.XInitialization

The configuration fragment below shows how to define which service should be created to extend the view support and to extend the table alteration support.

<oor:component-data oor:name="Drivers" oor:package="org.openoffice.Office.DataAccess" xmlns:oor="http://openoffice.org/2001/registry" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <node oor:name="Installed">
    <node oor:name="jdbc:" oor:op="replace">
      <prop oor:name="ParentURLPattern">
        <value>jdbc:*</value>
      </prop>
      <prop oor:name="DriverTypeDisplayName" oor:type="xs:string">
        <value xml:lang="en-US">SQL 2008 JDBC</value>
      </prop>
      <node oor:name="Properties">
        <node oor:name="ViewSupportServiceName" oor:op="replace">
          <prop oor:name="Value" oor:type="xs:string">
            <value>com.sun.star.sdb.comp.SQL2008.ViewSupport</value>
          </prop>
        </node>
        <node oor:name="TableAlterationServiceName" oor:op="replace">
          <prop oor:name="Value" oor:type="xs:string">
            <value>com.sun.star.sdb.comp.SQL2008.TableAlterService</value>
          </prop>
        </node>
      </node>
    </node>
  </node>
</oor:component-data>

Content on this page is licensed under the Public Documentation License (PDL).