mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ec6f9da8e8e6e6026b64df852b6db70fb8b644b3
libreoffice/dbaccess/source/core/dataaccess/bookmarkcontainer.hxx

272 lines
13 KiB
C++
Raw Blame History

/*************************************************************************
*
* $RCSfile: bookmarkcontainer.hxx,v $
*
* $Revision: 1.1 $
*
* last change: $Author: fs $ $Date: 2001-04-26 11:22:30 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _DBA_CORE_BOOKMARKCONTAINER_HXX_
#define _DBA_CORE_BOOKMARKCONTAINER_HXX_
#ifndef _CPPUHELPER_INTERFACECONTAINER_HXX_
#include <cppuhelper/interfacecontainer.hxx>
#endif
#ifndef _CPPUHELPER_IMPLBASE6_HXX_
#include <cppuhelper/implbase6.hxx>
#endif
#ifndef _COMPHELPER_STLTYPES_HXX_
#include <comphelper/stl_types.hxx>
#endif
#ifndef _OSL_MUTEX_HXX_
#include <osl/mutex.hxx>
#endif
#ifndef _DBA_CONFIGNODE_HXX_
#include "confignode.hxx"
#endif
#ifndef _DBA_CORE_CONFIGURATIONFLUSHABLE_HXX_
#include "configurationflushable.hxx"
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XCHILD_HPP_
#include <com/sun/star/container/XChild.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XNAMECONTAINER_HPP_
#include <com/sun/star/container/XNameContainer.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XCONTAINER_HPP_
#include <com/sun/star/container/XContainer.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XENUMERATIONACCESS_HPP_
#include <com/sun/star/container/XEnumerationAccess.hpp>
#endif
#ifndef _COM_SUN_STAR_CONTAINER_XINDEXACCESS_HPP_
#include <com/sun/star/container/XIndexAccess.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
#include <com/sun/star/lang/XServiceInfo.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_XSINGLESERVICEFACTORY_HPP_
#include <com/sun/star/lang/XSingleServiceFactory.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
#include <com/sun/star/beans/XPropertySet.hpp>
#endif
#ifndef _COM_SUN_STAR_LANG_DISPOSEDEXCEPTION_HPP_
#include <com/sun/star/lang/DisposedException.hpp>
#endif
//........................................................................
namespace dbaccess
{
//........................................................................
//==========================================================================
//= OBookmarkContainer - base class of collections of database definition
//= documents
//==========================================================================
typedef ::cppu::WeakImplHelper6 <
::com::sun::star::container::XIndexAccess
, ::com::sun::star::container::XNameContainer
, ::com::sun::star::container::XEnumerationAccess
, ::com::sun::star::container::XContainer
, ::com::sun::star::lang::XServiceInfo
, ::com::sun::star::container::XChild
> OBookmarkContainer_Base;
class OBookmarkContainer
:public OBookmarkContainer_Base
,public OConfigurationFlushable
{
protected:
DECLARE_STL_USTRINGACCESS_MAP(::rtl::OUString, MapString2String);
DECLARE_STL_USTRINGACCESS_MAP(OConfigurationNode, ConfigNodeMap);
DECLARE_STL_VECTOR(MapString2StringIterator, MapIteratorVector);
MapString2String m_aBookmarks; // the bookmarks itself
ConfigNodeMap m_aObjectKeys; // the top level keys for the object persistence
MapIteratorVector m_aBookmarksIndexed; // for index access to the
protected:
::cppu::OWeakObject& m_rParent; // for the ref counting
::cppu::OInterfaceContainerHelper
m_aContainerListeners;
sal_Bool m_bInitialized : 1; // the late ctor (initialize) was called ?
public:
/** constructs the container.<BR>
after the construction of the object the creator has to call <code>initialize</code>.
@param _rParent the parent object which is used for ref counting
@param _rMutex the parent's mutex object for access safety
*/
OBookmarkContainer(
::cppu::OWeakObject& _rParent,
::osl::Mutex& _rMutex
);
/** looks like the dtor ...
*/
virtual ~OBookmarkContainer();
// ::com::sun::star::uno::XInterface
virtual void SAL_CALL acquire( ) throw(::com::sun::star::uno::RuntimeException) { m_rParent.acquire(); }
virtual void SAL_CALL release( ) throw(::com::sun::star::uno::RuntimeException) { m_rParent.release(); }
// ::com::sun::star::lang::XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName( ) throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames( ) throw(::com::sun::star::uno::RuntimeException);
// ::com::sun::star::container::XElementAccess
virtual ::com::sun::star::uno::Type SAL_CALL getElementType( ) throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL hasElements( ) throw(::com::sun::star::uno::RuntimeException);
// ::com::sun::star::container::XEnumerationAccess
virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XEnumeration > SAL_CALL createEnumeration( ) throw(::com::sun::star::uno::RuntimeException);
// ::com::sun::star::container::XIndexAccess
virtual sal_Int32 SAL_CALL getCount( ) throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( sal_Int32 _nIndex ) throw(::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
// ::com::sun::star::container::XNameContainer
virtual void SAL_CALL insertByName( const ::rtl::OUString& _rName, const ::com::sun::star::uno::Any& aElement ) throw(::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::ElementExistException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeByName( const ::rtl::OUString& _rName ) throw(::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
// ::com::sun::star::container::XNameReplace
virtual void SAL_CALL replaceByName( const ::rtl::OUString& _rName, const ::com::sun::star::uno::Any& aElement ) throw(::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
// ::com::sun::star::container::XNameAccess
virtual ::com::sun::star::uno::Any SAL_CALL getByName( const ::rtl::OUString& aName ) throw(::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames( ) throw(::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName ) throw(::com::sun::star::uno::RuntimeException);
// ::com::sun::star::container::XContainer
virtual void SAL_CALL addContainerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener ) throw(::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeContainerListener( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener >& xListener ) throw(::com::sun::star::uno::RuntimeException);
// ::com::sun::star::container::XChild
virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getParent( ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setParent( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& Parent ) throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
// helper
/** late construction, to be called after the construction of the object
@see dispose
@param _rConfigurationRoot the configuration node which is the root for all document informations
@param _bRead if sal_True, the objects data is initialized with the data stored under
the given config node, else only the config node is saved (and propagated
to all descendants which need to know it).
*/
virtual void initialize(const OConfigurationTreeRoot& _rConfigurationRoot, sal_Bool _bRead = sal_True);
/** tell the container to free all resources. After that it's in a state like after the construction, i.e.
you may call <code>initialize</code> again (maybe with another configuration node).
*/
virtual void dispose();
/// flush all persistent information (into the configuration)
virtual void flush_NoBroadcast_NoCommit();
OConfigurationNode getConfigLocation() const { return m_aConfigurationNode; }
protected:
/** checks whether the object is basically alive, i.e. it has been fully initialized (@see initialize) and
not disposed (@see dispose)
@param _bIntendWriteAccess determines whether or not the caller intends to modify the configuration.
if sal_True and the configuration is readonly, a runtime exception with
a description string is thrown.
*/
void checkValid(sal_Bool _bIntendWriteAccess) const throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::DisposedException);
/** checks whether or not the configuration data the object is based on is readonly
*/
sal_Bool isReadOnly() const;
/** quickly checks if there already is an element with a given name. No access to the configuration occures, i.e.
if there is such an object which is not already loaded, it won't be loaded now.
@param _rName the object name to check
@return sal_True if there already exists such an object
*/
inline sal_Bool checkExistence(const ::rtl::OUString& _rName);
void implAppend(
const ::rtl::OUString& _rName,
const ::rtl::OUString& _rDocumentLocation,
const OConfigurationNode& _rObjectNode
);
void implRemove(const ::rtl::OUString& _rName);
void implReplace(
const ::rtl::OUString& _rName,
const ::rtl::OUString& _rNewLink);
private:
void initializeFromConfiguration();
};
//--------------------------------------------------------------------------
inline sal_Bool OBookmarkContainer::checkExistence(const ::rtl::OUString& _rName)
{
return m_aBookmarks.find(_rName) != m_aBookmarks.end();
}
//........................................................................
} // namespace dbaccess
//........................................................................
#endif // _DBA_CORE_BOOKMARKCONTAINER_HXX_
Reference in New Issue View Git Blame Copy Permalink