/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef INCLUDED_CONNECTIVITY_VIRTUALDBTOOLS_HXX
#define INCLUDED_CONNECTIVITY_VIRTUALDBTOOLS_HXX
#include <config_features.h>
#include <rtl/ref.hxx>
#include <rtl/ustring.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/util/Date.hpp>
#include <com/sun/star/sdbc/SQLException.hpp>
#include <com/sun/star/uno/Sequence.hxx>
#include <vector>
#include <memory>
#include <connectivity/dbtoolsdllapi.hxx>
#include <salhelper/simplereferenceobject.hxx>
//= forward declarations
namespace com {
namespace sun {
namespace star {
namespace util {
class XNumberFormatter;
class XNumberFormatTypes;
class XNumberFormatsSupplier;
}
namespace beans {
class XPropertySet;
}
namespace lang {
class XMultiServiceFactory;
class XComponent;
class WrappedTargetException;
struct Locale;
}
namespace sdbc {
class XDatabaseMetaData;
class XConnection;
class XRowSet;
class XDataSource;
}
namespace sdb {
class XColumn;
class SQLContext;
}
namespace uno {
class XComponentContext;
}
namespace container {
class XNameAccess;
}
}
}
}
namespace dbtools {
class SQLExceptionInfo;
class FormattedColumnValue;
}
//= entry into this library
/** this is the entry point for the load-on-call usage of the DBTOOLS
library.
<p>When you need one of the simple objects in this library, load the lib
and call this method. The returned pointer is a pointer to an IDataAccessToolsFactory
instance, which is acquired <em>once</em>.</p>
@return
a pointer to an object implementing the IDataAccessToolsFactory interface,
acquired exactly <em>once</em>.
*/
#if HAVE_FEATURE_DESKTOP
extern "C" OOO_DLLPUBLIC_DBTOOLS void* SAL_CALL createDataAccessToolsFactory();
#endif
//=
namespace connectivity
{
class IParseContext;
namespace simple
{
typedef void* (SAL_CALL * createDataAccessToolsFactoryFunction)( );
//= IDataAccessTools
class OOO_DLLPUBLIC_DBTOOLS IDataAccessTools : public virtual salhelper::SimpleReferenceObject
{
public:
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection> getConnection_withFeedback(
const OUString& _rDataSourceName,
const OUString& _rUser,
const OUString& _rPwd,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxContext
) const = 0;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection> connectRowset(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet>& _rxRowSet,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxContext,
bool _bSetAsActiveConnection
) const = 0;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection> getRowSetConnection(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet>& _rxRowSet)
const = 0;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier> getNumberFormats(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection>& _rxConn,
bool _bAllowDefault
) const = 0;
virtual sal_Int32 getDefaultNumberFormat(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxColumn,
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatTypes >& _rxTypes,
const ::com::sun::star::lang::Locale& _rLocale
) const = 0;
virtual void TransferFormComponentProperties(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxOld,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxNew,
const ::com::sun::star::lang::Locale& _rLocale
) const = 0;
virtual OUString quoteName(
const OUString& _rQuote,
const OUString& _rName
) const = 0;
virtual OUString composeTableNameForSelect(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
const OUString& _rCatalog,
const OUString& _rSchema,
const OUString& _rName
) const = 0;
virtual OUString composeTableNameForSelect(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _xTable
) const = 0;
virtual ::com::sun::star::sdb::SQLContext prependContextInfo(
::com::sun::star::sdbc::SQLException& _rException,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxContext,
const OUString& _rContextDescription,
const OUString& _rContextDetails
) const = 0;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDataSource > getDataSource(
const OUString& _rsRegisteredName,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext>& _rxContext
) const = 0;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >
getFieldsByCommandDescriptor(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
const sal_Int32 _nCommandType,
const OUString& _rCommand,
::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >& _rxKeepFieldsAlive,
::dbtools::SQLExceptionInfo* _pErrorInfo = NULL
) = 0;
virtual ::com::sun::star::uno::Sequence< OUString >
getFieldNamesByCommandDescriptor(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
const sal_Int32 _nCommandType,
const OUString& _rCommand,
::dbtools::SQLExceptionInfo* _pErrorInfo = NULL
) = 0;
/** check if the property "Privileges" supports ::com::sun::star::sdbcx::Privilege::INSERT
@param _rxCursorSet the property set
*/
virtual bool canInsert(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxCursorSet) const = 0;
/** check if the property "Privileges" supports ::com::sun::star::sdbcx::Privilege::UPDATE
@param _rxCursorSet the property set
*/
virtual bool canUpdate(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxCursorSet) const = 0;
/** check if the property "Privileges" supports ::com::sun::star::sdbcx::Privilege::DELETE
@param _rxCursorSet the property set
*/
virtual bool canDelete(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxCursorSet) const = 0;
/** determines whether the given component is part of a document which is an embedded database
document (such as a form)
*/
virtual bool isEmbeddedInDatabase(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxComponent,
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxActualConnection
) = 0;
protected:
virtual ~IDataAccessTools() {}
};
//= IDataAccessCharSet
/** simple wrapper for the OCharsetMap
*/
class OOO_DLLPUBLIC_DBTOOLS IDataAccessCharSet :
public salhelper::SimpleReferenceObject
{
// to be extended if necessary ....
public:
/** enumerates all supported char sets
@return the number of charsets supported
*/
virtual sal_Int32 getSupportedTextEncodings(
::std::vector< rtl_TextEncoding >& /* [out] */ _rEncs
) const = 0;
protected:
virtual ~IDataAccessCharSet() {}
};
//= IDataAccessTypeConversion
class OOO_DLLPUBLIC_DBTOOLS IDataAccessTypeConversion :
public virtual salhelper::SimpleReferenceObject
{
public:
virtual ::com::sun::star::util::Date getStandardDate() const = 0;
virtual double getValue(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn>& _rxVariant,
const ::com::sun::star::util::Date& rNullDate ) const = 0;
virtual OUString getFormattedValue(
const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn >& _rxColumn,
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter,
const ::com::sun::star::util::Date& _rNullDate,
sal_Int32 _nKey,
sal_Int16 _nKeyType) const = 0;
virtual OUString getFormattedValue(
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxColumn,
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter>& _rxFormatter,
const ::com::sun::star::lang::Locale& _rLocale,
const ::com::sun::star::util::Date& _rNullDate
) const = 0;
protected:
virtual ~IDataAccessTypeConversion() {}
};
//= ISQLParseNode
/** a simple version of the OSQLParseNode, with all methods being virtual
*/
class OOO_DLLPUBLIC_DBTOOLS ISQLParseNode : public salhelper::SimpleReferenceObject
{
public:
virtual void parseNodeToStr(OUString& _rString,
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
const IParseContext* _pContext
) const = 0;
virtual void parseNodeToPredicateStr(OUString& _rString,
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XConnection >& _rxConnection,
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxField,
const OUString &_sPredicateTableAlias,
const ::com::sun::star::lang::Locale& _rIntl,
const sal_Char _cDecSeparator,
const IParseContext* _pContext
) const = 0;
protected:
virtual ~ISQLParseNode() {}
};
//= ISQLParser
/** a simple version of the OSQLParser, with all methods being virtual
*/
class OOO_DLLPUBLIC_DBTOOLS ISQLParser : public salhelper::SimpleReferenceObject
{
public:
virtual ::rtl::Reference< ISQLParseNode > predicateTree(
OUString& rErrorMessage,
const OUString& rStatement,
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatter >& _rxFormatter,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxField
) const = 0;
virtual const IParseContext& getContext() const = 0;
protected:
virtual ~ISQLParser() {}
};
//= IDataAccessToolsFactory
/** the main factory for runtime-loadable tools in the DBTOOLS library
*/
class OOO_DLLPUBLIC_DBTOOLS IDataAccessToolsFactory :
public salhelper::SimpleReferenceObject
{
public:
/// creates a simple version of the class OSQLParser
virtual ::rtl::Reference< ISQLParser > createSQLParser(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
const IParseContext* _pContext
) const = 0;
/// creates a helper for charset related functionality (OCharsetMap)
virtual ::rtl::Reference< IDataAccessCharSet > createCharsetHelper( ) const = 0;
/// creates a simple version of the DBTypeConversion helper
virtual ::rtl::Reference< IDataAccessTypeConversion > getTypeConversionHelper() = 0;
/// creates a helper which can be used to access the static methods in dbtools.hxx
virtual ::rtl::Reference< IDataAccessTools > getDataAccessTools() = 0;
virtual ::std::unique_ptr< ::dbtools::FormattedColumnValue > createFormattedColumnValue(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRowSet >& _rxRowSet,
const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxColumn
) = 0;
protected:
virtual ~IDataAccessToolsFactory() {}
};
} // namespace simple
} // namespace connectivity
#endif // INCLUDED_CONNECTIVITY_VIRTUALDBTOOLS_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */