blob: 130912bc4c9207025b67dc2d5f313da717a66be3 [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 _DBHELPER_DBCONVERSION_HXX_
#define _DBHELPER_DBCONVERSION_HXX_
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#include <com/sun/star/util/Date.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include "connectivity/dbtoolsdllapi.hxx"
// forward declarations
namespace rtl
{
class OUString;
}
namespace com
{
namespace sun
{
namespace star
{
namespace lang
{
struct Locale;
}
namespace sdb
{
class XColumn;
class XColumnUpdate;
}
namespace sdbc
{
class SQLException;
}
namespace beans
{
class XPropertySet;
}
namespace util
{
class XNumberFormatter;
class XNumberFormatsSupplier;
struct Time;
struct DateTime;
}
namespace script
{
class XTypeConverter;
}
}
}
}
//.........................................................................
namespace dbtools
{
//.........................................................................
class OOO_DLLPUBLIC_DBTOOLS DBTypeConversion
{
public:
static ::com::sun::star::util::Date getStandardDate();
static void setValue(const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumnUpdate>& xVariant,
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter>& xFormatter,
const ::com::sun::star::util::Date& rNullDate,
const ::rtl::OUString& rString,
sal_Int32 nKey,
sal_Int16 nFieldType,
sal_Int16 nKeyType) throw(::com::sun::star::lang::IllegalArgumentException);
static void setValue(const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumnUpdate>& xVariant,
const ::com::sun::star::util::Date& rNullDate,
const double& rValue,
sal_Int16 nKeyType) throw(::com::sun::star::lang::IllegalArgumentException);
static double getValue( const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn>& xVariant, const ::com::sun::star::util::Date& rNullDate );
// get the columnvalue as string with a default format given by the column or a default format
// for the type
static ::rtl::OUString getFormattedValue(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xColumn,
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter>& xFormatter,
const ::com::sun::star::lang::Locale& _rLocale,
const ::com::sun::star::util::Date& rNullDate);
static ::rtl::OUString getFormattedValue(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn>& _xColumn,
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter>& xFormatter,
const ::com::sun::star::util::Date& rNullDate,
sal_Int32 nKey,
sal_Int16 nKeyType);
static ::com::sun::star::util::Date toDate(double dVal, const ::com::sun::star::util::Date& _rNullDate = getStandardDate());
static ::com::sun::star::util::Date toDate(const ::rtl::OUString& _sSQLDate);
static ::com::sun::star::util::Time toTime(double dVal);
static ::com::sun::star::util::Time toTime(const ::rtl::OUString& _sSQLDate);
static ::com::sun::star::util::DateTime toDateTime(double dVal, const ::com::sun::star::util::Date& _rNullDate = getStandardDate());
static ::com::sun::star::util::DateTime toDateTime(const ::rtl::OUString& _sSQLDate);
/** return the given DateTime as JDBC compliant 64 bit value
*/
static sal_Int64 toINT64(const ::com::sun::star::util::DateTime& rVal);
static sal_Int32 getMsFromTime(const ::com::sun::star::util::Time& rVal);
static sal_Int32 toDays(const ::com::sun::star::util::Date& _rVal, const ::com::sun::star::util::Date& _rNullDate = getStandardDate());
static double toDouble(const ::com::sun::star::util::Date& rVal, const ::com::sun::star::util::Date& _rNullDate = getStandardDate());
static double toDouble(const ::com::sun::star::util::Time& rVal);
static double toDouble(const ::com::sun::star::util::DateTime& rVal, const ::com::sun::star::util::Date& _rNullDate = getStandardDate());
static sal_Int32 toINT32(const ::com::sun::star::util::Date& rVal);
static sal_Int32 toINT32(const ::com::sun::star::util::Time& rVal);
static ::com::sun::star::util::Date toDate(sal_Int32 _nVal);
static ::com::sun::star::util::Time toTime(sal_Int32 _nVal);
/** convert a double which is a date value relative to a given fixed date into a date value relative
to the standard db null date.
*/
static double toStandardDbDate(const ::com::sun::star::util::Date& _rNullDate, double _rVal) { return _rVal + toDays(_rNullDate); }
/** convert a double which is a date value relative to the standard db null date into a date value relative
to a given fixed date.
*/
static double toNullDate(const ::com::sun::star::util::Date& _rNullDate, double _rVal) { return _rVal - toDays(_rNullDate); }
// return the date from the numberformatsupplier or the STANDARD_DATE (1900,1,1)
static ::com::sun::star::util::Date getNULLDate(const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier > &xSupplier);
// return the date in the format %04d-%02d-%02d
static ::rtl::OUString toDateString(const ::com::sun::star::util::Date& rDate);
// return the time in the format %02d:%02d:%02d
static ::rtl::OUString toTimeString(const ::com::sun::star::util::Time& rTime);
// return the DateTime in the format %04d-%02d-%02d %02d:%02d:%02d
static ::rtl::OUString toDateTimeString(const ::com::sun::star::util::DateTime& _rDateTime);
// return the any in an sql standard format
static ::rtl::OUString toSQLString(sal_Int32 eType, const ::com::sun::star::uno::Any& _rVal, sal_Bool bQuote,
const ::com::sun::star::uno::Reference< ::com::sun::star::script::XTypeConverter >& _rxTypeConverter);
/** converts a Unicode string into a 8-bit string, using the given encoding
@param _rSource
the source string to convert
@param _rDest
the destination string
@param _eEncoding
the encoding to use for the conversion
@throws com::sun::star::sdbc::SQLException
if the given string contains characters which are not convertible using the given encoding
The SQLState of the exception will be set to 22018 ("Invalid character value for cast specification")
@return
the length of the converted string
*/
static sal_Int32 convertUnicodeString(
const ::rtl::OUString& _rSource,
::rtl::OString& _rDest,
rtl_TextEncoding _eEncoding
)
SAL_THROW((::com::sun::star::sdbc::SQLException));
/** converts a Unicode string into a 8-bit string, using the given encoding
@param _rSource
the source string to convert
@param _rDest
the destination string
@param _nMaxLen
the maximum length of the destination string
@param _eEncoding
the encoding to use for the conversion
@throws com::sun::star::sdbc::SQLException
if convertUnicodeString, which is called internally, throws such an exception
@throws com::sun::star::sdbc::SQLException
if the conversion results in a string which is longer than _nMaxLen
@return
the length of the converted string
*/
static sal_Int32 convertUnicodeStringToLength(
const ::rtl::OUString& _rSource,
::rtl::OString& _rDest,
sal_Int32 _nMaxLen,
rtl_TextEncoding _eEncoding
)
SAL_THROW((::com::sun::star::sdbc::SQLException));
};
//.........................................................................
} // namespace dbtools
//.........................................................................
#endif // _DBHELPER_DBCONVERSION_HXX_