dbaccess/source/ui/misc/indexcollection.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include "indexcollection.hxx"
  21 #include <tools/diagnose_ex.h>
  22 #include <com/sun/star/sdbcx/XAppend.hpp>
  23 #include <com/sun/star/beans/XPropertySet.hpp>
  24 #include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
  25 #include <com/sun/star/sdbcx/XDataDescriptorFactory.hpp>
  26 #include <comphelper/extract.hxx>
  27 #include <com/sun/star/sdbcx/XDrop.hpp>
  28 #include <com/sun/star/container/XNameContainer.hpp>
  29
  30 namespace dbaui
  31 {
  32
  33     using namespace ::com::sun::star::uno;
  34     using namespace ::com::sun::star::container;
  35     using namespace ::com::sun::star::beans;
  36     using namespace ::com::sun::star::sdbcx;
  37     using namespace ::com::sun::star::sdbc;
  38
  39     // OIndexCollection
  40     OIndexCollection::OIndexCollection()
  41     {
  42     }
  43
  44     OIndexCollection::OIndexCollection(const OIndexCollection& _rSource)
  45     {
  46         *this = _rSource;
  47     }
  48
  49     const OIndexCollection& OIndexCollection::operator=(const OIndexCollection& _rSource)
  50     {
  51         detach();
  52         m_xIndexes = _rSource.m_xIndexes;
  53         m_aIndexes = _rSource.m_aIndexes;
  54         return *this;
  55     }
  56
  57     void OIndexCollection::attach(const Reference< XNameAccess >& _rxIndexes)
  58     {
  59         implConstructFrom(_rxIndexes);
  60     }
  61
  62     void OIndexCollection::detach()
  63     {
  64         m_xIndexes.clear();
  65         m_aIndexes.clear();
  66     }
  67
  68     Indexes::const_iterator OIndexCollection::find(const OUString& _rName) const
  69     {
  70         OUString sNameCompare(_rName);
  71
  72         // loop'n'compare
  73         Indexes::const_iterator aSearch = m_aIndexes.begin();
  74         Indexes::const_iterator aEnd = m_aIndexes.end();
  75         for (; aSearch != aEnd; ++aSearch)
  76             if (aSearch->sName == sNameCompare)
  77                 break;
  78
  79         return aSearch;
  80     }
  81
  82     Indexes::iterator OIndexCollection::find(const OUString& _rName)
  83     {
  84         OUString sNameCompare(_rName);
  85
  86         // loop'n'compare
  87         Indexes::iterator aSearch = m_aIndexes.begin();
  88         Indexes::iterator aEnd = m_aIndexes.end();
  89         for (; aSearch != aEnd; ++aSearch)
  90             if (aSearch->sName == sNameCompare)
  91                 break;
  92
  93         return aSearch;
  94     }
  95
  96     Indexes::const_iterator OIndexCollection::findOriginal(const OUString& _rName) const
  97     {
  98         OUString sNameCompare(_rName);
  99
 100         // loop'n'compare
 101         Indexes::const_iterator aSearch = m_aIndexes.begin();
 102         Indexes::const_iterator aEnd = m_aIndexes.end();
 103         for (; aSearch != aEnd; ++aSearch)
 104             if (aSearch->getOriginalName() == sNameCompare)
 105                 break;
 106
 107         return aSearch;
 108     }
 109
 110     Indexes::iterator OIndexCollection::findOriginal(const OUString& _rName)
 111     {
 112         OUString sNameCompare(_rName);
 113
 114         // loop'n'compare
 115         Indexes::iterator aSearch = m_aIndexes.begin();
 116         Indexes::iterator aEnd = m_aIndexes.end();
 117         for (; aSearch != aEnd; ++aSearch)
 118             if (aSearch->getOriginalName() == sNameCompare)
 119                 break;
 120
 121         return aSearch;
 122     }
 123
 124     void OIndexCollection::commitNewIndex(const Indexes::iterator& _rPos)
 125     {
 126         OSL_ENSURE(_rPos->isNew(), "OIndexCollection::commitNewIndex: index must be new!");
 127
 128         try
 129         {
 130             Reference< XDataDescriptorFactory > xIndexFactory(m_xIndexes, UNO_QUERY);
 131             Reference< XAppend > xAppendIndex(xIndexFactory, UNO_QUERY);
 132             if (!xAppendIndex.is())
 133             {
 134                 OSL_FAIL("OIndexCollection::commitNewIndex: missing an interface of the index container!");
 135                 return;
 136             }
 137
 138             Reference< XPropertySet > xIndexDescriptor = xIndexFactory->createDataDescriptor();
 139             Reference< XColumnsSupplier > xColsSupp(xIndexDescriptor, UNO_QUERY);
 140             Reference< XNameAccess > xCols;
 141             if (xColsSupp.is())
 142                 xCols = xColsSupp->getColumns();
 143
 144             Reference< XDataDescriptorFactory > xColumnFactory(xCols, UNO_QUERY);
 145             Reference< XAppend > xAppendCols(xColumnFactory, UNO_QUERY);
 146             if (!xAppendCols.is())
 147             {
 148                 OSL_FAIL("OIndexCollection::commitNewIndex: invalid index descriptor returned!");
 149                 return;
 150             }
 151
 152             // set the properties
 153             static const char s_sUniquePropertyName[] = "IsUnique";
 154             static const char s_sSortPropertyName[] = "IsAscending";
 155             static const char s_sNamePropertyName[] = "Name";
 156             // the index' own props
 157             xIndexDescriptor->setPropertyValue(s_sUniquePropertyName, css::uno::makeAny(_rPos->bUnique));
 158             xIndexDescriptor->setPropertyValue(s_sNamePropertyName, makeAny(_rPos->sName));
 159
 160             // the fields
 161             for (   IndexFields::const_iterator aFieldLoop = _rPos->aFields.begin();
 162                     aFieldLoop != _rPos->aFields.end();
 163                     ++aFieldLoop
 164                 )
 165             {
 166                 OSL_ENSURE(!xCols->hasByName(aFieldLoop->sFieldName), "OIndexCollection::commitNewIndex: double column name (need to prevent this outside)!");
 167
 168                 Reference< XPropertySet > xColDescriptor = xColumnFactory->createDataDescriptor();
 169                 OSL_ENSURE(xColDescriptor.is(), "OIndexCollection::commitNewIndex: invalid column descriptor!");
 170                 if (xColDescriptor.is())
 171                 {
 172                     xColDescriptor->setPropertyValue(s_sSortPropertyName, css::uno::makeAny(aFieldLoop->bSortAscending));
 173                     xColDescriptor->setPropertyValue(s_sNamePropertyName, makeAny(OUString(aFieldLoop->sFieldName)));
 174                     xAppendCols->appendByDescriptor(xColDescriptor);
 175                 }
 176             }
 177
 178             xAppendIndex->appendByDescriptor(xIndexDescriptor);
 179
 180             _rPos->flagAsCommitted(GrantIndexAccess());
 181             _rPos->clearModified();
 182         }
 183         catch(SQLException&)
 184         {   // allowed to pass
 185             throw;
 186         }
 187         catch( const Exception& )
 188         {
 189             DBG_UNHANDLED_EXCEPTION();
 190         }
 191     }
 192
 193     bool OIndexCollection::dropNoRemove(const Indexes::iterator& _rPos)
 194     {
 195         try
 196         {
 197             OSL_ENSURE(m_xIndexes->hasByName(_rPos->getOriginalName()), "OIndexCollection::drop: invalid name!");
 198
 199             Reference< XDrop > xDropIndex(m_xIndexes, UNO_QUERY);
 200             if (!xDropIndex.is())
 201             {
 202                 OSL_FAIL("OIndexCollection::drop: no XDrop interface!");
 203                 return false;
 204             }
 205
 206             xDropIndex->dropByName(_rPos->getOriginalName());
 207         }
 208         catch(SQLException&)
 209         {   // allowed to pass
 210             throw;
 211         }
 212         catch( const Exception& )
 213         {
 214             DBG_UNHANDLED_EXCEPTION();
 215             return false;
 216         }
 217
 218         // adjust the OIndex structure
 219         Indexes::iterator aDropped = findOriginal(_rPos->getOriginalName());
 220         OSL_ENSURE(aDropped != m_aIndexes.end(), "OIndexCollection::drop: invalid original name, but successful commit?!");
 221         aDropped->flagAsNew(GrantIndexAccess());
 222
 223         return true;
 224     }
 225
 226     bool OIndexCollection::drop(const Indexes::iterator& _rPos)
 227     {
 228         OSL_ENSURE((_rPos >= m_aIndexes.begin()) && (_rPos < m_aIndexes.end()),
 229             "OIndexCollection::drop: invalid position (fasten your seatbelt .... this will crash)!");
 230
 231         if (!_rPos->isNew())
 232             if (!dropNoRemove(_rPos))
 233                 return false;
 234
 235         // adjust the index array
 236         m_aIndexes.erase(_rPos);
 237         return true;
 238     }
 239
 240     void OIndexCollection::implFillIndexInfo(OIndex& _rIndex)
 241     {
 242         // get the UNO descriptor for the index
 243         Reference< XPropertySet > xIndex;
 244         m_xIndexes->getByName(_rIndex.getOriginalName()) >>= xIndex;
 245         if (!xIndex.is())
 246         {
 247             OSL_FAIL("OIndexCollection::implFillIndexInfo: got an invalid index object!");
 248         }
 249         else
 250             implFillIndexInfo(_rIndex, xIndex);
 251     }
 252
 253     void OIndexCollection::implFillIndexInfo(OIndex& _rIndex, Reference< XPropertySet > _rxDescriptor)
 254     {
 255         static const char s_sPrimaryIndexPropertyName[] = "IsPrimaryKeyIndex";
 256         static const char s_sUniquePropertyName[] = "IsUnique";
 257         static const char s_sSortPropertyName[] = "IsAscending";
 258         static const char s_sCatalogPropertyName[] = "Catalog";
 259
 260         _rIndex.bPrimaryKey = ::cppu::any2bool(_rxDescriptor->getPropertyValue(s_sPrimaryIndexPropertyName));
 261         _rIndex.bUnique = ::cppu::any2bool(_rxDescriptor->getPropertyValue(s_sUniquePropertyName));
 262         _rxDescriptor->getPropertyValue(s_sCatalogPropertyName) >>= _rIndex.sDescription;
 263
 264         // the columns
 265         Reference< XColumnsSupplier > xSuppCols(_rxDescriptor, UNO_QUERY);
 266         Reference< XNameAccess > xCols;
 267         if (xSuppCols.is())
 268             xCols = xSuppCols->getColumns();
 269         OSL_ENSURE(xCols.is(), "OIndexCollection::implFillIndexInfo: the index does not have columns!");
 270         if (xCols.is())
 271         {
 272             Sequence< OUString > aFieldNames = xCols->getElementNames();
 273             _rIndex.aFields.resize(aFieldNames.getLength());
 274
 275             const OUString* pFieldNames = aFieldNames.getConstArray();
 276             const OUString* pFieldNamesEnd = pFieldNames + aFieldNames.getLength();
 277             IndexFields::iterator aCopyTo = _rIndex.aFields.begin();
 278
 279             Reference< XPropertySet > xIndexColumn;
 280             for (;pFieldNames < pFieldNamesEnd; ++pFieldNames, ++aCopyTo)
 281             {
 282                 // extract the column
 283                 xIndexColumn.clear();
 284                 xCols->getByName(*pFieldNames) >>= xIndexColumn;
 285                 if (!xIndexColumn.is())
 286                 {
 287                     OSL_FAIL("OIndexCollection::implFillIndexInfo: invalid index column!");
 288                     --aCopyTo;
 289                     continue;
 290                 }
 291
 292                 // get the relevant properties
 293                 aCopyTo->sFieldName = *pFieldNames;
 294                 aCopyTo->bSortAscending = ::cppu::any2bool(xIndexColumn->getPropertyValue(s_sSortPropertyName));
 295             }
 296
 297             _rIndex.aFields.resize(aCopyTo - _rIndex.aFields.begin());
 298                 // (just in case some fields were invalid ...)
 299         }
 300     }
 301
 302     void OIndexCollection::resetIndex(const Indexes::iterator& _rPos)
 303     {
 304         OSL_ENSURE(_rPos >= m_aIndexes.begin() && _rPos < m_aIndexes.end(),
 305             "OIndexCollection::resetIndex: invalid position!");
 306
 307         try
 308         {
 309             _rPos->sName = _rPos->getOriginalName();
 310             implFillIndexInfo(*_rPos);
 311
 312             _rPos->clearModified();
 313             _rPos->flagAsCommitted(GrantIndexAccess());
 314         }
 315         catch(SQLException&)
 316         {   // allowed to pass
 317             throw;
 318         }
 319         catch( const Exception& )
 320         {
 321             DBG_UNHANDLED_EXCEPTION();
 322         }
 323     }
 324
 325     Indexes::iterator OIndexCollection::insert(const OUString& _rName)
 326     {
 327         OSL_ENSURE(end() == find(_rName), "OIndexCollection::insert: invalid new name!");
 328         OUString tmpName;
 329         OIndex aNewIndex(tmpName);  // the empty string indicates the index is a new one
 330         aNewIndex.sName = _rName;
 331         m_aIndexes.push_back(aNewIndex);
 332         return m_aIndexes.end() - 1;    // the last element is the new one ...
 333     }
 334
 335     void OIndexCollection::implConstructFrom(const Reference< XNameAccess >& _rxIndexes)
 336     {
 337         detach();
 338
 339         m_xIndexes = _rxIndexes;
 340         if (m_xIndexes.is())
 341         {
 342             // loop through all the indexes
 343             Sequence< OUString > aNames = m_xIndexes->getElementNames();
 344             const OUString* pNames = aNames.getConstArray();
 345             const OUString* pEnd = pNames + aNames.getLength();
 346             for (; pNames < pEnd; ++pNames)
 347             {
 348                 // extract the index object
 349                 Reference< XPropertySet > xIndex;
 350                 m_xIndexes->getByName(*pNames) >>= xIndex;
 351                 if (!xIndex.is())
 352                 {
 353                     OSL_FAIL("OIndexCollection::implConstructFrom: got an invalid index object ... ignoring!");
 354                     continue;
 355                 }
 356
 357                 // fill the OIndex structure
 358                 OIndex aCurrentIndex(*pNames);
 359                 implFillIndexInfo(aCurrentIndex);
 360                 m_aIndexes.push_back(aCurrentIndex);
 361             }
 362         }
 363     }
 364
 365 }   // namespace dbaui
 366
 367 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */