blob: 54c5d95a3a86cc5ef64a0e882279801c32d2f602 [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 CONNECTIVITY_FORMATTEDCOLUMNVALUE_HXX
#define CONNECTIVITY_FORMATTEDCOLUMNVALUE_HXX
/** === begin UNO includes === **/
#include <com/sun/star/sdbc/XRowSet.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/sdb/XColumn.hpp>
#include <com/sun/star/sdb/XColumnUpdate.hpp>
#include <com/sun/star/util/XNumberFormatter.hpp>
/** === end UNO includes === **/
#include <boost/noncopyable.hpp>
#include <memory>
#include "connectivity/dbtoolsdllapi.hxx"
namespace comphelper { class ComponentContext; }
//........................................................................
namespace dbtools
{
//........................................................................
struct FormattedColumnValue_Data;
//====================================================================
//= FormattedColumnValue
//====================================================================
/** a class which helps retrieving and setting the value of a database column
as formatted string.
*/
class OOO_DLLPUBLIC_DBTOOLS FormattedColumnValue : public ::boost::noncopyable
{
public:
/** constructs an instance
The format key for the string value exchange is taken from the given column object.
If it has a non-<NULL/> property value <code>FormatKey</code>, this key is taken.
Otherwise, a default format matching the column type is determined.
The locale of this fallback format is the current system locale.
The number formats supplier is determined from the given <code>RowSet</code>, by
examining its <code>ActiveConnection</code>.
*/
FormattedColumnValue(
const ::comphelper::ComponentContext& _rContext,
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet >& _rxRowSet,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxColumn
);
/** constructs an instance
The format key for the string value exchange is taken from the given column object.
If it has a non-<NULL/> property value <code>FormatKey</code>, this key is taken.
Otherwise, a default format matching the column type is determined.
The locale of this fallback format is the current system locale.
*/
FormattedColumnValue(
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& i_rNumberFormatter,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& i_rColumn
);
// note that all methods of this class need to be virtual, since it's
// used in a load-on-demand context in module SVX
virtual ~FormattedColumnValue();
virtual void clear();
// access to the details of the formatting we determined
virtual sal_Int32 getFormatKey() const;
virtual sal_Int32 getFieldType() const;
virtual sal_Int16 getKeyType() const;
virtual bool isNumericField() const;
virtual const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn >&
getColumn() const;
virtual const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumnUpdate >&
getColumnUpdate() const;
virtual bool setFormattedValue( const ::rtl::OUString& _rFormattedStringValue ) const;
virtual ::rtl::OUString getFormattedValue() const;
private:
::std::auto_ptr< FormattedColumnValue_Data > m_pData;
};
//........................................................................
} // namespace dbtools
//........................................................................
#endif // CONNECTIVITY_FORMATTEDCOLUMNVALUE_HXX