dbaccess/source/core/dataaccess/bookmarkcontainer.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: bookmarkcontainer.cxx,v $
  10  * $Revision: 1.15 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_dbaccess.hxx"
  33
  34 #ifndef _DBA_CORE_BOOKMARKCONTAINER_HXX_
  35 #include "bookmarkcontainer.hxx"
  36 #endif
  37 #ifndef DBACCESS_SHARED_DBASTRINGS_HRC
  38 #include "dbastrings.hrc"
  39 #endif
  40 #ifndef _DBASHARED_APITOOLS_HXX_
  41 #include "apitools.hxx"
  42 #endif
  43 #ifndef _DBA_CORE_RESOURCE_HXX_
  44 #include "core_resource.hxx"
  45 #endif
  46 #ifndef _DBA_CORE_RESOURCE_HRC_
  47 #include "core_resource.hrc"
  48 #endif
  49
  50 #ifndef _TOOLS_DEBUG_HXX
  51 #include <tools/debug.hxx>
  52 #endif
  53 #ifndef _COMPHELPER_SEQUENCE_HXX_
  54 #include <comphelper/sequence.hxx>
  55 #endif
  56 #ifndef _COMPHELPER_ENUMHELPER_HXX_
  57 #include <comphelper/enumhelper.hxx>
  58 #endif
  59 #ifndef _COMPHELPER_EXTRACT_HXX_
  60 #include <comphelper/extract.hxx>
  61 #endif
  62 #ifndef _COM_SUN_STAR_LANG_XCOMPONENT_HPP_
  63 #include <com/sun/star/lang/XComponent.hpp>
  64 #endif
  65 #ifndef _COMPHELPER_TYPES_HXX_
  66 #include <comphelper/types.hxx>
  67 #endif
  68
  69 using namespace ::com::sun::star::uno;
  70 using namespace ::com::sun::star::lang;
  71 using namespace ::com::sun::star::beans;
  72 using namespace ::com::sun::star::container;
  73 using namespace ::osl;
  74 using namespace ::comphelper;
  75 using namespace ::cppu;
  76
  77 //........................................................................
  78 namespace dbaccess
  79 {
  80 //........................................................................
  81
  82 //==========================================================================
  83 //= OBookmarkContainer
  84 //==========================================================================
  85 DBG_NAME(OBookmarkContainer)
  86 //--------------------------------------------------------------------------
  87 OBookmarkContainer::OBookmarkContainer(OWeakObject& _rParent, Mutex& _rMutex)
  88     :m_rParent(_rParent)
  89     ,m_aContainerListeners(_rMutex)
  90     ,m_rMutex(_rMutex)
  91 {
  92     DBG_CTOR(OBookmarkContainer, NULL);
  93 }
  94
  95 //--------------------------------------------------------------------------
  96 void OBookmarkContainer::dispose()
  97 {
  98     MutexGuard aGuard(m_rMutex);
  99
 100     // say our listeners goobye
 101     EventObject aEvt(*this);
 102     m_aContainerListeners.disposeAndClear(aEvt);
 103
 104     // remove our elements
 105     m_aBookmarksIndexed.clear();
 106     m_aBookmarks.clear();
 107 }
 108
 109 //--------------------------------------------------------------------------
 110 void SAL_CALL OBookmarkContainer::acquire(  ) throw()
 111 {
 112     m_rParent.acquire();
 113 }
 114
 115 //--------------------------------------------------------------------------
 116 void SAL_CALL OBookmarkContainer::release(  ) throw()
 117 {
 118     m_rParent.release();
 119 }
 120
 121 //--------------------------------------------------------------------------
 122 OBookmarkContainer::~OBookmarkContainer()
 123 {
 124     DBG_DTOR(OBookmarkContainer, NULL);
 125 }
 126
 127 // XServiceInfo
 128 //--------------------------------------------------------------------------
 129 ::rtl::OUString SAL_CALL OBookmarkContainer::getImplementationName(  ) throw(RuntimeException)
 130 {
 131     return ::rtl::OUString::createFromAscii("com.sun.star.comp.dba.OBookmarkContainer");
 132 }
 133
 134 //--------------------------------------------------------------------------
 135 sal_Bool SAL_CALL OBookmarkContainer::supportsService( const ::rtl::OUString& _rServiceName ) throw (RuntimeException)
 136 {
 137     MutexGuard aGuard(m_rMutex);
 138     checkValid(sal_False);
 139     return findValue(getSupportedServiceNames(), _rServiceName, sal_True).getLength() != 0;
 140 }
 141
 142 //--------------------------------------------------------------------------
 143 Sequence< ::rtl::OUString > SAL_CALL OBookmarkContainer::getSupportedServiceNames(  ) throw(RuntimeException)
 144 {
 145     Sequence< ::rtl::OUString > aReturn(1);
 146     aReturn.getArray()[0] = ::rtl::OUString::createFromAscii("com.sun.star.sdb.DefinitionContainer");
 147     return aReturn;
 148 }
 149
 150 // XNameContainer
 151 //--------------------------------------------------------------------------
 152 void SAL_CALL OBookmarkContainer::insertByName( const ::rtl::OUString& _rName, const Any& aElement ) throw(IllegalArgumentException, ElementExistException, WrappedTargetException, RuntimeException)
 153 {
 154     MutexGuard aGuard(m_rMutex);
 155     checkValid(sal_True);
 156
 157     if (checkExistence(_rName))
 158         throw ElementExistException();
 159
 160     if (0 == _rName.getLength())
 161         throw IllegalArgumentException();
 162
 163     // approve the new object
 164     ::rtl::OUString sNewLink;
 165     if (!(aElement >>= sNewLink))
 166         throw IllegalArgumentException();
 167
 168
 169     implAppend(_rName, sNewLink);
 170
 171     // notify the listeners
 172     if (m_aContainerListeners.getLength())
 173     {
 174         ContainerEvent aEvent(*this, makeAny(_rName), makeAny(sNewLink), Any());
 175         OInterfaceIteratorHelper aListenerIterator(m_aContainerListeners);
 176         while (aListenerIterator.hasMoreElements())
 177             static_cast< XContainerListener* >(aListenerIterator.next())->elementInserted(aEvent);
 178     }
 179 }
 180
 181 //--------------------------------------------------------------------------
 182 void SAL_CALL OBookmarkContainer::removeByName( const ::rtl::OUString& _rName ) throw(NoSuchElementException, WrappedTargetException, RuntimeException)
 183 {
 184     ::rtl::OUString sOldBookmark;
 185     {
 186         MutexGuard aGuard(m_rMutex);
 187         checkValid(sal_True);
 188
 189         // check the arguments
 190         if (!_rName.getLength())
 191             throw IllegalArgumentException();
 192
 193         if (!checkExistence(_rName))
 194             throw NoSuchElementException();
 195
 196         // the old element (for the notifications)
 197         sOldBookmark = m_aBookmarks[_rName];
 198
 199         // do the removal
 200         implRemove(_rName);
 201     }
 202
 203     // notify the listeners
 204     if (m_aContainerListeners.getLength())
 205     {
 206         ContainerEvent aEvent(*this, makeAny(_rName), makeAny(sOldBookmark), Any());
 207         OInterfaceIteratorHelper aListenerIterator(m_aContainerListeners);
 208         while (aListenerIterator.hasMoreElements())
 209             static_cast< XContainerListener* >(aListenerIterator.next())->elementRemoved(aEvent);
 210     }
 211 }
 212
 213 // XNameReplace
 214 //--------------------------------------------------------------------------
 215 void SAL_CALL OBookmarkContainer::replaceByName( const ::rtl::OUString& _rName, const Any& aElement ) throw(IllegalArgumentException, NoSuchElementException, WrappedTargetException, RuntimeException)
 216 {
 217     ClearableMutexGuard aGuard(m_rMutex);
 218     checkValid(sal_True);
 219
 220     // check the arguments
 221     if (!_rName.getLength())
 222         throw IllegalArgumentException();
 223
 224     // do we have such an element?
 225     if (!checkExistence(_rName))
 226         throw NoSuchElementException();
 227
 228     // approve the new object
 229     ::rtl::OUString sNewLink;
 230     if (!(aElement >>= sNewLink))
 231         throw IllegalArgumentException();
 232
 233     // the old element (for the notifications)
 234     ::rtl::OUString sOldLink = m_aBookmarks[_rName];
 235
 236     // do the replace
 237     implReplace(_rName, sNewLink);
 238
 239     // notify the listeners
 240     aGuard.clear();
 241     if (m_aContainerListeners.getLength())
 242     {
 243         ContainerEvent aEvent(*this, makeAny(_rName), makeAny(sNewLink), makeAny(sOldLink));
 244         OInterfaceIteratorHelper aListenerIterator(m_aContainerListeners);
 245         while (aListenerIterator.hasMoreElements())
 246             static_cast< XContainerListener* >(aListenerIterator.next())->elementReplaced(aEvent);
 247     }
 248 }
 249
 250 //--------------------------------------------------------------------------
 251 void SAL_CALL OBookmarkContainer::addContainerListener( const Reference< XContainerListener >& _rxListener ) throw(RuntimeException)
 252 {
 253     MutexGuard aGuard(m_rMutex);
 254     if (_rxListener.is())
 255         m_aContainerListeners.addInterface(_rxListener);
 256 }
 257
 258 //--------------------------------------------------------------------------
 259 void SAL_CALL OBookmarkContainer::removeContainerListener( const Reference< XContainerListener >& _rxListener ) throw(RuntimeException)
 260 {
 261     MutexGuard aGuard(m_rMutex);
 262     if (_rxListener.is())
 263         m_aContainerListeners.removeInterface(_rxListener);
 264 }
 265
 266 // XElementAccess
 267 //--------------------------------------------------------------------------
 268 Type SAL_CALL OBookmarkContainer::getElementType( ) throw (RuntimeException)
 269 {
 270     MutexGuard aGuard(m_rMutex);
 271     checkValid(sal_False);
 272     return ::getCppuType( static_cast< ::rtl::OUString* >(NULL) );
 273 }
 274
 275 //--------------------------------------------------------------------------
 276 sal_Bool SAL_CALL OBookmarkContainer::hasElements( ) throw (RuntimeException)
 277 {
 278     MutexGuard aGuard(m_rMutex);
 279     checkValid(sal_False);
 280     return !m_aBookmarks.empty();
 281 }
 282
 283 // XEnumerationAccess
 284 //--------------------------------------------------------------------------
 285 Reference< XEnumeration > SAL_CALL OBookmarkContainer::createEnumeration(  ) throw(RuntimeException)
 286 {
 287     MutexGuard aGuard(m_rMutex);
 288     checkValid(sal_False);
 289     return new ::comphelper::OEnumerationByIndex(static_cast<XIndexAccess*>(this));
 290 }
 291
 292 //--------------------------------------------------------------------------
 293 // XIndexAccess
 294 sal_Int32 SAL_CALL OBookmarkContainer::getCount(  ) throw(RuntimeException)
 295 {
 296     MutexGuard aGuard(m_rMutex);
 297     checkValid(sal_False);
 298     return m_aBookmarks.size();
 299 }
 300
 301 //--------------------------------------------------------------------------
 302 Any SAL_CALL OBookmarkContainer::getByIndex( sal_Int32 _nIndex ) throw(IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
 303 {
 304     MutexGuard aGuard(m_rMutex);
 305     checkValid(sal_False);
 306
 307     if ((_nIndex < 0) || (_nIndex >= (sal_Int32)m_aBookmarksIndexed.size()))
 308         throw IndexOutOfBoundsException();
 309
 310     return makeAny(m_aBookmarksIndexed[_nIndex]->second);
 311 }
 312
 313 //--------------------------------------------------------------------------
 314 Any SAL_CALL OBookmarkContainer::getByName( const ::rtl::OUString& _rName ) throw(NoSuchElementException, WrappedTargetException, RuntimeException)
 315 {
 316     MutexGuard aGuard(m_rMutex);
 317     checkValid(sal_False);
 318
 319     if (!checkExistence(_rName))
 320         throw NoSuchElementException();
 321
 322     return makeAny(m_aBookmarks[_rName]);
 323 }
 324
 325 //--------------------------------------------------------------------------
 326 Sequence< ::rtl::OUString > SAL_CALL OBookmarkContainer::getElementNames(  ) throw(RuntimeException)
 327 {
 328     MutexGuard aGuard(m_rMutex);
 329     checkValid(sal_False);
 330
 331     Sequence< ::rtl::OUString > aNames(m_aBookmarks.size());
 332     ::rtl::OUString* pNames = aNames.getArray();
 333     ;
 334     for (       ConstMapIteratorVectorIterator aNameIter = m_aBookmarksIndexed.begin();
 335             aNameIter != m_aBookmarksIndexed.end();
 336             ++pNames, ++aNameIter
 337         )
 338     {
 339         *pNames = (*aNameIter)->first;
 340     }
 341
 342     return aNames;
 343 }
 344
 345 //--------------------------------------------------------------------------
 346 sal_Bool SAL_CALL OBookmarkContainer::hasByName( const ::rtl::OUString& _rName ) throw(RuntimeException)
 347 {
 348     MutexGuard aGuard(m_rMutex);
 349     checkValid(sal_False);
 350
 351     return checkExistence(_rName);
 352 }
 353
 354 //--------------------------------------------------------------------------
 355 void OBookmarkContainer::implRemove(const ::rtl::OUString& _rName)
 356 {
 357     MutexGuard aGuard(m_rMutex);
 358
 359     // look for the name in the index access vector
 360     MapString2StringIterator aMapPos = m_aBookmarks.end();
 361     for (       MapIteratorVectorIterator aSearch = m_aBookmarksIndexed.begin();
 362             aSearch != m_aBookmarksIndexed.end();
 363             ++aSearch
 364         )
 365     {
 366 #ifdef DBG_UTIL
 367         ::rtl::OUString sName = (*aSearch)->first;
 368 #endif
 369         if ((*aSearch)->first == _rName)
 370         {
 371             aMapPos = *aSearch;
 372             m_aBookmarksIndexed.erase(aSearch);
 373             break;
 374         }
 375     }
 376
 377     if (m_aBookmarks.end() == aMapPos)
 378     {
 379         DBG_ERROR("OBookmarkContainer::implRemove: inconsistence!");
 380         return;
 381     }
 382
 383     // remove the map entries
 384     m_aBookmarks.erase(aMapPos);
 385 }
 386
 387 //--------------------------------------------------------------------------
 388 void OBookmarkContainer::implAppend(const ::rtl::OUString& _rName, const ::rtl::OUString& _rDocumentLocation)
 389 {
 390     MutexGuard aGuard(m_rMutex);
 391
 392     OSL_ENSURE(m_aBookmarks.find(_rName) == m_aBookmarks.end(),"Bookmark already known!");
 393     m_aBookmarksIndexed.push_back(m_aBookmarks.insert(  MapString2String::value_type(_rName,_rDocumentLocation)).first);
 394 }
 395
 396 //--------------------------------------------------------------------------
 397 void OBookmarkContainer::implReplace(const ::rtl::OUString& _rName, const ::rtl::OUString& _rNewLink)
 398 {
 399     MutexGuard aGuard(m_rMutex);
 400     DBG_ASSERT(checkExistence(_rName), "OBookmarkContainer::implReplace : invalid name !");
 401
 402     m_aBookmarks[_rName] = _rNewLink;
 403 }
 404
 405 //--------------------------------------------------------------------------
 406 void OBookmarkContainer::checkValid(sal_Bool /*_bIntendWriteAccess*/) const throw (RuntimeException, DisposedException)
 407 {
 408 }
 409
 410 //--------------------------------------------------------------------------
 411 Reference< XInterface > SAL_CALL OBookmarkContainer::getParent(  ) throw (RuntimeException)
 412 {
 413     return m_rParent;
 414 }
 415
 416 //--------------------------------------------------------------------------
 417 void SAL_CALL OBookmarkContainer::setParent( const Reference< XInterface >& /*Parent*/ ) throw (NoSupportException, RuntimeException)
 418 {
 419     throw NoSupportException();
 420 }
 421
 422 //........................................................................
 423 }       // namespace dbaccess
 424 //........................................................................