Using a Data Source

OpenOffice.org Developer's Guide

Configuration Management

< Previous Section

Next Section >

• Object Model
• Configuration Data Sources

• Connecting to a Data Source
• Using a Data Source

• Reading Configuration Data
• Updating Configuration Data
• Customizing Configuration Data

• Creating a Custom Configuration Schema
• Preparing a Custom Configuration Schema
• Installing a Custom Configuration Schema

< Previous Page

Next Page >

After a configuration provider is obtained, call createInstanceWithArguments() to create a view on the configuration data.

The following arguments can be specified when creating a view:

Parameter Name	Type	Default	Comments
nodepath	string	-	This parameter is required. It contains an absolute path to the root node of the view.
Locale	string	The user's locale (or "*")	Using this parameter, specify the locale to be used for selecting locale-dependent values. Use the ISO code for a locale, for example, en-US for U.S. English.

If the special value "*" is used for the locale parameter, values for all locales are retrieved. In this case, a locale-dependent property appears as a set item. The items of the set are the values for the different locales. They will have the ISO identifiers of the locales as names. It can be used if you want to assign values for different locales in a targeted manner.

To create a read-only view on the data, the service com.sun.star.configuration.ConfigurationAccess is requested:

  // Create a specified read-only configuration view
  public Object createConfigurationView(String sPath) throws com.sun.star.uno.Exception {
      // get the provider to use 
      XMultiServiceFactory xProvider = getProvider();
      
      // The service name: Need only read access:
      final String sReadOnlyView = "com.sun.star.configuration.ConfigurationAccess";
      
      // creation arguments: nodepath 
      com.sun.star.beans.PropertyValue aPathArgument = new com.sun.star.beans.PropertyValue();
      aPathArgument.Name = "nodepath";
      aPathArgument.Value = sPath;
      
      Object[] aArguments = new Object[1];
      aArguments[0] = aPathArgument;
      
      // create the view
      Object xViewRoot = xProvider.createInstanceWithArguments(sReadOnlyView, aArguments);
      
      return xViewRoot;
  }

To obtain updatable access, the service com.sun.star.configuration.ConfigurationUpdateAccess is requested.

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