blob: eb1d1802027a069d4040a7bf87b8ca3283b682cc [file] [log] [blame]
/**************************************************************
*
* 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 _DBACORE_DEFINITIONCOLUMN_HXX_
#define _DBACORE_DEFINITIONCOLUMN_HXX_
#include "apitools.hxx"
#include "column.hxx"
#include "columnsettings.hxx"
#include <com/sun/star/sdbc/DataType.hpp>
#include <com/sun/star/sdbc/ColumnValue.hpp>
#include <com/sun/star/container/XChild.hpp>
#include <comphelper/IdPropArrayHelper.hxx>
#include <comphelper/uno3.hxx>
#include <cppuhelper/implbase1.hxx>
namespace dbaccess
{
typedef ::cppu::ImplHelper1< ::com::sun::star::container::XChild > TXChild;
// =========================================================================
//= OTableColumnDescriptor
// =========================================================================
/**
* provides the properties for description. A descriptor could be used to create a new table column.
*/
class OTableColumnDescriptor : public OColumn
,public OColumnSettings
,public ::comphelper::OPropertyArrayUsageHelper < OTableColumnDescriptor >
,public TXChild
{
::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > m_xParent;
const bool m_bActAsDescriptor;
protected:
// <properties>
rtl::OUString m_aTypeName;
rtl::OUString m_aDescription;
rtl::OUString m_aDefaultValue;
rtl::OUString m_aAutoIncrementValue;
sal_Int32 m_nType;
sal_Int32 m_nPrecision;
sal_Int32 m_nScale;
sal_Int32 m_nIsNullable;
sal_Bool m_bAutoIncrement;
sal_Bool m_bRowVersion;
sal_Bool m_bCurrency;
// </properties>
public:
OTableColumnDescriptor( const bool _bActAsDescriptor )
:OColumn( !_bActAsDescriptor )
,m_bActAsDescriptor( _bActAsDescriptor )
,m_nType( ::com::sun::star::sdbc::DataType::SQLNULL )
,m_nPrecision( 0 )
,m_nScale( 0 )
,m_nIsNullable( ::com::sun::star::sdbc::ColumnValue::NULLABLE_UNKNOWN )
,m_bAutoIncrement( sal_False )
,m_bRowVersion( sal_False )
,m_bCurrency( sal_False )
{
impl_registerProperties();
}
DECLARE_XINTERFACE( )
// com::sun::star::lang::XTypeProvider
virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException);
// ::com::sun::star::lang::XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName( ) 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);
// ::comphelper::OPropertyArrayUsageHelper
virtual ::cppu::IPropertyArrayHelper* createArrayHelper() const;
// ::cppu::OPropertySetHelper
virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue ) throw (::com::sun::star::uno::Exception);
private:
void impl_registerProperties();
};
// =========================================================================
// = OTableColumn
// =========================================================================
class OTableColumn;
typedef ::comphelper::OPropertyArrayUsageHelper < OTableColumn > OTableColumn_PBase;
/** describes a column of a table
*/
class OTableColumn :public OTableColumnDescriptor
,public OTableColumn_PBase
{
protected:
virtual ~OTableColumn();
public:
OTableColumn(const ::rtl::OUString& _rName);
// XTypeProvider
virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException);
// XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName( ) throw(::com::sun::star::uno::RuntimeException);
// OPropertyArrayUsageHelper
virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
virtual ::cppu::IPropertyArrayHelper* createArrayHelper() const;
};
// =========================================================================
// = OQueryColumn
// =========================================================================
class OQueryColumn;
typedef ::comphelper::OPropertyArrayUsageHelper< OQueryColumn > OQueryColumn_PBase;
/** a column of a Query, with additional information obtained from parsing the query statement
*/
class OQueryColumn :public OTableColumnDescriptor
,public OQueryColumn_PBase
{
// <properties>
::rtl::OUString m_sCatalogName;
::rtl::OUString m_sSchemaName;
::rtl::OUString m_sTableName;
::rtl::OUString m_sRealName;
::rtl::OUString m_sLabel;
// </properties>
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet > m_xOriginalTableColumn;
protected:
~OQueryColumn();
public:
OQueryColumn(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxParserColumn,
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
const ::rtl::OUString i_sLabel
);
// XTypeProvider
virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException);
// XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName( ) throw(::com::sun::star::uno::RuntimeException);
// *Property*
virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
virtual ::cppu::IPropertyArrayHelper* createArrayHelper() const;
virtual void SAL_CALL getFastPropertyValue( ::com::sun::star::uno::Any& rValue, sal_Int32 nHandle ) const;
private:
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
impl_determineOriginalTableColumn(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection
);
using ::cppu::OPropertySetHelper::getFastPropertyValue;
};
// =========================================================================
// = OColumnWrapper
// =========================================================================
/**
* describes all properties for a columns of a table. Only the view parts are provided
* directly, all the other parts are derived from a driver implementation
*/
class OColumnWrapper :public OColumn
{
protected:
// definition which is provided by a driver!
::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >
m_xAggregate;
sal_Int32 m_nColTypeID;
protected:
OColumnWrapper( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rCol, const bool _bNameIsReadOnly );
virtual ~OColumnWrapper();
public:
virtual void SAL_CALL getFastPropertyValue(
::com::sun::star::uno::Any& rValue,
sal_Int32 nHandle
) const;
virtual sal_Bool SAL_CALL convertFastPropertyValue(
::com::sun::star::uno::Any & rConvertedValue,
::com::sun::star::uno::Any & rOldValue,
sal_Int32 nHandle,
const ::com::sun::star::uno::Any& rValue )
throw (::com::sun::star::lang::IllegalArgumentException);
virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
sal_Int32 nHandle,
const ::com::sun::star::uno::Any& rValue
)
throw (::com::sun::star::uno::Exception);
virtual sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence< sal_Int8 >& aIdentifier ) throw(::com::sun::star::uno::RuntimeException);
protected:
::rtl::OUString impl_getPropertyNameFromHandle( const sal_Int32 _nHandle ) const;
protected:
using OColumn::getFastPropertyValue;
};
// =========================================================================
// = OTableColumnDescriptorWrapper
// =========================================================================
/**
* provides the properties for description. A descriptor could be used to create a new table column.
*/
class OTableColumnDescriptorWrapper :public OColumnWrapper
,public OColumnSettings
,public ::comphelper::OIdPropertyArrayUsageHelper < OTableColumnDescriptorWrapper >
{
const bool m_bPureWrap;
const bool m_bIsDescriptor;
public:
OTableColumnDescriptorWrapper(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rCol,
const bool _bPureWrap, const bool _bIsDescriptor );
// com::sun::star::lang::XTypeProvider
virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException);
// ::com::sun::star::lang::XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName( ) throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames( ) throw(::com::sun::star::uno::RuntimeException);
// OIdPropertyArrayUsageHelper
virtual ::cppu::IPropertyArrayHelper* createArrayHelper(sal_Int32 nId) const;
// cppu::OPropertySetHelper
virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
virtual void SAL_CALL getFastPropertyValue(
::com::sun::star::uno::Any& rValue,
sal_Int32 nHandle
) const;
virtual sal_Bool SAL_CALL convertFastPropertyValue(
::com::sun::star::uno::Any & rConvertedValue,
::com::sun::star::uno::Any & rOldValue,
sal_Int32 nHandle,
const ::com::sun::star::uno::Any& rValue )
throw (::com::sun::star::lang::IllegalArgumentException);
virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
sal_Int32 nHandle,
const ::com::sun::star::uno::Any& rValue
)
throw (::com::sun::star::uno::Exception);
protected:
using OColumnWrapper::getFastPropertyValue;
};
// =========================================================================
// = OTableColumnWrapper
// =========================================================================
/**
* describes all properties for a columns of a table. Only the view parts are provided
* directly, all the other parts are derived from a driver implementation
*/
class OTableColumnWrapper :public OTableColumnDescriptorWrapper
,public ::comphelper::OIdPropertyArrayUsageHelper < OTableColumnWrapper >
{
protected:
~OTableColumnWrapper();
public:
OTableColumnWrapper( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rCol,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& rColDefintion,
const bool _bPureWrap );
// ::com::sun::star::lang::XTypeProvider
virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() throw (::com::sun::star::uno::RuntimeException);
// ::com::sun::star::lang::XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName( ) throw(::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames( ) throw(::com::sun::star::uno::RuntimeException);
// OIdPropertyArrayUsageHelper
virtual ::cppu::IPropertyArrayHelper& SAL_CALL getInfoHelper();
virtual ::cppu::IPropertyArrayHelper* createArrayHelper(sal_Int32 nId) const;
};
}
#endif // _DBACORE_DEFINITIONCOLUMN_HXX_