AOO410/main/dbaccess/source/core/inc/column.hxx

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef _DBA_COREAPI_COLUMN_HXX_
#define _DBA_COREAPI_COLUMN_HXX_

#include "columnsettings.hxx"

#include <com/sun/star/container/XChild.hpp>
#include <com/sun/star/container/XEnumerationAccess.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/io/IOException.hpp>
#include <com/sun/star/io/XObjectInputStream.hpp>
#include <com/sun/star/io/XObjectOutputStream.hpp>
#include <com/sun/star/lang/WrappedTargetException.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XUnoTunnel.hpp>
#include <com/sun/star/sdbc/XResultSet.hpp>
#include <com/sun/star/sdbcx/XAppend.hpp>
#include <com/sun/star/sdbcx/XDrop.hpp>
#include <com/sun/star/util/XNumberFormatsSupplier.hpp>

#include <comphelper/broadcasthelper.hxx>
#include <comphelper/proparrhlp.hxx>
#include <comphelper/propertycontainer.hxx>
#include <comphelper/stl_types.hxx>
#include <connectivity/CommonTools.hxx>
#include <connectivity/FValue.hxx>
#include <connectivity/TColumnsHelper.hxx>
#include <connectivity/sdbcx/IRefreshable.hxx>
#include <cppuhelper/compbase2.hxx>
#include <cppuhelper/compbase4.hxx>
#include <cppuhelper/implbase1.hxx>
#include <cppuhelper/propshlp.hxx>
#include <osl/diagnose.h>

#include <hash_map>

namespace dbaccess
{

	//************************************************************
	//  OColumn
	//************************************************************
	typedef ::cppu::WeakComponentImplHelper2<	::com::sun::star::lang::XServiceInfo,
												::com::sun::star::container::XNamed
                                            >   OColumnBase;

	//------------------------------------------------------------
	class OColumn	:public comphelper::OBaseMutex
					,public OColumnBase
                    ,public ::comphelper::OPropertyContainer
                    ,public IPropertyContainer  // convenience for the derived class which also derive from OColumnSettings
	{
		friend class OColumns;

	protected:
        // <properties>
		::rtl::OUString m_sName;
        // </properties>

	protected:
		OColumn( const bool _bNameIsReadOnly );

	public:
		virtual ~OColumn();

	// com::sun::star::lang::XTypeProvider
		virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes() throw (::com::sun::star::uno::RuntimeException);
		virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException) = 0;

	// com::sun::star::uno::XInterface
		virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType ) throw (::com::sun::star::uno::RuntimeException);
		virtual void SAL_CALL acquire() throw();
		virtual void SAL_CALL release() throw();

	// com::sun::star::beans::XPropertySet
		virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) throw(::com::sun::star::uno::RuntimeException);

	// cppu::OComponentHelper
		virtual void SAL_CALL disposing(void);

	// ::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);

		// XNamed
		virtual ::rtl::OUString SAL_CALL getName(  ) throw(::com::sun::star::uno::RuntimeException);
		virtual void SAL_CALL setName( const ::rtl::OUString& _rName ) throw(::com::sun::star::uno::RuntimeException);

		virtual void fireValueChange( const ::connectivity::ORowSetValue& _rOldValue );

    protected:
        // IPropertyContainer
	    virtual void registerProperty( const ::rtl::OUString& _rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, void* _pPointerToMember, const ::com::sun::star::uno::Type& _rMemberType );
	    virtual void registerMayBeVoidProperty( const ::rtl::OUString& _rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, ::com::sun::star::uno::Any* _pPointerToMember, const ::com::sun::star::uno::Type& _rExpectedType );
	    virtual void registerPropertyNoMember( const ::rtl::OUString& _rName, sal_Int32 _nHandle, sal_Int32 _nAttributes, const ::com::sun::star::uno::Type& _rType, const void* _pInitialValue );
	};

	//============================================================
	//= IColumnFactory - used by OColumns for creating new columns
	//============================================================
	class SAL_NO_VTABLE IColumnFactory
	{
	public:
        /** creates a OColumn object which should represent the column with a given name
        */
		virtual OColumn*
            createColumn( const ::rtl::OUString& _rName ) const = 0;

        /** creates a column descriptor object.

            A column descriptor object is used to append new columns to the collection. If such an append
            actually happened, columnAppended is called afterwards.
        */
		virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > createColumnDescriptor() = 0;

        /** notifies that a column, created from a column descriptor, has been appended
        */
        virtual void columnAppended( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxSourceDescriptor ) = 0;

        /** notifies that a column with a given name has been dropped
        */
		virtual void columnDropped( const ::rtl::OUString& _sName ) = 0;
	};

	//============================================================
	//= OColumns
	//= general columns map, could be used for readonly access
	//= no appending and dropping is supported
	//============================================================
	typedef ::std::hash_map<rtl::OUString, OColumn*, ::comphelper::UStringMixHash, ::comphelper::UStringMixEqual> OColumnMap;
	typedef ::std::vector<OColumn*> OColumnArray;

	class OContainerMediator;
	typedef ::cppu::ImplHelper1< ::com::sun::star::container::XChild > TXChild;
	typedef connectivity::OColumnsHelper OColumns_BASE;
	//------------------------------------------------------------
	class OColumns : public OColumns_BASE
					,public TXChild
	{
		OContainerMediator*		m_pMediator;

	protected:
		// comes from the driver can be null
		::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >	m_xDrvColumns;
		::com::sun::star::uno::WeakReference< ::com::sun::star::uno::XInterface >		m_xParent;
		IColumnFactory*								m_pColFactoryImpl;
		::connectivity::sdbcx::IRefreshableColumns* m_pRefreshColumns;

		sal_Bool									m_bInitialized	: 1;
		sal_Bool									m_bAddColumn	: 1;
		sal_Bool									m_bDropColumn	: 1;

		virtual void impl_refresh() throw(::com::sun::star::uno::RuntimeException);
		virtual connectivity::sdbcx::ObjectType createObject(const ::rtl::OUString& _rName);
		virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > createDescriptor();
        virtual connectivity::sdbcx::ObjectType appendObject( const ::rtl::OUString& _rForName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& descriptor );
		virtual void dropObject(sal_Int32 _nPos,const ::rtl::OUString _sElementName);

	public:
		connectivity::sdbcx::ObjectType createBaseObject(const ::rtl::OUString& _rName)
		{
			return OColumns_BASE::createObject(_rName);
		}
		/** flag which determines whether the container is filled or not
		*/
		inline sal_Bool	isInitialized() const { return m_bInitialized; }
		inline void		setInitialized() {m_bInitialized = sal_True;}
		inline void		setMediator(OContainerMediator* _pMediator) { m_pMediator = _pMediator; }

	public:
		/** constructs an empty container without configuration location.
			@param		rParent				the parent object. This instance will be used for refcounting, so the parent
											cannot die before the container does.
			@param		_rMutex				the mutex of the parent.
			@param		_bCaseSensitive		the initial case sensitivity flag
			@see		setCaseSensitive
		*/
		OColumns(
				::cppu::OWeakObject& _rParent,
				::osl::Mutex& _rMutex,
				sal_Bool _bCaseSensitive,
				const ::std::vector< ::rtl::OUString>& _rVector,
				IColumnFactory* _pColFactory,
				::connectivity::sdbcx::IRefreshableColumns* _pRefresh,
				sal_Bool _bAddColumn = sal_False,
				sal_Bool _bDropColumn = sal_False,
				sal_Bool _bUseHardRef = sal_True);

		OColumns(
			::cppu::OWeakObject& _rParent,
			::osl::Mutex& _rMutex, 
			const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& _rxDrvColumns,
			sal_Bool _bCaseSensitive,
			const ::std::vector< ::rtl::OUString> &_rVector,
			IColumnFactory* _pColFactory,
			::connectivity::sdbcx::IRefreshableColumns* _pRefresh,
			sal_Bool _bAddColumn = sal_False,
			sal_Bool _bDropColumn = sal_False,
			sal_Bool _bUseHardRef = sal_True);
		virtual ~OColumns();

		//XInterface
		virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType ) throw(::com::sun::star::uno::RuntimeException);
		virtual void SAL_CALL acquire() throw() { OColumns_BASE::acquire(); }
		virtual void SAL_CALL release() throw() { OColumns_BASE::release(); }
		//XTypeProvider
		virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes(  ) throw(::com::sun::star::uno::RuntimeException);

	// ::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::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);

		void append(const ::rtl::OUString& rName, OColumn*);
		void clearColumns();
		// only the name is identical to ::cppu::OComponentHelper
		virtual void SAL_CALL disposing(void);

    private:
        using OColumns_BASE::setParent;
	};
}
#endif // _DBA_COREAPI_COLUMN_HXX_