1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24 #ifndef DBACCESS_CORE_API_KEYSET_HXX 25 #define DBACCESS_CORE_API_KEYSET_HXX 26 27 #ifndef DBACCESS_CORE_API_CACHESET_HXX 28 #include "CacheSet.hxx" 29 #endif 30 31 #ifndef _CPPUHELPER_IMPLBASE1_HXX_ 32 #include <cppuhelper/implbase1.hxx> 33 #endif 34 #include <memory> 35 #include <map> 36 37 #ifndef _COM_SUN_STAR_LANG_XUNOTUNNEL_HPP_ 38 #include <com/sun/star/lang/XUnoTunnel.hpp> 39 #endif 40 #include <com/sun/star/sdb/XSingleSelectQueryAnalyzer.hpp> 41 #include <com/sun/star/sdb/XSingleSelectQueryComposer.hpp> 42 #ifndef _COMPHELPER_STLTYPES_HXX_ 43 #include <comphelper/stl_types.hxx> 44 #endif 45 46 namespace dbaccess 47 { 48 struct SelectColumnDescription 49 { 50 ::rtl::OUString sRealName; // may be empty 51 ::rtl::OUString sTableName; // may be empty 52 ::rtl::OUString sDefaultValue; 53 sal_Int32 nPosition; 54 sal_Int32 nType; 55 sal_Int32 nScale; 56 sal_Bool bNullable; 57 58 59 SelectColumnDescriptiondbaccess::SelectColumnDescription60 SelectColumnDescription() 61 :nPosition( 0 ) 62 ,nType( 0 ) 63 ,nScale( 0 ) 64 ,bNullable(sal_False) 65 { 66 } 67 SelectColumnDescriptiondbaccess::SelectColumnDescription68 SelectColumnDescription( sal_Int32 _nPosition, sal_Int32 _nType, sal_Int32 _nScale,sal_Bool _bNullable, const ::rtl::OUString& _rDefaultValue ) 69 :sDefaultValue( _rDefaultValue ) 70 ,nPosition( _nPosition ) 71 ,nType( _nType ) 72 ,nScale( _nScale ) 73 ,bNullable(_bNullable) 74 { 75 } 76 }; 77 typedef ::std::map< ::rtl::OUString, SelectColumnDescription, ::comphelper::UStringMixLess > SelectColumnsMetaData; 78 79 // the elements of _rxQueryColumns must have the properties PROPERTY_REALNAME and PROPERTY_TABLENAME 80 void getColumnPositions(const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& _rxQueryColumns, 81 const ::com::sun::star::uno::Sequence< ::rtl::OUString >& _rColumnNames, 82 const ::rtl::OUString& _rsUpdateTableName, 83 SelectColumnsMetaData& o_rColumnNames /* out */, 84 bool i_bAppendTableName = false); 85 86 typedef ::std::pair<ORowSetRow,::std::pair<sal_Int32,::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow> > > OKeySetValue; 87 typedef ::std::map<sal_Int32,OKeySetValue > OKeySetMatrix; 88 typedef ::std::map<sal_Int32,ORowSetValueVector > OUpdatedParameter; 89 // is used when the source supports keys 90 class OKeySet : public OCacheSet 91 { 92 protected: 93 OKeySetMatrix m_aKeyMap; 94 OKeySetMatrix::iterator m_aKeyIter; 95 96 ::std::vector< ::rtl::OUString > m_aAutoColumns; // contains all columns which are autoincrement ones 97 98 OUpdatedParameter m_aUpdatedParameter; // contains all parameter which have been updated and are needed for refetching 99 ORowSetValueVector m_aParameterValueForCache; 100 ::std::auto_ptr<SelectColumnsMetaData> m_pKeyColumnNames; // contains all key column names 101 ::std::auto_ptr<SelectColumnsMetaData> m_pColumnNames; // contains all column names 102 ::std::auto_ptr<SelectColumnsMetaData> m_pParameterNames; // contains all parameter names 103 ::std::auto_ptr<SelectColumnsMetaData> m_pForeignColumnNames; // contains all column names of the rest 104 connectivity::OSQLTable m_xTable; // reference to our table 105 ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess> m_xTableKeys; 106 ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XPreparedStatement> m_xStatement; 107 ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet> m_xSet; 108 ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow> m_xRow; 109 ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XSingleSelectQueryAnalyzer > m_xComposer; 110 ::rtl::OUString m_sUpdateTableName; 111 ::std::vector< ::rtl::OUString > m_aFilterColumns; 112 sal_Int32& m_rRowCount; 113 114 sal_Bool m_bRowCountFinal; 115 116 /** 117 getComposedTableName return the composed table name for the query 118 @param _sCatalog the catalogname may be empty 119 @param _sSchema the schemaname may be empty 120 @param _sTable the tablename 121 122 @return the composed name 123 */ 124 ::rtl::OUString getComposedTableName( const ::rtl::OUString& _sCatalog, 125 const ::rtl::OUString& _sSchema, 126 const ::rtl::OUString& _sTable); 127 128 /** copies the values from the insert row into the key row 129 * 130 * \param _rInsertRow the row which was inserted 131 * \param _rKeyRow The current key row of the row set. 132 + \param i_nBookmark The bookmark is used to update the parameter 133 */ 134 void copyRowValue(const ORowSetRow& _rInsertRow,ORowSetRow& _rKeyRow,sal_Int32 i_nBookmark); 135 136 ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess > getKeyColumns() const; 137 void fillAllRows(); 138 sal_Bool fetchRow(); 139 140 void impl_convertValue_throw(const ORowSetRow& _rInsertRow,const SelectColumnDescription& i_aMetaData); 141 void initColumns(); 142 void findTableColumnsMatching_throw( const ::com::sun::star::uno::Any& i_aTable, 143 const ::rtl::OUString& i_rUpdateTableName, 144 const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XDatabaseMetaData>& i_xMeta, 145 const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess>& i_xQueryColumns, 146 ::std::auto_ptr<SelectColumnsMetaData>& o_pKeyColumnNames); 147 ::rtl::OUStringBuffer createKeyFilter(); 148 void tryRefetch(const ORowSetRow& _rInsertRow,bool bRefetch); 149 void executeUpdate(const ORowSetRow& _rInsertRow ,const ORowSetRow& _rOrginalRow,const ::rtl::OUString& i_sSQL,const ::rtl::OUString& i_sTableName,const ::std::vector<sal_Int32>& _aIndexColumnPositions = ::std::vector<sal_Int32>()); 150 void executeInsert( const ORowSetRow& _rInsertRow,const ::rtl::OUString& i_sSQL,const ::rtl::OUString& i_sTableName = ::rtl::OUString(),bool bRefetch = false); 151 void executeStatement(::rtl::OUStringBuffer& io_aFilter,const ::rtl::OUString& i_sRowSetFilter,::com::sun::star::uno::Reference< ::com::sun::star::sdb::XSingleSelectQueryComposer>& io_xAnalyzer); 152 153 virtual ~OKeySet(); 154 public: 155 OKeySet(const connectivity::OSQLTable& _xTable, 156 const ::com::sun::star::uno::Reference< ::com::sun::star::container::XIndexAccess>& _xTableKeys, 157 const ::rtl::OUString& _rUpdateTableName, 158 const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XSingleSelectQueryAnalyzer >& _xComposer, 159 const ORowSetValueVector& _aParameterValueForCache, 160 sal_Int32 i_nMaxRows, 161 sal_Int32& o_nRowCount); 162 163 // late ctor which can throw exceptions 164 virtual void construct(const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet>& _xDriverSet,const ::rtl::OUString& i_sRowSetFilter); 165 166 // ::com::sun::star::sdbc::XRow 167 virtual sal_Bool SAL_CALL wasNull( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 168 virtual ::rtl::OUString SAL_CALL getString( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 169 virtual sal_Bool SAL_CALL getBoolean( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 170 virtual sal_Int8 SAL_CALL getByte( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 171 virtual sal_Int16 SAL_CALL getShort( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 172 virtual sal_Int32 SAL_CALL getInt( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 173 virtual sal_Int64 SAL_CALL getLong( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 174 virtual float SAL_CALL getFloat( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 175 virtual double SAL_CALL getDouble( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 176 virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getBytes( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 177 virtual ::com::sun::star::util::Date SAL_CALL getDate( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 178 virtual ::com::sun::star::util::Time SAL_CALL getTime( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 179 virtual ::com::sun::star::util::DateTime SAL_CALL getTimestamp( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 180 virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getBinaryStream( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 181 virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getCharacterStream( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 182 virtual ::com::sun::star::uno::Any SAL_CALL getObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& typeMap ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 183 virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef > SAL_CALL getRef( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 184 virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob > SAL_CALL getBlob( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 185 virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob > SAL_CALL getClob( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 186 virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray > SAL_CALL getArray( sal_Int32 columnIndex ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 187 188 189 virtual sal_Bool SAL_CALL rowUpdated( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 190 virtual sal_Bool SAL_CALL rowInserted( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 191 virtual sal_Bool SAL_CALL rowDeleted( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 192 // ::com::sun::star::sdbc::XResultSet 193 virtual sal_Bool SAL_CALL next( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 194 virtual sal_Bool SAL_CALL isBeforeFirst( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 195 virtual sal_Bool SAL_CALL isAfterLast( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 196 virtual sal_Bool SAL_CALL isFirst( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 197 virtual sal_Bool SAL_CALL isLast( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 198 virtual void SAL_CALL beforeFirst( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 199 virtual void SAL_CALL afterLast( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 200 virtual sal_Bool SAL_CALL first( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 201 virtual sal_Bool SAL_CALL last( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 202 virtual sal_Int32 SAL_CALL getRow( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 203 virtual sal_Bool SAL_CALL absolute( sal_Int32 row ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 204 virtual sal_Bool SAL_CALL relative( sal_Int32 rows ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 205 virtual sal_Bool SAL_CALL previous( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 206 virtual void SAL_CALL refreshRow( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 207 // ::com::sun::star::sdbcx::XRowLocate 208 virtual ::com::sun::star::uno::Any SAL_CALL getBookmark() throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 209 // ------------------------------------------------------------------------- 210 virtual sal_Bool SAL_CALL moveToBookmark( const ::com::sun::star::uno::Any& bookmark ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 211 // ------------------------------------------------------------------------- 212 virtual sal_Bool SAL_CALL moveRelativeToBookmark( const ::com::sun::star::uno::Any& bookmark, sal_Int32 rows ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 213 // ------------------------------------------------------------------------- 214 virtual sal_Int32 SAL_CALL compareBookmarks( const ::com::sun::star::uno::Any& first, const ::com::sun::star::uno::Any& second ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 215 // ------------------------------------------------------------------------- 216 virtual sal_Bool SAL_CALL hasOrderedBookmarks( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 217 // ------------------------------------------------------------------------- 218 virtual sal_Int32 SAL_CALL hashBookmark( const ::com::sun::star::uno::Any& bookmark ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 219 // ------------------------------------------------------------------------- 220 // ::com::sun::star::sdbcx::XDeleteRows 221 virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL deleteRows( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& rows ,const connectivity::OSQLTable& _xTable) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 222 // ::com::sun::star::sdbc::XResultSetUpdate 223 virtual void SAL_CALL updateRow(const ORowSetRow& _rInsertRow,const ORowSetRow& _rOrginalRow,const connectivity::OSQLTable& _xTable ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 224 virtual void SAL_CALL deleteRow(const ORowSetRow& _rInsertRow,const connectivity::OSQLTable& _xTable ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 225 virtual void SAL_CALL insertRow( const ORowSetRow& _rInsertRow,const connectivity::OSQLTable& _xTable ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 226 virtual void SAL_CALL cancelRowUpdates( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 227 virtual void SAL_CALL moveToInsertRow( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 228 virtual void SAL_CALL moveToCurrentRow( ) throw(::com::sun::star::sdbc::SQLException, ::com::sun::star::uno::RuntimeException); 229 230 231 virtual sal_Bool previous_checked( sal_Bool i_bFetchRow ); 232 virtual sal_Bool absolute_checked( sal_Int32 row,sal_Bool i_bFetchRow ); 233 virtual sal_Bool last_checked( sal_Bool i_bFetchRow); 234 }; 235 } 236 #endif // DBACCESS_CORE_API_KEYSET_HXX 237 238