odk/examples/DevelopersGuide/Database/DriverSkeleton/SResultSet.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  the BSD license.
   6  *
   7  *  Copyright 2000, 2010 Oracle and/or its affiliates.
   8  *  All rights reserved.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *  1. Redistributions of source code must retain the above copyright
  14  *     notice, this list of conditions and the following disclaimer.
  15  *  2. Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in the
  17  *     documentation and/or other materials provided with the distribution.
  18  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  19  *     contributors may be used to endorse or promote products derived
  20  *     from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  26  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  31  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  32  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  *************************************************************************/
  35
  36 #ifndef INCLUDED_EXAMPLES_DATABASE_DRIVERSKELETON_SRESULTSET_HXX
  37 #define INCLUDED_EXAMPLES_DATABASE_DRIVERSKELETON_SRESULTSET_HXX
  38
  39 #include <com/sun/star/sdbc/XResultSet.hpp>
  40 #include <com/sun/star/sdbc/XRow.hpp>
  41 #include <com/sun/star/sdbc/XResultSetMetaDataSupplier.hpp>
  42 #include <com/sun/star/sdbc/XCloseable.hpp>
  43 #include <com/sun/star/sdbc/XColumnLocate.hpp>
  44 #include <com/sun/star/util/XCancellable.hpp>
  45 #include <com/sun/star/sdbc/XWarningsSupplier.hpp>
  46 #include <com/sun/star/sdbc/XResultSetUpdate.hpp>
  47 #include <com/sun/star/sdbc/XRowUpdate.hpp>
  48 #include <com/sun/star/sdbcx/XRowLocate.hpp>
  49 #include <com/sun/star/sdbcx/XDeleteRows.hpp>
  50 #include <cppuhelper/compbase12.hxx>
  51 #include "SStatement.hxx"
  52 #include "OSubComponent.hxx"
  53
  54 namespace connectivity
  55 {
  56     namespace skeleton
  57     {
  58
  59         /*
  60         **  OResultSet
  61         */
  62         typedef ::cppu::WeakComponentImplHelper12<      ::com::sun::star::sdbc::XResultSet,
  63                                                         ::com::sun::star::sdbc::XRow,
  64                                                         ::com::sun::star::sdbc::XResultSetMetaDataSupplier,
  65                                                         ::com::sun::star::util::XCancellable,
  66                                                         ::com::sun::star::sdbc::XWarningsSupplier,
  67                                                         ::com::sun::star::sdbc::XResultSetUpdate,
  68                                                         ::com::sun::star::sdbc::XRowUpdate,
  69                                                         ::com::sun::star::sdbcx::XRowLocate,
  70                                                         ::com::sun::star::sdbcx::XDeleteRows,
  71                                                         ::com::sun::star::sdbc::XCloseable,
  72                                                         ::com::sun::star::sdbc::XColumnLocate,
  73                                                         ::com::sun::star::lang::XServiceInfo> OResultSet_BASE;
  74
  75         class OResultSet :  public  OBase_Mutex,
  76                             public  OResultSet_BASE,
  77                             public  ::cppu::OPropertySetHelper,
  78                             public  OPropertyArrayUsageHelper<OResultSet>
  79         {
  80         protected:
  81             OStatement_Base*                            m_pStatement;
  82             ::com::sun::star::uno::WeakReferenceHelper  m_aStatement;
  83             ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData>        m_xMetaData;
  84             rtl_TextEncoding                            m_nTextEncoding;
  85             sal_Bool                                    m_bWasNull;
  86
  87             // OPropertyArrayUsageHelper
  88             virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const;
  89             // OPropertySetHelper
  90             virtual ::cppu::IPropertyArrayHelper & SAL_CALL getInfoHelper();
  91
  92             virtual sal_Bool SAL_CALL convertFastPropertyValue(
  93                                 ::com::sun::star::uno::Any & rConvertedValue,
  94                                 ::com::sun::star::uno::Any & rOldValue,
  95                                 sal_Int32 nHandle,
  96                                 const ::com::sun::star::uno::Any& rValue );
  97             virtual void SAL_CALL setFastPropertyValue_NoBroadcast(
  98                                     sal_Int32 nHandle,
  99                                     const ::com::sun::star::uno::Any& rValue
 100                                      );
 101             virtual void SAL_CALL getFastPropertyValue(
 102                                     ::com::sun::star::uno::Any& rValue,
 103                                     sal_Int32 nHandle
 104                                          ) const;
 105
 106             // you can't delete objects of this type
 107             virtual ~OResultSet();
 108         public:
 109             DECLARE_SERVICE_INFO();
 110
 111             OResultSet( OStatement_Base* pStmt);
 112
 113
 114             ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > operator *()
 115             {
 116                 return ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >(*(OResultSet_BASE*)this);
 117             }
 118
 119             // ::cppu::OComponentHelper
 120             virtual void SAL_CALL disposing();
 121             // XInterface
 122             virtual ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type & rType );
 123             virtual void SAL_CALL acquire() throw();
 124             virtual void SAL_CALL release() throw();
 125             //XTypeProvider
 126             virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes(  );
 127             // XPropertySet
 128             virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  );
 129             // XResultSet
 130             virtual sal_Bool SAL_CALL next(  );
 131             virtual sal_Bool SAL_CALL isBeforeFirst(  );
 132             virtual sal_Bool SAL_CALL isAfterLast(  );
 133             virtual sal_Bool SAL_CALL isFirst(  );
 134             virtual sal_Bool SAL_CALL isLast(  );
 135             virtual void SAL_CALL beforeFirst(  );
 136             virtual void SAL_CALL afterLast(  );
 137             virtual sal_Bool SAL_CALL first(  );
 138             virtual sal_Bool SAL_CALL last(  );
 139             virtual sal_Int32 SAL_CALL getRow(  );
 140             virtual sal_Bool SAL_CALL absolute( sal_Int32 row );
 141             virtual sal_Bool SAL_CALL relative( sal_Int32 rows );
 142             virtual sal_Bool SAL_CALL previous(  );
 143             virtual void SAL_CALL refreshRow(  );
 144             virtual sal_Bool SAL_CALL rowUpdated(  );
 145             virtual sal_Bool SAL_CALL rowInserted(  );
 146             virtual sal_Bool SAL_CALL rowDeleted(  );
 147             virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL getStatement(  );
 148             // XRow
 149             virtual sal_Bool SAL_CALL wasNull(  );
 150             virtual ::rtl::OUString SAL_CALL getString( sal_Int32 columnIndex );
 151             virtual sal_Bool SAL_CALL getBoolean( sal_Int32 columnIndex );
 152             virtual sal_Int8 SAL_CALL getByte( sal_Int32 columnIndex );
 153             virtual sal_Int16 SAL_CALL getShort( sal_Int32 columnIndex );
 154             virtual sal_Int32 SAL_CALL getInt( sal_Int32 columnIndex );
 155             virtual sal_Int64 SAL_CALL getLong( sal_Int32 columnIndex );
 156             virtual float SAL_CALL getFloat( sal_Int32 columnIndex );
 157             virtual double SAL_CALL getDouble( sal_Int32 columnIndex );
 158             virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getBytes( sal_Int32 columnIndex );
 159             virtual ::com::sun::star::util::Date SAL_CALL getDate( sal_Int32 columnIndex );
 160             virtual ::com::sun::star::util::Time SAL_CALL getTime( sal_Int32 columnIndex );
 161             virtual ::com::sun::star::util::DateTime SAL_CALL getTimestamp( sal_Int32 columnIndex );
 162             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getBinaryStream( sal_Int32 columnIndex );
 163             virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > SAL_CALL getCharacterStream( sal_Int32 columnIndex );
 164             virtual ::com::sun::star::uno::Any SAL_CALL getObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess >& typeMap );
 165             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef > SAL_CALL getRef( sal_Int32 columnIndex );
 166             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob > SAL_CALL getBlob( sal_Int32 columnIndex );
 167             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob > SAL_CALL getClob( sal_Int32 columnIndex );
 168             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray > SAL_CALL getArray( sal_Int32 columnIndex );
 169             // XResultSetMetaDataSupplier
 170             virtual ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSetMetaData > SAL_CALL getMetaData(  );
 171             // XCancellable
 172             virtual void SAL_CALL cancel(  );
 173             // XCloseable
 174             virtual void SAL_CALL close(  );
 175             // XWarningsSupplier
 176             virtual ::com::sun::star::uno::Any SAL_CALL getWarnings(  );
 177             virtual void SAL_CALL clearWarnings(  );
 178             // XResultSetUpdate
 179             virtual void SAL_CALL insertRow(  );
 180             virtual void SAL_CALL updateRow(  );
 181             virtual void SAL_CALL deleteRow(  );
 182             virtual void SAL_CALL cancelRowUpdates(  );
 183             virtual void SAL_CALL moveToInsertRow(  );
 184             virtual void SAL_CALL moveToCurrentRow(  );
 185             // XRowUpdate
 186             virtual void SAL_CALL updateNull( sal_Int32 columnIndex );
 187             virtual void SAL_CALL updateBoolean( sal_Int32 columnIndex, sal_Bool x );
 188             virtual void SAL_CALL updateByte( sal_Int32 columnIndex, sal_Int8 x );
 189             virtual void SAL_CALL updateShort( sal_Int32 columnIndex, sal_Int16 x );
 190             virtual void SAL_CALL updateInt( sal_Int32 columnIndex, sal_Int32 x );
 191             virtual void SAL_CALL updateLong( sal_Int32 columnIndex, sal_Int64 x );
 192             virtual void SAL_CALL updateFloat( sal_Int32 columnIndex, float x );
 193             virtual void SAL_CALL updateDouble( sal_Int32 columnIndex, double x );
 194             virtual void SAL_CALL updateString( sal_Int32 columnIndex, const ::rtl::OUString& x );
 195             virtual void SAL_CALL updateBytes( sal_Int32 columnIndex, const ::com::sun::star::uno::Sequence< sal_Int8 >& x );
 196             virtual void SAL_CALL updateDate( sal_Int32 columnIndex, const ::com::sun::star::util::Date& x );
 197             virtual void SAL_CALL updateTime( sal_Int32 columnIndex, const ::com::sun::star::util::Time& x );
 198             virtual void SAL_CALL updateTimestamp( sal_Int32 columnIndex, const ::com::sun::star::util::DateTime& x );
 199             virtual void SAL_CALL updateBinaryStream( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length );
 200             virtual void SAL_CALL updateCharacterStream( sal_Int32 columnIndex, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& x, sal_Int32 length );
 201             virtual void SAL_CALL updateObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Any& x );
 202             virtual void SAL_CALL updateNumericObject( sal_Int32 columnIndex, const ::com::sun::star::uno::Any& x, sal_Int32 scale );
 203             // XColumnLocate
 204             virtual sal_Int32 SAL_CALL findColumn( const ::rtl::OUString& columnName );
 205             // XRowLocate
 206             virtual ::com::sun::star::uno::Any SAL_CALL getBookmark(  );
 207             virtual sal_Bool SAL_CALL moveToBookmark( const ::com::sun::star::uno::Any& bookmark );
 208             virtual sal_Bool SAL_CALL moveRelativeToBookmark( const ::com::sun::star::uno::Any& bookmark, sal_Int32 rows );
 209             virtual sal_Int32 SAL_CALL compareBookmarks( const ::com::sun::star::uno::Any& first, const ::com::sun::star::uno::Any& second );
 210             virtual sal_Bool SAL_CALL hasOrderedBookmarks(  );
 211             virtual sal_Int32 SAL_CALL hashBookmark( const ::com::sun::star::uno::Any& bookmark );
 212             // XDeleteRows
 213             virtual ::com::sun::star::uno::Sequence< sal_Int32 > SAL_CALL deleteRows( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& rows );
 214         };
 215     }
 216 }
 217
 218 #endif // INCLUDED_EXAMPLES_DATABASE_DRIVERSKELETON_SRESULTSET_HXX
 219
 220 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */