| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef _UCBHELPER_RESULTSETMETADATA_HXX |
| #define _UCBHELPER_RESULTSETMETADATA_HXX |
| |
| #include <vector> |
| #include <com/sun/star/uno/Reference.hxx> |
| #include <com/sun/star/uno/Sequence.hxx> |
| #include <com/sun/star/lang/XTypeProvider.hpp> |
| #include <com/sun/star/sdbc/ColumnValue.hpp> |
| #include <com/sun/star/sdbc/XResultSetMetaData.hpp> |
| #include <cppuhelper/weak.hxx> |
| #include <ucbhelper/macros.hxx> |
| #include "ucbhelper/ucbhelperdllapi.h" |
| |
| namespace com { namespace sun { namespace star { |
| namespace lang { class XMultiServiceFactory; } |
| namespace beans { struct Property; } |
| } } } |
| |
| namespace ucbhelper_impl { |
| struct ResultSetMetaData_Impl; |
| } |
| |
| namespace ucbhelper |
| { |
| |
| //========================================================================= |
| |
| /** |
| * This is a structure that holds additional meta data for one column |
| * of a resultset. The default values set in the constructor should be a |
| * good guess for many UCB use cases. |
| */ |
| struct ResultSetColumnData |
| { |
| /** @see ResultSetMetaData::isAutoIncrement */ |
| sal_Bool isAutoIncrement; |
| |
| /** @see ResultSetMetaData::isCaseSensitive */ |
| sal_Bool isCaseSensitive; |
| |
| /** @see ResultSetMetaData::isSearchable */ |
| sal_Bool isSearchable; |
| |
| /** @see ResultSetMetaData::isCurrency */ |
| sal_Bool isCurrency; |
| |
| /** @see ResultSetMetaData::isNullable */ |
| sal_Int32 isNullable; |
| |
| /** @see ResultSetMetaData::isSigned */ |
| sal_Bool isSigned; |
| |
| /** @see ResultSetMetaData::getColumnDisplaySize */ |
| sal_Int32 columnDisplaySize; |
| |
| /** @see ResultSetMetaData::getColumnLabel */ |
| ::rtl::OUString columnLabel; |
| |
| /** @see ResultSetMetaData::getSchemaName */ |
| ::rtl::OUString schemaName; |
| |
| /** @see ResultSetMetaData::getPrecision */ |
| sal_Int32 precision; |
| |
| /** @see ResultSetMetaData::getScale */ |
| sal_Int32 scale; |
| |
| /** @see ResultSetMetaData::getTableName */ |
| ::rtl::OUString tableName; |
| |
| /** @see ResultSetMetaData::getCatalogName */ |
| ::rtl::OUString catalogName; |
| |
| /** @see ResultSetMetaData::getColumnTypeName */ |
| ::rtl::OUString columnTypeName; |
| |
| /** @see ResultSetMetaData::isReadOnly */ |
| sal_Bool isReadOnly; |
| |
| /** @see ResultSetMetaData::isWritable */ |
| sal_Bool isWritable; |
| |
| /** @see ResultSetMetaData::isDefinitelyWritable */ |
| sal_Bool isDefinitelyWritable; |
| |
| /** @see ResultSetMetaData::getColumnServiceName */ |
| ::rtl::OUString columnServiceName; |
| |
| inline ResultSetColumnData(); |
| }; |
| |
| // Note: Never change the initial values! Implementations using this struct |
| // may havily depend on the behaviour of the default constructor. |
| |
| ResultSetColumnData::ResultSetColumnData() |
| : isAutoIncrement( sal_False ), |
| isCaseSensitive( sal_True ), |
| isSearchable( sal_False ), |
| isCurrency( sal_False ), |
| isNullable( ::com::sun::star::sdbc::ColumnValue::NULLABLE ), |
| isSigned( sal_False ), |
| columnDisplaySize( 16 ), |
| precision( -1 ), |
| scale( 0 ), |
| isReadOnly( sal_True ), |
| isWritable( sal_False ), |
| isDefinitelyWritable( sal_False ) |
| { |
| } |
| |
| //========================================================================= |
| |
| /** |
| * This is an implementation of the interface XResultSetMetaData. It can be |
| * used to implement the interface |
| * com::sun::star::sdbc::XResultSetMetaDataSupplier, which is required for |
| * implementations of service com.sun.star.ucb.ContentResultSet. |
| */ |
| class UCBHELPER_DLLPUBLIC ResultSetMetaData : |
| public ::cppu::OWeakObject, |
| public ::com::sun::star::lang::XTypeProvider, |
| public ::com::sun::star::sdbc::XResultSetMetaData |
| { |
| private: |
| ucbhelper_impl::ResultSetMetaData_Impl* m_pImpl; |
| |
| protected: |
| ::com::sun::star::uno::Reference< |
| ::com::sun::star::lang::XMultiServiceFactory > m_xSMgr; |
| ::com::sun::star::uno::Sequence< |
| ::com::sun::star::beans::Property > m_aProps; |
| sal_Bool m_bReadOnly; |
| |
| public: |
| |
| /** |
| * Constructor. |
| * |
| * @param rxSMgr is a Servive Manager. |
| * @param rProps is a sequence of properties (partially) describing the |
| * columns of a resultset. |
| * @param bReadOnly is used to specify whether the whole(!) resultset |
| * is read-only. |
| */ |
| ResultSetMetaData( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::lang::XMultiServiceFactory >& rxSMgr, |
| const ::com::sun::star::uno::Sequence< |
| ::com::sun::star::beans::Property >& rProps, |
| sal_Bool bReadOnly = sal_True ); |
| |
| /** |
| * Constructor. |
| * |
| * @param rxSMgr is a Servive Manager. |
| * @param rProps is a sequence of properties (partially) describing the |
| * columns of a resultset. |
| * @param rColumnData contains additional meta data for the columns of |
| * a resultset, which override the default values returned by the |
| * appropriate methods of this class. The length of rColumnData |
| * must be the same as length of rProps. |
| * rColumnData[ 0 ] corresponds to data in rProps[ 0 ], |
| * rColumnData[ 1 ] corresponds to data in rProps[ 1 ], ... |
| */ |
| ResultSetMetaData( |
| const ::com::sun::star::uno::Reference< |
| ::com::sun::star::lang::XMultiServiceFactory >& rxSMgr, |
| const ::com::sun::star::uno::Sequence< |
| ::com::sun::star::beans::Property >& rProps, |
| const std::vector< ResultSetColumnData >& rColumnData ); |
| |
| /** |
| * Destructor. |
| */ |
| virtual ~ResultSetMetaData(); |
| |
| // XInterface |
| XINTERFACE_DECL() |
| |
| // XTypeProvider |
| XTYPEPROVIDER_DECL() |
| |
| // XResultSetMetaData |
| |
| /** |
| * Returns the number of columns of the resultset. |
| * |
| * @return the length of the property sequence. |
| */ |
| virtual sal_Int32 SAL_CALL |
| getColumnCount() |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Checks whether column is automatically numbered, which makes it |
| * read-only. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return true, if column is automatically numbered. |
| */ |
| virtual sal_Bool SAL_CALL |
| isAutoIncrement( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Checks whether column is case sensitive. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return true, if column is case sensitive. |
| */ |
| virtual sal_Bool SAL_CALL |
| isCaseSensitive( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Checks whether the value stored in column can be used in a |
| * WHERE clause. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return true, if the column is searchable. |
| */ |
| virtual sal_Bool SAL_CALL |
| isSearchable( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Checks whether column is a cash value. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return true, if the column is a cash value. |
| */ |
| virtual sal_Bool SAL_CALL |
| isCurrency( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Checks whether a NULL can be stored in column. |
| * |
| * @see com::sun::star::sdbc::ColumnValue |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return ::com::sun::star::sdbc::ColumnValue::NULLABLE, if a NULL |
| * can be stored in the column. |
| */ |
| virtual sal_Int32 SAL_CALL |
| isNullable( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Checks whether the value stored in column is a signed number. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return true, if the value stored in column is a signed number. |
| */ |
| virtual sal_Bool SAL_CALL |
| isSigned( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Gets the normal maximum width in characters for column. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the normal maximum width in characters for column. |
| */ |
| virtual sal_Int32 SAL_CALL |
| getColumnDisplaySize( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Gets the suggested column title for column, to be used in print- |
| * outs and displays. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the column label. |
| */ |
| virtual ::rtl::OUString SAL_CALL |
| getColumnLabel( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Gets the name of column. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the name of the property that corresponds to column. |
| */ |
| virtual ::rtl::OUString SAL_CALL |
| getColumnName( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Gets the schema name for the table from which column of this |
| * result set was derived. |
| * Because this feature is not widely supported, the return value |
| * for many DBMSs will be an empty string. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the schema name of column or an empty string. |
| */ |
| virtual ::rtl::OUString SAL_CALL |
| getSchemaName( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * For number types, getprecision gets the number of decimal digits |
| * in column. |
| * For character types, it gets the maximum length in characters for |
| * column. |
| * For binary types, it gets the maximum length in bytes for column. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the precision for the column. |
| */ |
| virtual sal_Int32 SAL_CALL |
| getPrecision( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Gets the number of digits to the right of the decimal point for |
| * values in column. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the scale of the column. |
| */ |
| virtual sal_Int32 SAL_CALL |
| getScale( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Gets the name of the table from which column of this result set |
| * was derived or "" if there is none (for example, for a join). |
| * Because this feature is not widely supported, the return value |
| * for many DBMSs will be an empty string. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the table name for column or an empty string. |
| */ |
| virtual ::rtl::OUString SAL_CALL |
| getTableName( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| virtual ::rtl::OUString SAL_CALL |
| /** |
| * Gets the catalog name for the table from which column of this |
| * result set was derived. |
| * Because this feature is not widely supported, the return value |
| * for many DBMSs will be an empty string. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the catalog name for column or an empty string. |
| */ |
| getCatalogName( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Gets the JDBC type for the value stored in column. ... The STRUCT |
| * and DISTINCT type codes are always returned for structured and |
| * distinct types, regardless of whether the value will be mapped |
| * according to the standard mapping or be a custom mapping. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the type of the property that corresponds to column - mapped |
| * from UNO-Type to SQL-Type. |
| */ |
| virtual sal_Int32 SAL_CALL |
| getColumnType( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Gets the type name used by this particular data source for the |
| * values stored in column. If the type code for the type of value |
| * stored in column is STRUCT, DISTINCT or JAVA_OBJECT, this method |
| * returns a fully-qualified SQL type name. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the column type name. |
| */ |
| virtual ::rtl::OUString SAL_CALL |
| getColumnTypeName( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Indicates whether a column is definitely not writable. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return true, if the column is definetely not writable. |
| */ |
| virtual sal_Bool SAL_CALL |
| isReadOnly( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Indicates whether it is possible for a write on the column to succeed. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return true, if it is possible for a write to succeed. |
| */ |
| virtual sal_Bool SAL_CALL |
| isWritable( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Indicates whether a write on the column will definitely succeed. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return true, if a write on the column will definetely succeed. |
| */ |
| virtual sal_Bool SAL_CALL |
| isDefinitelyWritable( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| /** |
| * Returns the fully-qualified name of the service whose instances |
| * are manufactured if the method |
| * com::sun::star::sdbc::ResultSet::getObject is called to retrieve a |
| * value from the column. |
| * |
| * @param column is the number of the column for that a value shall |
| * be returned. The first column is 1, the second is 2, ... |
| * @return the service name for column or an empty string, if no service |
| * is applicable. |
| */ |
| virtual ::rtl::OUString SAL_CALL |
| getColumnServiceName( sal_Int32 column ) |
| throw( ::com::sun::star::sdbc::SQLException, |
| ::com::sun::star::uno::RuntimeException ); |
| }; |
| |
| } // namespace ucbhelper |
| |
| #endif /* !_UCBHELPER_RESULTSETMETADATA_HXX */ |
