Document Links

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 >

Each data source can maintain an arbitrary number of document links. The primary purpose of this function is to provide a collection of database forms used with a database.

The links are available at the com.sun.star.sdb.XBookmarksSupplier interface of a data source that has one method:

 com::sun::star::container::XNameAccess getBookmarks()

The returned service is a com.sun.star.sdb.DefinitionContainer. The DefinitionContainer is not only an XNameAccess, but a com.sun.star.container.XNameContainer, that is, new links are added using insertByName() as described in the chapter First Steps. Besides the name access, links are obtained through com.sun.star.container.XIndexAccess and com.sun.star.container.XEnumerationAccess.

The returned bookmarks are simple strings containing URLs. Usually forms are are stored at file:/// URLs. The following example adds a new document to the data source Bibliography:

 public static void addDocumentLink(XMultiServiceFactory _rMSF) throws com.sun.star.uno.Exception {
     XNameAccess xNameAccess = (XNameAccess)UnoRuntime.queryInterface(
         XNameAccess.class,_rMSF.createInstance("com.sun.star.sdb.DatabaseContext"));
 
     // we use the predefined Bibliography data source
     XDataSource xDS = (XDataSource)UnoRuntime.queryInterface(
         XDataSource.class, xNameAccess.getByName("Bibliography"));
     
     // we need the XBookmarksSupplier interface of the data source
     XBookmarksSupplier xBookmarksSupplier = ( XBookmarksSupplier )UnoRuntime.queryInterface(
         XBookmarksSupplier.class, xDS);
     
     // get container with bookmark URLs
     XNameAccess xBookmarks = xBookmarksSupplier.getBookmarks();
     XNameContainer xBookmarksContainer = (XNameContainer)UnoRuntime.queryInterface(
         XNameContainer.class, xBookmarks);
     
     // insert new link
     xBookmarksContainer.insertByName("MyLink", "file:///home/ada01/Form_Ada01_DSADMIN.Table1.odt");
 }

To load a linked document, use the bookmark URL with the method loadComponentFromUrl() at the com.sun.star.frame.XComponentLoader interface of the com.sun.star.frame.Desktop singleton that is available at the global service manager. For details about the Desktop, see Office Development.

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