/**************************************************************
*
* 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.
*
*************************************************************/
// MARKER(update_precomp.py): autogen include statement, do not remove
#include "precompiled_connectivity.hxx"
#include "connectivity/formattedcolumnvalue.hxx"
#include "connectivity/dbtools.hxx"
#include "connectivity/dbconversion.hxx"
/** === begin UNO includes === **/
#include <com/sun/star/util/XNumberFormatter.hpp>
#include <com/sun/star/util/Date.hpp>
#include <com/sun/star/sdbc/XConnection.hpp>
#include <com/sun/star/util/XNumberFormatTypes.hpp>
#include <com/sun/star/util/NumberFormat.hpp>
#include <com/sun/star/sdbc/DataType.hpp>
/** === end UNO includes === **/
//#include <unotools/syslocale.hxx>
#include <tools/diagnose_ex.h>
#include <i18npool/mslangid.hxx>
#include <comphelper/numbers.hxx>
#include <comphelper/componentcontext.hxx>
#include <unotools/sharedunocomponent.hxx>
//........................................................................
namespace dbtools
{
//........................................................................
/** === begin UNO using === **/
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::UNO_QUERY;
using ::com::sun::star::uno::UNO_QUERY_THROW;
using ::com::sun::star::uno::UNO_SET_THROW;
using ::com::sun::star::uno::Exception;
using ::com::sun::star::uno::RuntimeException;
using ::com::sun::star::uno::Any;
using ::com::sun::star::uno::makeAny;
using ::com::sun::star::sdbc::XRowSet;
using ::com::sun::star::beans::XPropertySet;
using ::com::sun::star::util::XNumberFormatter;
using ::com::sun::star::util::Date;
using ::com::sun::star::sdbc::XConnection;
using ::com::sun::star::util::XNumberFormatsSupplier;
using ::com::sun::star::beans::XPropertySetInfo;
using ::com::sun::star::lang::Locale;
using ::com::sun::star::util::XNumberFormatTypes;
using ::com::sun::star::sdb::XColumn;
using ::com::sun::star::sdb::XColumnUpdate;
using ::com::sun::star::lang::XComponent;
/** === end UNO using === **/
namespace DataType = ::com::sun::star::sdbc::DataType;
namespace NumberFormat = ::com::sun::star::util::NumberFormat;
//====================================================================
//= FormattedColumnValue_Data
//====================================================================
struct FormattedColumnValue_Data
{
Reference< XNumberFormatter > m_xFormatter;
Date m_aNullDate;
sal_Int32 m_nFormatKey;
sal_Int32 m_nFieldType;
sal_Int16 m_nKeyType;
bool m_bNumericField;
Reference< XColumn > m_xColumn;
Reference< XColumnUpdate > m_xColumnUpdate;
FormattedColumnValue_Data()
:m_xFormatter()
,m_aNullDate( DBTypeConversion::getStandardDate() )
,m_nFormatKey( 0 )
,m_nFieldType( DataType::OTHER )
,m_nKeyType( NumberFormat::UNDEFINED )
,m_bNumericField( false )
,m_xColumn()
,m_xColumnUpdate()
{
}
};
//--------------------------------------------------------------------
namespace
{
//................................................................
void lcl_clear_nothrow( FormattedColumnValue_Data& _rData )
{
_rData.m_xFormatter.clear();
_rData.m_nFormatKey = 0;
_rData.m_nFieldType = DataType::OTHER;
_rData.m_nKeyType = NumberFormat::UNDEFINED;
_rData.m_bNumericField = false;
_rData.m_xColumn.clear();
_rData.m_xColumnUpdate.clear();
}
//................................................................
void lcl_initColumnDataValue_nothrow( FormattedColumnValue_Data& _rData,
const Reference< XNumberFormatter >& i_rNumberFormatter, const Reference< XPropertySet >& _rxColumn )
{
lcl_clear_nothrow( _rData );
OSL_PRECOND( i_rNumberFormatter.is(), "lcl_initColumnDataValue_nothrow: no number formats -> no formatted values!" );
if ( !i_rNumberFormatter.is() )
return;
try
{
Reference< XNumberFormatsSupplier > xNumberFormatsSupp( i_rNumberFormatter->getNumberFormatsSupplier(), UNO_SET_THROW );
// remember the column
_rData.m_xColumn.set( _rxColumn, UNO_QUERY_THROW );
_rData.m_xColumnUpdate.set( _rxColumn, UNO_QUERY );
// determine the field type, and whether it's a numeric field
OSL_VERIFY( _rxColumn->getPropertyValue( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Type" ) ) ) >>= _rData.m_nFieldType );
switch ( _rData.m_nFieldType )
{
case DataType::DATE:
case DataType::TIME:
case DataType::TIMESTAMP:
case DataType::BIT:
case DataType::BOOLEAN:
case DataType::TINYINT:
case DataType::SMALLINT:
case DataType::INTEGER:
case DataType::REAL:
case DataType::BIGINT:
case DataType::DOUBLE:
case DataType::NUMERIC:
case DataType::DECIMAL:
_rData.m_bNumericField = true;
break;
default:
_rData.m_bNumericField = false;
break;
}
// get the format key of our bound field
Reference< XPropertySetInfo > xPSI( _rxColumn->getPropertySetInfo(), UNO_QUERY_THROW );
bool bHaveFieldFormat = false;
const ::rtl::OUString sFormatKeyProperty( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "FormatKey" ) ) );
if ( xPSI->hasPropertyByName( sFormatKeyProperty ) )
{
bHaveFieldFormat = ( _rxColumn->getPropertyValue( sFormatKeyProperty ) >>= _rData.m_nFormatKey );
}
if ( !bHaveFieldFormat )
{
// fall back to a format key as indicated by the field type
Locale aSystemLocale;
MsLangId::convertLanguageToLocale( MsLangId::getSystemLanguage(), aSystemLocale );
Reference< XNumberFormatTypes > xNumTypes( xNumberFormatsSupp->getNumberFormats(), UNO_QUERY_THROW );
_rData.m_nFormatKey = getDefaultNumberFormat( _rxColumn, xNumTypes, aSystemLocale );
}
// some more formatter settings
_rData.m_nKeyType = ::comphelper::getNumberFormatType( xNumberFormatsSupp->getNumberFormats(), _rData.m_nFormatKey );
Reference< XPropertySet > xFormatSettings( xNumberFormatsSupp->getNumberFormatSettings(), UNO_QUERY_THROW );
OSL_VERIFY( xFormatSettings->getPropertyValue( ::rtl::OUString::createFromAscii( "NullDate" ) ) >>= _rData.m_aNullDate );
// remember the formatter
_rData.m_xFormatter = i_rNumberFormatter;
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
}
//................................................................
void lcl_initColumnDataValue_nothrow( const ::comphelper::ComponentContext& i_rContext, FormattedColumnValue_Data& i_rData,
const Reference< XRowSet >& i_rRowSet, const Reference< XPropertySet >& i_rColumn )
{
OSL_PRECOND( i_rRowSet.is(), "lcl_initColumnDataValue_nothrow: no row set!" );
if ( !i_rRowSet.is() )
return;
Reference< XNumberFormatter > xNumberFormatter;
try
{
// get the number formats supplier of the connection of the form
Reference< XConnection > xConnection( getConnection( i_rRowSet ), UNO_QUERY_THROW );
Reference< XNumberFormatsSupplier > xSupplier( getNumberFormats( xConnection, sal_True, i_rContext.getLegacyServiceFactory() ), UNO_SET_THROW );
// create a number formatter for it
xNumberFormatter.set( i_rContext.createComponent( "com.sun.star.util.NumberFormatter" ), UNO_QUERY_THROW );
xNumberFormatter->attachNumberFormatsSupplier( xSupplier );
}
catch( const Exception& )
{
DBG_UNHANDLED_EXCEPTION();
}
lcl_initColumnDataValue_nothrow( i_rData, xNumberFormatter, i_rColumn );
}
}
//====================================================================
//= FormattedColumnValue
//====================================================================
//--------------------------------------------------------------------
FormattedColumnValue::FormattedColumnValue( const ::comphelper::ComponentContext& i_rContext,
const Reference< XRowSet >& _rxRowSet, const Reference< XPropertySet >& i_rColumn )
:m_pData( new FormattedColumnValue_Data )
{
lcl_initColumnDataValue_nothrow( i_rContext, *m_pData, _rxRowSet, i_rColumn );
}
//--------------------------------------------------------------------
FormattedColumnValue::FormattedColumnValue( const Reference< XNumberFormatter >& i_rNumberFormatter,
const Reference< XPropertySet >& _rxColumn )
:m_pData( new FormattedColumnValue_Data )
{
lcl_initColumnDataValue_nothrow( *m_pData, i_rNumberFormatter, _rxColumn );
}
//--------------------------------------------------------------------
void FormattedColumnValue::clear()
{
lcl_clear_nothrow( *m_pData );
}
//--------------------------------------------------------------------
FormattedColumnValue::~FormattedColumnValue()
{
clear();
}
//--------------------------------------------------------------------
sal_Int32 FormattedColumnValue::getFormatKey() const
{
return m_pData->m_nFormatKey;
}
//--------------------------------------------------------------------
sal_Int32 FormattedColumnValue::getFieldType() const
{
return m_pData->m_nFieldType;
}
//--------------------------------------------------------------------
sal_Int16 FormattedColumnValue::getKeyType() const
{
return m_pData->m_nKeyType;
}
//--------------------------------------------------------------------
bool FormattedColumnValue::isNumericField() const
{
return m_pData->m_bNumericField;
}
//--------------------------------------------------------------------
const Reference< XColumn >& FormattedColumnValue::getColumn() const
{
return m_pData->m_xColumn;
}
//--------------------------------------------------------------------
const Reference< XColumnUpdate >& FormattedColumnValue::getColumnUpdate() const
{
return m_pData->m_xColumnUpdate;
}
//--------------------------------------------------------------------
bool FormattedColumnValue::setFormattedValue( const ::rtl::OUString& _rFormattedStringValue ) const
{
OSL_PRECOND( m_pData->m_xColumnUpdate.is(), "FormattedColumnValue::setFormattedValue: no column!" );
if ( !m_pData->m_xColumnUpdate.is() )
return false;
try
{
if ( m_pData->m_bNumericField )
{
::dbtools::DBTypeConversion::setValue( m_pData->m_xColumnUpdate, m_pData->m_xFormatter, m_pData->m_aNullDate,
_rFormattedStringValue, m_pData->m_nFormatKey, ::sal::static_int_cast< sal_Int16 >( m_pData->m_nFieldType ),
m_pData->m_nKeyType );
}
else
{
m_pData->m_xColumnUpdate->updateString( _rFormattedStringValue );
}
}
catch( const Exception& )
{
return false;
}
return true;
}
//--------------------------------------------------------------------
::rtl::OUString FormattedColumnValue::getFormattedValue() const
{
OSL_PRECOND( m_pData->m_xColumn.is(), "FormattedColumnValue::setFormattedValue: no column!" );
::rtl::OUString sStringValue;
if ( m_pData->m_xColumn.is() )
{
if ( m_pData->m_bNumericField )
{
sStringValue = DBTypeConversion::getFormattedValue(
m_pData->m_xColumn, m_pData->m_xFormatter, m_pData->m_aNullDate, m_pData->m_nFormatKey, m_pData->m_nKeyType
);
}
else
{
sStringValue = m_pData->m_xColumn->getString();
}
}
return sStringValue;
}
//........................................................................
} // namespace dbtools
//........................................................................