odk/examples/DevelopersGuide/Forms/HsqlDatabase.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 import com.sun.star.beans.PropertyValue;
  20 import com.sun.star.beans.XPropertySet;
  21 import com.sun.star.container.XNameAccess;
  22 import com.sun.star.frame.XStorable;
  23 import com.sun.star.sdb.XOfficeDatabaseDocument;
  24 import com.sun.star.sdbc.SQLException;
  25 import com.sun.star.sdbc.XCloseable;
  26 import com.sun.star.sdbc.XConnection;
  27 import com.sun.star.uno.UnoRuntime;
  28 import com.sun.star.sdb.XDocumentDataSource;
  29 import com.sun.star.sdbc.XDataSource;
  30 import com.sun.star.uno.XComponentContext;
  31 import java.io.File;
  32
  33 import com.sun.star.util.CloseVetoException;
  34
  35 public class HsqlDatabase
  36 {
  37     private XComponentContext       m_context;
  38     // the URL of the temporary file used for the database document
  39     private String                  m_databaseDocumentFile;
  40     // the database document
  41     private XOfficeDatabaseDocument m_databaseDocument;
  42     // the data source belonging to the database document
  43     // the default connection
  44     private XConnection             m_connection;
  45
  46
  47     public HsqlDatabase( XComponentContext _context ) throws Exception
  48     {
  49         m_context = _context;
  50         createDBDocument();
  51     }
  52
  53
  54     public HsqlDatabase( XComponentContext _context, String _existingDocumentURL ) throws Exception
  55     {
  56         m_context = _context;
  57         createDBDocument( _existingDocumentURL );
  58     }
  59
  60
  61     private void createDBDocument( String _docURL ) throws Exception
  62     {
  63         m_databaseDocumentFile = _docURL;
  64
  65         XNameAccess dbContext = UnoRuntime.queryInterface( XNameAccess.class,
  66             m_context.getServiceManager().createInstanceWithContext( "com.sun.star.sdb.DatabaseContext", m_context ) );
  67         XDocumentDataSource dataSource = UnoRuntime.queryInterface( XDocumentDataSource.class,
  68             dbContext.getByName( _docURL ) );
  69
  70         m_databaseDocument = dataSource.getDatabaseDocument();
  71     }
  72
  73     /** creates an empty database document in a temporary location
  74      */
  75     private void createDBDocument() throws Exception
  76     {
  77         File documentFile = File.createTempFile("testdb",".odb");
  78         documentFile.deleteOnExit();
  79         m_databaseDocumentFile = URLHelper.getFileURLFromSystemPath( documentFile );
  80
  81         m_databaseDocument = UnoRuntime.queryInterface(
  82             XOfficeDatabaseDocument.class, m_context.getServiceManager().createInstanceWithContext(
  83                 "com.sun.star.sdb.OfficeDatabaseDocument", m_context ) );
  84
  85         XPropertySet dsProperties = UnoRuntime.queryInterface( XPropertySet.class, m_databaseDocument.getDataSource() );
  86         dsProperties.setPropertyValue("URL", "sdbc:embedded:hsqldb");
  87
  88         XStorable storable = UnoRuntime.queryInterface( XStorable.class, m_databaseDocument );
  89         storable.storeAsURL( m_databaseDocumentFile, new PropertyValue[]{} );
  90     }
  91
  92     /** closes the database document
  93      *
  94      *  Any CloseVetoExceptions fired by third parties are ignored, and any reference to the
  95      *  database document is released.
  96      */
  97     private void close()
  98     {
  99         // close connection
 100         XCloseable closeConn = UnoRuntime.queryInterface( XCloseable.class,
 101             m_connection );
 102         if ( closeConn != null )
 103         {
 104             try
 105             {
 106                 closeConn.close();
 107             }
 108             catch( SQLException e )
 109             {
 110             }
 111         }
 112         m_connection = null;
 113
 114         // close document
 115         com.sun.star.util.XCloseable closeDoc = UnoRuntime.queryInterface(
 116             com.sun.star.util.XCloseable.class, m_databaseDocument );
 117         if ( closeDoc != null )
 118         {
 119             try
 120             {
 121                 closeDoc.close( true );
 122             }
 123             catch( CloseVetoException e )
 124             {
 125             }
 126         }
 127         m_databaseDocument = null;
 128     }
 129
 130     /** closes the document, and deletes the underlying file
 131      */
 132     private void closeAndDelete()
 133     {
 134         close();
 135
 136         if ( m_databaseDocumentFile != null )
 137         {
 138             try
 139             {
 140                 File file = new File(m_databaseDocumentFile);
 141                 file.delete();
 142             }
 143             catch(Exception e)
 144             {
 145             }
 146             m_databaseDocumentFile = null;
 147         }
 148     }
 149
 150     /** returns the underlying database document
 151     */
 152     public XOfficeDatabaseDocument getDatabaseDocument()
 153     {
 154         return m_databaseDocument;
 155     }
 156
 157     /** returns the associated data source
 158      */
 159     public XDataSource getDataSource()
 160     {
 161         return m_databaseDocument.getDataSource();
 162     }
 163
 164
 165
 166     /** returns the URL of the ODB document represented by this instance
 167      */
 168     public String getDocumentURL()
 169     {
 170         return m_databaseDocumentFile;
 171     }
 172
 173
 174
 175     @Override
 176     protected void finalize() throws Throwable
 177     {
 178         closeAndDelete();
 179         super.finalize();
 180     }
 181 }