include/ucbhelper/resultsetmetadata.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
  20 #ifndef INCLUDED_UCBHELPER_RESULTSETMETADATA_HXX
  21 #define INCLUDED_UCBHELPER_RESULTSETMETADATA_HXX
  22
  23 #include <vector>
  24 #include <memory>
  25 #include <com/sun/star/uno/Reference.hxx>
  26 #include <com/sun/star/uno/Sequence.hxx>
  27 #include <com/sun/star/lang/XTypeProvider.hpp>
  28 #include <com/sun/star/sdbc/ColumnValue.hpp>
  29 #include <com/sun/star/sdbc/XResultSetMetaData.hpp>
  30 #include <cppuhelper/weak.hxx>
  31 #include <ucbhelper/macros.hxx>
  32 #include <ucbhelper/ucbhelperdllapi.h>
  33
  34 namespace com { namespace sun { namespace star {
  35     namespace lang  { class XMultiServiceFactory; }
  36     namespace beans { struct Property; }
  37 } } }
  38
  39 namespace ucbhelper_impl {
  40     struct ResultSetMetaData_Impl;
  41 }
  42
  43 namespace ucbhelper
  44 {
  45
  46
  47 /**
  48  * This is a structure that holds additional meta data for one column
  49  * of a resultset. The default values set in the constructor should be a
  50  * good guess for many UCB use cases.
  51  */
  52 struct ResultSetColumnData
  53 {
  54     /** @see ResultSetMetaData::isCaseSensitive */
  55     bool        isCaseSensitive;
  56
  57     /** @see ResultSetMetaData::getColumnDisplaySize */
  58     sal_Int32       columnDisplaySize;
  59
  60     /** @see ResultSetMetaData::getColumnLabel */
  61     OUString columnLabel;
  62
  63     /** @see ResultSetMetaData::getSchemaName */
  64     OUString schemaName;
  65
  66     /** @see ResultSetMetaData::getTableName */
  67     OUString tableName;
  68
  69     /** @see ResultSetMetaData::getCatalogName */
  70     OUString catalogName;
  71
  72     /** @see ResultSetMetaData::getColumnTypeName */
  73     OUString columnTypeName;
  74
  75     /** @see ResultSetMetaData::getColumnServiceName */
  76     OUString columnServiceName;
  77
  78     inline ResultSetColumnData();
  79 };
  80
  81 // Note: Never change the initial values! Implementations using this struct
  82 //       may heavily depend on the behaviour of the default constructor.
  83
  84 ResultSetColumnData::ResultSetColumnData()
  85 : isCaseSensitive( true ),
  86   columnDisplaySize( 16 )
  87 {
  88 }
  89
  90
  91 /**
  92  * This is an implementation of the interface XResultSetMetaData. It can be
  93  * used to implement the interface
  94  * css::sdbc::XResultSetMetaDataSupplier, which is required for
  95  * implementations of service com.sun.star.ucb.ContentResultSet.
  96  */
  97 class UCBHELPER_DLLPUBLIC ResultSetMetaData :
  98                 public ::cppu::OWeakObject,
  99                 public css::lang::XTypeProvider,
 100                 public css::sdbc::XResultSetMetaData
 101 {
 102 private:
 103     std::unique_ptr<ucbhelper_impl::ResultSetMetaData_Impl> m_pImpl;
 104
 105 protected:
 106     css::uno::Reference< css::uno::XComponentContext >    m_xContext;
 107     css::uno::Sequence< css::beans::Property >            m_aProps;
 108
 109 public:
 110
 111     /**
 112       * Constructor. ResultSet is readonly by default.
 113       *
 114       * @param rxSMgr is a Servive Manager.
 115       * @param rProps is a sequence of properties (partially) describing the
 116       *        columns of a resultset.
 117       */
 118     ResultSetMetaData(
 119             const css::uno::Reference< css::uno::XComponentContext >& rxContext,
 120             const css::uno::Sequence< css::beans::Property >& rProps );
 121
 122     /**
 123       * Constructor.
 124       *
 125       * @param rxSMgr is a Servive Manager.
 126       * @param rProps is a sequence of properties (partially) describing the
 127       *        columns of a resultset.
 128       * @param rColumnData contains additional meta data for the columns of
 129       *        a resultset, which override the default values returned by the
 130       *        appropriate methods of this class. The length of rColumnData
 131       *        must be the same as length of rProps.
 132       *        rColumnData[ 0 ] corresponds to data in rProps[ 0 ],
 133       *        rColumnData[ 1 ] corresponds to data in rProps[ 1 ], ...
 134       */
 135     ResultSetMetaData(
 136             const css::uno::Reference< css::uno::XComponentContext >& rxContext,
 137             const css::uno::Sequence< css::beans::Property >& rProps,
 138             const std::vector< ResultSetColumnData >& rColumnData );
 139
 140     /**
 141       * Destructor.
 142       */
 143     virtual ~ResultSetMetaData() override;
 144
 145     // XInterface
 146     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType )
 147         throw( css::uno::RuntimeException, std::exception ) override;
 148     virtual void SAL_CALL acquire()
 149         throw() override;
 150     virtual void SAL_CALL release()
 151         throw() override;
 152
 153     // XTypeProvider
 154     virtual css::uno::Sequence< sal_Int8 > SAL_CALL
 155     getImplementationId()
 156         throw( css::uno::RuntimeException, std::exception ) override;
 157     virtual css::uno::Sequence< css::uno::Type > SAL_CALL
 158     getTypes()
 159         throw( css::uno::RuntimeException, std::exception ) override;
 160
 161     // XResultSetMetaData
 162
 163     /**
 164       * Returns the number of columns of the resultset.
 165       *
 166       * @return the length of the property sequence.
 167       */
 168     virtual sal_Int32 SAL_CALL
 169     getColumnCount()
 170         throw( css::sdbc::SQLException,
 171                css::uno::RuntimeException, std::exception ) override;
 172     /**
 173       * Checks whether column is automatically numbered, which makes it
 174       * read-only.
 175       *
 176       * @param  column is the number of the column for that a value shall
 177       *         be returned. The first column is 1, the second is 2, ...
 178       * @return true, if column is automatically numbered.
 179       */
 180     virtual sal_Bool SAL_CALL
 181     isAutoIncrement( sal_Int32 column )
 182         throw( css::sdbc::SQLException,
 183                css::uno::RuntimeException, std::exception ) override;
 184     /**
 185       * Checks whether column is case sensitive.
 186       *
 187       * @param  column is the number of the column for that a value shall
 188       *         be returned. The first column is 1, the second is 2, ...
 189       * @return true, if column is case sensitive.
 190       */
 191     virtual sal_Bool SAL_CALL
 192     isCaseSensitive( sal_Int32 column )
 193         throw( css::sdbc::SQLException,
 194                css::uno::RuntimeException, std::exception ) override;
 195     /**
 196       * Checks whether the value stored in column can be used in a
 197       * WHERE clause.
 198       *
 199       * @param  column is the number of the column for that a value shall
 200       *         be returned. The first column is 1, the second is 2, ...
 201       * @return true, if the column is searchable.
 202       */
 203     virtual sal_Bool SAL_CALL
 204     isSearchable( sal_Int32 column )
 205         throw( css::sdbc::SQLException,
 206                css::uno::RuntimeException, std::exception ) override;
 207     /**
 208       * Checks whether column is a cash value.
 209       *
 210       * @param  column is the number of the column for that a value shall
 211       *         be returned. The first column is 1, the second is 2, ...
 212       * @return true, if the column is a cash value.
 213       */
 214     virtual sal_Bool SAL_CALL
 215     isCurrency( sal_Int32 column )
 216         throw( css::sdbc::SQLException,
 217                css::uno::RuntimeException, std::exception ) override;
 218     /**
 219       * Checks whether a NULL can be stored in column.
 220       *
 221       * @see css::sdbc::ColumnValue
 222       *
 223       * @param  column is the number of the column for that a value shall
 224       *         be returned. The first column is 1, the second is 2, ...
 225       * @return css::sdbc::ColumnValue::NULLABLE, if a NULL
 226       *         can be stored in the column.
 227       */
 228     virtual sal_Int32 SAL_CALL
 229     isNullable( sal_Int32 column )
 230         throw( css::sdbc::SQLException,
 231                css::uno::RuntimeException, std::exception ) override;
 232     /**
 233       * Checks whether the value stored in column is a signed number.
 234       *
 235       * @param  column is the number of the column for that a value shall
 236       *         be returned. The first column is 1, the second is 2, ...
 237       * @return true, if the value stored in column is a signed number.
 238       */
 239     virtual sal_Bool SAL_CALL
 240     isSigned( sal_Int32 column )
 241         throw( css::sdbc::SQLException,
 242                css::uno::RuntimeException, std::exception ) override;
 243     /**
 244       * Gets the normal maximum width in characters for column.
 245       *
 246       * @param  column is the number of the column for that a value shall
 247       *         be returned. The first column is 1, the second is 2, ...
 248       * @return the normal maximum width in characters for column.
 249       */
 250     virtual sal_Int32 SAL_CALL
 251     getColumnDisplaySize( sal_Int32 column )
 252         throw( css::sdbc::SQLException,
 253                css::uno::RuntimeException, std::exception ) override;
 254     /**
 255       * Gets the suggested column title for column, to be used in print-
 256       * outs and displays.
 257       *
 258       * @param  column is the number of the column for that a value shall
 259       *         be returned. The first column is 1, the second is 2, ...
 260       * @return the column label.
 261       */
 262     virtual OUString SAL_CALL
 263     getColumnLabel( sal_Int32 column )
 264         throw( css::sdbc::SQLException,
 265                css::uno::RuntimeException, std::exception ) override;
 266     /**
 267       * Gets the name of column.
 268       *
 269       * @param  column is the number of the column for that a value shall
 270       *         be returned. The first column is 1, the second is 2, ...
 271       * @return the name of the property that corresponds to column.
 272       */
 273     virtual OUString SAL_CALL
 274     getColumnName( sal_Int32 column )
 275         throw( css::sdbc::SQLException,
 276                css::uno::RuntimeException, std::exception ) override;
 277     /**
 278       * Gets the schema name for the table from which column of this
 279       * result set was derived.
 280       * Because this feature is not widely supported, the return value
 281       * for many DBMSs will be an empty string.
 282       *
 283       * @param  column is the number of the column for that a value shall
 284       *         be returned. The first column is 1, the second is 2, ...
 285       * @return the schema name of column or an empty string.
 286       */
 287     virtual OUString SAL_CALL
 288     getSchemaName( sal_Int32 column )
 289         throw( css::sdbc::SQLException,
 290                css::uno::RuntimeException, std::exception ) override;
 291     /**
 292       * For number types, getprecision gets the number of decimal digits
 293       * in column.
 294       * For character types, it gets the maximum length in characters for
 295       * column.
 296       * For binary types, it gets the maximum length in bytes for column.
 297       *
 298       * @param  column is the number of the column for that a value shall
 299       *         be returned. The first column is 1, the second is 2, ...
 300       * @return the precision for the column.
 301       */
 302     virtual sal_Int32 SAL_CALL
 303     getPrecision( sal_Int32 column )
 304         throw( css::sdbc::SQLException,
 305                css::uno::RuntimeException, std::exception ) override;
 306     /**
 307       * Gets the number of digits to the right of the decimal point for
 308       * values in column.
 309       *
 310       * @param  column is the number of the column for that a value shall
 311       *         be returned. The first column is 1, the second is 2, ...
 312       * @return the scale of the column.
 313       */
 314     virtual sal_Int32 SAL_CALL
 315     getScale( sal_Int32 column )
 316         throw( css::sdbc::SQLException,
 317                css::uno::RuntimeException, std::exception ) override;
 318     /**
 319       * Gets the name of the table from which column of this result set
 320       * was derived or "" if there is none (for example, for a join).
 321       * Because this feature is not widely supported, the return value
 322       * for many DBMSs will be an empty string.
 323       *
 324       * @param  column is the number of the column for that a value shall
 325       *         be returned. The first column is 1, the second is 2, ...
 326       * @return the table name for column or an empty string.
 327       */
 328     virtual OUString SAL_CALL
 329     getTableName( sal_Int32 column )
 330         throw( css::sdbc::SQLException,
 331                css::uno::RuntimeException, std::exception ) override;
 332     virtual OUString SAL_CALL
 333     /**
 334       * Gets the catalog name for the table from which column of this
 335       * result set was derived.
 336       * Because this feature is not widely supported, the return value
 337       * for many DBMSs will be an empty string.
 338       *
 339       * @param  column is the number of the column for that a value shall
 340       *         be returned. The first column is 1, the second is 2, ...
 341       * @return the catalog name for column or an empty string.
 342       */
 343     getCatalogName( sal_Int32 column )
 344         throw( css::sdbc::SQLException,
 345                css::uno::RuntimeException, std::exception ) override;
 346     /**
 347       * Gets the JDBC type for the value stored in column. ... The STRUCT
 348       * and DISTINCT type codes are always returned for structured and
 349       * distinct types, regardless of whether the value will be mapped
 350       * according to the standard mapping or be a custom mapping.
 351       *
 352       * @param  column is the number of the column for that a value shall
 353       *         be returned. The first column is 1, the second is 2, ...
 354       * @return the type of the property that corresponds to column - mapped
 355       *         from UNO-Type to SQL-Type.
 356       */
 357     virtual sal_Int32 SAL_CALL
 358     getColumnType( sal_Int32 column )
 359         throw( css::sdbc::SQLException,
 360                css::uno::RuntimeException, std::exception ) override;
 361     /**
 362       * Gets the type name used by this particular data source for the
 363       * values stored in column. If the type code for the type of value
 364       * stored in column is STRUCT, DISTINCT or JAVA_OBJECT, this method
 365       * returns a fully-qualified SQL type name.
 366       *
 367       * @param  column is the number of the column for that a value shall
 368       *         be returned. The first column is 1, the second is 2, ...
 369       * @return the column type name.
 370       */
 371     virtual OUString SAL_CALL
 372     getColumnTypeName( sal_Int32 column )
 373         throw( css::sdbc::SQLException,
 374                css::uno::RuntimeException, std::exception ) override;
 375     /**
 376       * Indicates whether a column is definitely not writable.
 377       *
 378       * @param  column is the number of the column for that a value shall
 379       *         be returned. The first column is 1, the second is 2, ...
 380       * @return true, if the column is definetely not writable.
 381       */
 382     virtual sal_Bool SAL_CALL
 383     isReadOnly( sal_Int32 column )
 384         throw( css::sdbc::SQLException,
 385                css::uno::RuntimeException, std::exception ) override;
 386     /**
 387       * Indicates whether it is possible for a write on the column to succeed.
 388       *
 389       * @param  column is the number of the column for that a value shall
 390       *         be returned. The first column is 1, the second is 2, ...
 391       * @return true, if it is possible for a write to succeed.
 392       */
 393     virtual sal_Bool SAL_CALL
 394     isWritable( sal_Int32 column )
 395         throw( css::sdbc::SQLException,
 396                css::uno::RuntimeException, std::exception ) override;
 397     /**
 398       * Indicates whether a write on the column will definitely succeed.
 399       *
 400       * @param  column is the number of the column for that a value shall
 401       *         be returned. The first column is 1, the second is 2, ...
 402       * @return true, if a write on the column will definetely succeed.
 403       */
 404     virtual sal_Bool SAL_CALL
 405     isDefinitelyWritable( sal_Int32 column )
 406         throw( css::sdbc::SQLException,
 407                css::uno::RuntimeException, std::exception ) override;
 408     /**
 409       * Returns the fully-qualified name of the service whose instances
 410       * are manufactured if the method
 411       * css::sdbc::ResultSet::getObject is called to retrieve a
 412       * value from the column.
 413       *
 414       * @param  column is the number of the column for that a value shall
 415       *         be returned. The first column is 1, the second is 2, ...
 416       * @return the service name for column or an empty string, if no service
 417       *         is applicable.
 418       */
 419     virtual OUString SAL_CALL
 420     getColumnServiceName( sal_Int32 column )
 421         throw( css::sdbc::SQLException,
 422                css::uno::RuntimeException, std::exception ) override;
 423 };
 424
 425 } // namespace ucbhelper
 426
 427 #endif /* ! INCLUDED_UCBHELPER_RESULTSETMETADATA_HXX */
 428
 429 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */