Difference between revisions of "Documentation/DevGuide/Config/Updating Configuration Data"

  // This method simulates editing configuration data using a GridEditor dialog class 
  public void editGridOptions() throws com.sun.star.uno.Exception {
      // The path to the root element 
      final String cGridOptionsPath = "/org.openoffice.Office.Calc/Grid";
 
      // create a view
      Object xViewRoot = createUpdatableView(cGridOptionsPath);
 
      // the 'editor'
      GridOptionsEditor dialog = new GridOptionsEditor();
 
      // set up the initial values and register listeners
      // get a data access interface, to supply the view with a model 
      XMultiHierarchicalPropertySet xProperties = (XMultiHierarchicalPropertySet)
          UnoRuntime.queryInterface(XMultiHierarchicalPropertySet.class, xViewRoot);
 
      dialog.setModel(xProperties);
 
      // get a listener object (probably an adapter) that notifies
      // the dialog of external changes to its model 
      XChangesListener xListener = dialog.createChangesListener( );
 
      XChangesNotifier xNotifier = 
          (XChangesNotifier)UnoRuntime.queryInterface(XChangesNotifier.class, xViewRoot);
 
      xNotifier.addChangesListener(xListener);
 
      if (dialog.execute() == GridOptionsEditor.SAVE_SETTINGS) {
          // changes have been applied to the view here
          XChangesBatch xUpdateControl = 
              (XChangesBatch) UnoRuntime.queryInterface(XChangesBatch.class,xViewRoot);
 
          try {
              xUpdateControl.commitChanges();
          }
          catch (Exception e) {
              dialog.informUserOfError( e );
          }
      }
 
      // all changes have been handled - clean up and return
      // listener is done now
      xNotifier.removeChangesListener(xListener);
 
      // we are done with the view - dispose it 
      ((XComponent)UnoRuntime.queryInterface(XComponent.class, xViewRoot)).dispose();
  }

  /// This method resets the grid settings to their default values
  protected void resetGridConfiguration() throws com.sun.star.uno.Exception {
      // The path to the root element 
      final String cGridOptionsPath = "/org.openoffice.Office.Calc/Grid";
 
      // create the view
      Object xViewRoot = createUpdatableView(cGridOptionsPath);
 
      // ### resetting a single nested value ###
      XHierarchicalNameAccess xHierarchicalAccess = 
          (XHierarchicalNameAccess)UnoRuntime.queryInterface(XHierarchicalNameAccess.class, xViewRoot);
 
      // get using absolute name
      Object xOptions = xHierarchicalAccess.getByHierarchicalName(cGridOptionsPath + "/Option");
 
      XPropertyState xOptionState = 
          (XPropertyState)UnoRuntime.queryInterface(XPropertyState.class, xOptions);
 
      xOptionState.setPropertyToDefault("VisibleGrid");
 
      // ### resetting more deeply nested values ###
      Object xResolutionX = xHierarchicalAccess.getByHierarchicalName("Resolution/XAxis");
      Object xResolutionY = xHierarchicalAccess.getByHierarchicalName("Resolution/YAxis");
 
      XPropertyState xResolutionStateX = 
          (XPropertyState)UnoRuntime.queryInterface(XPropertyState.class, xResolutionX);
      XPropertyState xResolutionStateY = 
          (XPropertyState)UnoRuntime.queryInterface(XPropertyState.class, xResolutionY);
 
      xResolutionStateX.setPropertyToDefault("Metric");
      xResolutionStateY.setPropertyToDefault("Metric");
 
      // ### resetting multiple sibling values ###
      Object xSubdivision = xHierarchicalAccess.getByHierarchicalName("Subdivision");
 
      XMultiPropertyStates xSubdivisionStates =
          (XMultiPropertyStates)UnoRuntime.queryInterface(XMultiPropertyStates.class, xSubdivision);
 
      xSubdivisionStates.setAllPropertiesToDefault();
 
      // commit the changes
      XChangesBatch xUpdateControl = 
          (XChangesBatch) UnoRuntime.queryInterface(XChangesBatch.class, xViewRoot);
 
      xUpdateControl.commitChanges();
 
      // we are done with the view - dispose it 
      ((XComponent)UnoRuntime.queryInterface(XComponent.class, xViewRoot)).dispose();
  }

  // This method stores a data source for given connection data
  void storeDataSource(
          String sDataSourceName,
          String sDataSourceURL,
          String sUser,
          boolean bNeedsPassword,
          int nTimeout,
          com.sun.star.beans.NamedValue [] aDriverSettings,
          String [] aTableFilter ) throws com.sun.star.uno.Exception {
 
      // create the view and get the data source element in a 
      // helper method createDataSourceDescription() (see below)
      Object xDataSource = createDataSourceDescription(getProvider(), sDataSourceName);
 
      // set the values 
      XPropertySet xDataSourceProperties = (XPropertySet)UnoRuntime.queryInterface(
          XPropertySet.class, xDataSource);
 
      xDataSourceProperties.setPropertyValue("URL", sDataSourceURL);
      xDataSourceProperties.setPropertyValue("User", sUser);
      xDataSourceProperties.setPropertyValue("IsPasswordRequired", new Boolean(bNeedsPassword));
      xDataSourceProperties.setPropertyValue("LoginTimeout", new Integer(nTimeout));
 
      if (aTableFilter != null)
          xDataSourceProperties.setPropertyValue("TableFilter", aTableFilter);
 
      // ### store the driver-specific settings ###
      if (aDriverSettings != null) {
          Object xSettingsSet = xDataSourceProperties.getPropertyValue("DataSourceSettings");
 
          // helper for storing (see below)
          storeSettings( xSettingsSet, aDriverSettings);
      }
 
      // ### save the data and dispose the view ###
      // recover the view root (helper method)
      Object xViewRoot = getViewRoot(xDataSource);
 
      // commit the changes
      XChangesBatch xUpdateControl = (XChangesBatch) UnoRuntime.queryInterface(
          XChangesBatch.class, xViewRoot);
 
      xUpdateControl.commitChanges();
 
      // now clean up
      ((XComponent) UnoRuntime.queryInterface(XComponent.class, xViewRoot)).dispose();
  }

  /** This method gets the DataSourceDescription for a data source.
      It either gets the existing entry or creates a new instance.
  */
  Object createDataSourceDescription(XMultiServiceFactory xProvider, String sDataSourceName )
              throws com.sun.star.uno.Exception
  {
      // The service name: Need an update access:
      final String cUpdatableView = "com.sun.star.configuration.ConfigurationUpdateAccess";
 
       // The path to the DataSources set node
      final String cDataSourcesPath = "/org.openoffice.Office.DataAccess/DataSources";
 
     // creation arguments: nodepath
      com.sun.star.beans.PropertyValue aPathArgument = new com.sun.star.beans.PropertyValue();
      aPathArgument.Name = "nodepath";
      aPathArgument.Value = cDataSourcesPath ;
 
      Object[] aArguments = new Object[1];
      aArguments[0] = aPathArgument;
 
      // create the view
      Object xViewRoot =
          xProvider.createInstanceWithArguments(cUpdatableView, aArguments);
 
      XNameAccess xSetOfDataSources =
          (XNameAccess) UnoRuntime.queryInterface(XNameAccess.class,xViewRoot);
 
      Object xDataSourceDescriptor = null; // the result
      if ( xSetOfDataSources .hasByName( sDataSourceName ))
      {
          // the element is there
          try
          {
              // the view should point to the element directly, so we need to extend the path
              XHierarchicalName xComposePath = (XHierarchicalName)
                  UnoRuntime.queryInterface(XHierarchicalName.class, xSetOfDataSources );
 
              String sElementPath = xComposePath.composeHierarchicalName( sDataSourceName );
 
              // use the name of the element now
              aPathArgument.Value = sElementPath;
 
              // create another view now
              Object[] aDeepArguments = new Object[1];
              aDeepArguments[0] = aPathArgument;
 
              // create the view
              xDataSourceDescriptor  =
                    xProvider.createInstanceWithArguments(cUpdatableView, aDeepArguments);
 
              if ( xDataSourceDescriptor != null) // all went fine
              {
                  // dispose the other view
                  ((XComponent)UnoRuntime.queryInterface(XComponent.class, xViewRoot)).dispose();
                  xViewRoot = null;
              }
          }
          catch (Exception e)
          {
            // something went wrong, we retry with a new element
             System.err.println("WARNING: An exception occurred while creating a view for an existing data source: " + e);
             xDataSourceDescriptor  = null;
          }
      }
 
      // do we have a result element yet ?
      if ( xDataSourceDescriptor == null)
      {
          // get the container
          XNameContainer xSetUpdate =
              (XNameContainer)UnoRuntime.queryInterface(XNameContainer.class, xViewRoot);
 
          // create a new detached set element (instance of DataSourceDescription)
          XSingleServiceFactory xElementFactory =
              (XSingleServiceFactory)UnoRuntime.queryInterface(XSingleServiceFactory.class, xSetUpdate);
 
          // the new element is the result !
           xDataSourceDescriptor  = xElementFactory.createInstance();
 
          // insert it - this also names the element
          xSetUpdate.insertByName( sDataSourceName ,  xDataSourceDescriptor  );
      }
 
      return xDataSourceDescriptor ;
  }

  // This method get the view root node given an interface to any node in the view
  public static Object getViewRoot(Object xElement) {
      Object xResult = xElement; 
 
      // set the result to its parent until that would be null 
      Object xParent;
      do {
          XChild xParentAccess =
          (XChild) UnoRuntime.queryInterface(XChild.class,xResult);
 
          if (xParentAccess != null)
              xParent = xParentAccess.getParent();
          else
              xParent = null;
 
          if (xParent != null)
              xResult = xParent;
      }
      while (xParent != null);
 
      return xResult;
  }

  /// this method stores a number of settings in a set node containing DataSourceSetting objects
  void storeSettings(Object xSettingsSet, com.sun.star.beans.NamedValue [] aSettings)
          throws com.sun.star.uno.Exception {
 
      if (aSettings == null) 
          return;
 
      // get the settings set as a container
      XNameContainer xSettingsContainer = 
          (XNameContainer) UnoRuntime.queryInterface( XNameContainer.class, xSettingsSet);
 
      // and get a factory interface for creating the entries
      XSingleServiceFactory xSettingsFactory = 
          (XSingleServiceFactory) UnoRuntime.queryInterface(XSingleServiceFactory.class, xSettingsSet);
 
      // now insert the individual settings
      for (int i = 0; i < aSettings.length; ++i) {
          // create a DataSourceSetting object
          XPropertySet xSetting = (XPropertySet) 
              UnoRuntime.queryInterface(XPropertySet.class, xSettingsFactory.createInstance());
 
          // can set the value before inserting
          xSetting.setPropertyValue("Value", aSettings[i].Value);
 
          // and now insert or replace as appropriate
          if (xSettingsContainer.hasByName(aSettings[i].Name))
              xSettingsContainer.replaceByName(aSettings[i].Name, xSetting);
          else
              xSettingsContainer.insertByName(aSettings[i].Name, xSetting);
      }
  }