dbaccess/source/core/inc/SingleSelectQueryComposer.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #pragma once
  20
  21 #include <com/sun/star/sdb/XParametersSupplier.hpp>
  22 #include <com/sun/star/sdbcx/XTablesSupplier.hpp>
  23 #include <com/sun/star/sdbcx/XColumnsSupplier.hpp>
  24 #include <com/sun/star/sdb/XSingleSelectQueryComposer.hpp>
  25 #include <com/sun/star/lang/XServiceInfo.hpp>
  26 #include <com/sun/star/script/XTypeConverter.hpp>
  27 #include <cppuhelper/implbase5.hxx>
  28 #include <connectivity/sqliterator.hxx>
  29 #include <connectivity/sqlparse.hxx>
  30 #include <apitools.hxx>
  31 #include <comphelper/broadcasthelper.hxx>
  32 #include <comphelper/uno3.hxx>
  33 #include <comphelper/proparrhlp.hxx>
  34 #include <comphelper/propertycontainer.hxx>
  35 #include <svx/ParseContext.hxx>
  36
  37 namespace com::sun::star::util {
  38     class XNumberFormatsSupplier;
  39     class XNumberFormatter;
  40 }
  41
  42 namespace dbaccess
  43 {
  44     typedef ::cppu::ImplHelper5<    css::sdb::XSingleSelectQueryComposer,
  45                                     css::sdb::XParametersSupplier,
  46                                     css::sdbcx::XColumnsSupplier,
  47                                     css::sdbcx::XTablesSupplier,
  48                                     css::lang::XServiceInfo    > OSingleSelectQueryComposer_BASE;
  49
  50     class OPrivateColumns;
  51     class OPrivateTables;
  52
  53     class OSingleSelectQueryComposer :   public ::comphelper::OMutexAndBroadcastHelper
  54                                         ,public OSubComponent
  55                                         ,public ::comphelper::OPropertyContainer
  56                                         ,public ::comphelper::OPropertyArrayUsageHelper < OSingleSelectQueryComposer >
  57                                         ,public OSingleSelectQueryComposer_BASE
  58     {
  59         enum SQLPart
  60         {
  61             Where = 0,      // the 0 is important, as it will be used as index into arrays
  62             Group,
  63             Having,
  64             Order,
  65
  66             SQLPartCount
  67         };
  68         static void incSQLPart( SQLPart& e ) { e = static_cast<SQLPart>(1 + static_cast<size_t>(e)); }
  69         enum EColumnType
  70         {
  71             SelectColumns       = 0,
  72             GroupByColumns      = 1,
  73             OrderColumns        = 2,
  74             ParameterColumns    = 3
  75         };
  76         typedef std::function<const ::connectivity::OSQLParseNode*(::connectivity::OSQLParseTreeIterator *)>
  77                                                 TGetParseNode;
  78         ::svxform::OSystemParseContext          m_aParseContext;
  79         ::connectivity::OSQLParser              m_aSqlParser;
  80         ::connectivity::OSQLParseTreeIterator   m_aSqlIterator;         // the iterator for the complete statement
  81         ::connectivity::OSQLParseTreeIterator   m_aAdditiveIterator;    // the iterator for the "additive statement" (means without the clauses of the elementary statement)
  82         std::vector<std::unique_ptr<OPrivateColumns>>
  83                                                 m_aColumnsCollection;   // used for columns and parameters of old queries
  84         std::vector<std::unique_ptr<OPrivateTables>>
  85                                                 m_aTablesCollection;
  86
  87         std::vector< OUString >        m_aElementaryParts;     // the filter/groupby/having/order of the elementary statement
  88
  89         css::uno::Reference< css::sdbc::XConnection>              m_xConnection;
  90         css::uno::Reference< css::sdbc::XDatabaseMetaData>        m_xMetaData;
  91         css::uno::Reference< css::container::XNameAccess>         m_xConnectionTables;
  92         css::uno::Reference< css::container::XNameAccess>         m_xConnectionQueries;
  93         css::uno::Reference< css::util::XNumberFormatsSupplier >  m_xNumberFormatsSupplier;
  94         css::uno::Reference< css::uno::XComponentContext>         m_aContext;
  95         css::uno::Reference< css::script::XTypeConverter >        m_xTypeConverter;
  96
  97         std::vector<std::unique_ptr<OPrivateColumns>>         m_aCurrentColumns;
  98         std::unique_ptr<OPrivateTables>                       m_pTables;      // currently used tables
  99
 100         OUString                                m_aPureSelectSQL;   // the pure select statement, without filter/order/groupby/having
 101         OUString                                m_sDecimalSep;
 102         OUString                                m_sCommand;
 103         css::lang::Locale                       m_aLocale;
 104         sal_Int32                               m_nBoolCompareMode; // how to compare bool values
 105         sal_Int32                               m_nCommandType;
 106
 107         // <properties>
 108         OUString                         m_sOriginal;
 109         // </properties>
 110
 111
 112         bool setORCriteria(::connectivity::OSQLParseNode const * pCondition, ::connectivity::OSQLParseTreeIterator& _rIterator,
 113             std::vector< std::vector < css::beans::PropertyValue > >& rFilters, const css::uno::Reference< css::util::XNumberFormatter > & xFormatter) const;
 114         bool setANDCriteria(::connectivity::OSQLParseNode const * pCondition, ::connectivity::OSQLParseTreeIterator& _rIterator,
 115             std::vector < css::beans::PropertyValue > & rFilters, const css::uno::Reference< css::util::XNumberFormatter > & xFormatter) const;
 116         bool setLikePredicate(::connectivity::OSQLParseNode const * pCondition, ::connectivity::OSQLParseTreeIterator const & _rIterator,
 117             std::vector < css::beans::PropertyValue > & rFilters, const css::uno::Reference< css::util::XNumberFormatter > & xFormatter) const;
 118         bool setComparisonPredicate(::connectivity::OSQLParseNode const * pCondition, ::connectivity::OSQLParseTreeIterator const & _rIterator,
 119             std::vector < css::beans::PropertyValue > & rFilters, const css::uno::Reference< css::util::XNumberFormatter > & xFormatter) const;
 120
 121         static OUString getColumnName(::connectivity::OSQLParseNode const * pColumnRef, ::connectivity::OSQLParseTreeIterator const & _rIterator);
 122         OUString getTableAlias(const css::uno::Reference< css::beans::XPropertySet >& column ) const;
 123         static sal_Int32 getPredicateType(::connectivity::OSQLParseNode const * _pPredicate);
 124         // clears all Columns,Parameters and tables and insert it to their vectors
 125         void clearCurrentCollections();
 126         // clears the columns collection given by EColumnType
 127         void clearColumns( const EColumnType _eType );
 128
 129         /** retrieves a particular part of a statement
 130             @param _rIterator
 131                 the iterator to use.
 132         */
 133         OUString getStatementPart( TGetParseNode const & _aGetFunctor, ::connectivity::OSQLParseTreeIterator& _rIterator );
 134         void setQuery_Impl( const OUString& command );
 135
 136         void setConditionByColumn( const css::uno::Reference< css::beans::XPropertySet >& column
 137                                 , bool andCriteria
 138                                 , std::function<bool(OSingleSelectQueryComposer *, const OUString&)> const & _aSetFunctor
 139                                 ,sal_Int32 filterOperator);
 140
 141         /** getStructuredCondition returns the structured condition for the where or having clause
 142             @param  _aGetFunctor
 143                 A member function to get the correct parse node.
 144
 145             @return
 146                 The structured filter
 147         */
 148         css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > >
 149                     getStructuredCondition( TGetParseNode const & _aGetFunctor );
 150
 151         css::uno::Reference< css::container::XIndexAccess >
 152                     setCurrentColumns( EColumnType _eType, const ::rtl::Reference< ::connectivity::OSQLColumns >& _rCols );
 153
 154         //helper methods for mem_fun_t
 155         bool implSetFilter(const OUString& _sFilter) { setFilter(_sFilter); return true;}
 156         bool implSetHavingClause(const OUString& _sFilter) { setHavingClause(_sFilter); return true;}
 157
 158         /** returns the part of the select statement
 159             @param  _ePart
 160                 Which part should be returned.
 161             @param  _bWithKeyword
 162                 If <TRUE/> the keyword will be added too. Otherwise not.
 163             @param _rIterator
 164                 The iterator to use.
 165
 166             @return
 167                 The part of the select statement.
 168         */
 169         OUString getSQLPart( SQLPart _ePart, ::connectivity::OSQLParseTreeIterator& _rIterator, bool _bWithKeyword );
 170
 171         /** retrieves the keyword for the given SQLPart
 172         */
 173         static OUString getKeyword( SQLPart _ePart );
 174
 175         /** sets a single "additive" clause, means a filter/groupby/having/order clause
 176         */
 177         void setSingleAdditiveClause( SQLPart _ePart, const OUString& _rClause );
 178
 179         /** composes a statement from m_aPureSelectSQL and the 4 usual clauses
 180         */
 181         OUString composeStatementFromParts( const std::vector< OUString >& _rParts );
 182
 183         /** return the name of the column in the *source* *table*.
 184
 185             That is, for (SELECT a AS b FROM t), it returns A or "t"."A", as appropriate.
 186
 187             Use e.g. for WHERE, GROUP BY and HAVING clauses.
 188
 189             @param bGroupBy: for GROUP BY clause? In that case, throw exception if trying to use an unrelated column and the database does not support that.
 190         */
 191         OUString impl_getColumnRealName_throw(const css::uno::Reference< css::beans::XPropertySet >& column, bool bGroupBy);
 192
 193         /** return the name of the column in the *query* for ORDER BY clause.
 194
 195             That is, for (SELECT a AS b FROM t), it returns "b"
 196
 197             Throws exception if trying to use an unrelated column and the database does not support that.
 198         */
 199         OUString impl_getColumnNameOrderBy_throw(const css::uno::Reference< css::beans::XPropertySet >& column);
 200
 201     protected:
 202         virtual ~OSingleSelectQueryComposer() override;
 203     public:
 204
 205         OSingleSelectQueryComposer( const css::uno::Reference< css::container::XNameAccess>& _xTableSupplier,
 206                         const css::uno::Reference< css::sdbc::XConnection>& _xConnection,
 207                         const css::uno::Reference< css::uno::XComponentContext>& _rContext);
 208
 209
 210         void SAL_CALL disposing() override;
 211
 212         virtual css::uno::Sequence<css::uno::Type> SAL_CALL getTypes() override;
 213         virtual css::uno::Sequence<sal_Int8> SAL_CALL getImplementationId() override;
 214
 215         // css::uno::XInterface
 216         DECLARE_XINTERFACE( )
 217
 218         // XServiceInfo
 219         DECLARE_SERVICE_INFO();
 220
 221         DECLARE_PROPERTYCONTAINER_DEFAULTS();
 222
 223         // css::sdb::XSingleSelectQueryComposer
 224         virtual OUString SAL_CALL getElementaryQuery() override;
 225         virtual void SAL_CALL setElementaryQuery( const OUString& _rElementary ) override;
 226         virtual void SAL_CALL setFilter( const OUString& filter ) override;
 227         virtual void SAL_CALL setStructuredFilter( const css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > >& filter ) override;
 228         virtual void SAL_CALL appendFilterByColumn( const css::uno::Reference< css::beans::XPropertySet >& column, sal_Bool andCriteria,sal_Int32 filterOperator ) override;
 229         virtual void SAL_CALL appendGroupByColumn( const css::uno::Reference< css::beans::XPropertySet >& column ) override;
 230         virtual void SAL_CALL setGroup( const OUString& group ) override;
 231         virtual void SAL_CALL setHavingClause( const OUString& filter ) override;
 232         virtual void SAL_CALL setStructuredHavingClause( const css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > >& filter ) override;
 233         virtual void SAL_CALL appendHavingClauseByColumn( const css::uno::Reference< css::beans::XPropertySet >& column, sal_Bool andCriteria,sal_Int32 filterOperator ) override;
 234         virtual void SAL_CALL appendOrderByColumn( const css::uno::Reference< css::beans::XPropertySet >& column, sal_Bool ascending ) override;
 235         virtual void SAL_CALL setOrder( const OUString& order ) override;
 236
 237         // XSingleSelectQueryAnalyzer
 238         virtual OUString SAL_CALL getQuery(  ) override;
 239         virtual void SAL_CALL setQuery( const OUString& command ) override;
 240         virtual void SAL_CALL setCommand( const OUString& command,sal_Int32 CommandType ) override;
 241         virtual OUString SAL_CALL getFilter(  ) override;
 242         virtual css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > > SAL_CALL getStructuredFilter(  ) override;
 243         virtual OUString SAL_CALL getGroup(  ) override;
 244         virtual css::uno::Reference< css::container::XIndexAccess > SAL_CALL getGroupColumns(  ) override;
 245         virtual OUString SAL_CALL getHavingClause(  ) override;
 246         virtual css::uno::Sequence< css::uno::Sequence< css::beans::PropertyValue > > SAL_CALL getStructuredHavingClause(  ) override;
 247         virtual OUString SAL_CALL getOrder(  ) override;
 248         virtual css::uno::Reference< css::container::XIndexAccess > SAL_CALL getOrderColumns(  ) override;
 249         virtual OUString SAL_CALL getQueryWithSubstitution(  ) override;
 250
 251         // XColumnsSupplier
 252         virtual css::uno::Reference< css::container::XNameAccess > SAL_CALL getColumns(  ) override;
 253         // XTablesSupplier
 254         virtual css::uno::Reference< css::container::XNameAccess > SAL_CALL getTables(  ) override;
 255         // XParametersSupplier
 256         virtual css::uno::Reference< css::container::XIndexAccess > SAL_CALL getParameters(  ) override;
 257     };
 258 }
 259
 260 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */