xref: /trunk/main/ucbhelper/inc/ucbhelper/propertyvalueset.hxx (revision 91144cd0085a7583d2099b982122deb2184ab956)

/**************************************************************
 *
 * 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_PROPERTYVALUESET_HXX
#define _UCBHELPER_PROPERTYVALUESET_HXX

#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/sdbc/XColumnLocate.hpp>
#include <com/sun/star/sdbc/XRow.hpp>
#include <com/sun/star/beans/Property.hpp>
#include <cppuhelper/weak.hxx>

#include "osl/mutex.hxx"
#include <ucbhelper/macros.hxx>
#include "ucbhelper/ucbhelperdllapi.h"

namespace com { namespace sun { namespace star { namespace script {
    class XTypeConverter;
} } } }

namespace com { namespace sun { namespace star { namespace beans {
    struct PropertyValue;
    class XPropertySet;
} } } }

namespace ucbhelper {

class PropertyValues;

//=========================================================================

/**
  * This class implements the interface XRow. After construction of a valueset
  * the user can append properties ( incl. its values ) to the set. This class
  * is useful when implementing the command "getPropertyValues", because the
  * values to return can easyly appended to a valueset object. That object can
  * directly be returned by the implementation of the command.
  */
class UCBHELPER_DLLPUBLIC PropertyValueSet :
                public cppu::OWeakObject,
                public com::sun::star::lang::XTypeProvider,
                public com::sun::star::sdbc::XRow,
                public com::sun::star::sdbc::XColumnLocate
{
    com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory >
                                     m_xSMgr;
    com::sun::star::uno::Reference< com::sun::star::script::XTypeConverter >
                                     m_xTypeConverter;
    osl::Mutex      m_aMutex;
    PropertyValues* m_pValues;
    sal_Bool        m_bWasNull;
    sal_Bool        m_bTriedToGetTypeConverter;

private:
    UCBHELPER_DLLPRIVATE const com::sun::star::uno::Reference<
            com::sun::star::script::XTypeConverter >&
    getTypeConverter();

public:
    PropertyValueSet(
            const com::sun::star::uno::Reference<
                com::sun::star::lang::XMultiServiceFactory >& rxSMgr );
    PropertyValueSet(
            const com::sun::star::uno::Reference<
                com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
            const com::sun::star::uno::Sequence<
                com::sun::star::beans::PropertyValue >& rValues );
    virtual ~PropertyValueSet();

    // XInterface
    XINTERFACE_DECL()

    // XTypeProvider
    XTYPEPROVIDER_DECL()

    // XRow
    virtual sal_Bool SAL_CALL
    wasNull();
    virtual ::rtl::OUString SAL_CALL
    getString( sal_Int32 columnIndex );
    virtual sal_Bool SAL_CALL
    getBoolean( sal_Int32 columnIndex );
    virtual sal_Int8 SAL_CALL
    getByte( sal_Int32 columnIndex );
    virtual sal_Int16 SAL_CALL
    getShort( sal_Int32 columnIndex );
    virtual sal_Int32 SAL_CALL
    getInt( sal_Int32 columnIndex );
    virtual sal_Int64 SAL_CALL
    getLong( sal_Int32 columnIndex );
    virtual float SAL_CALL
    getFloat( sal_Int32 columnIndex );
    virtual double SAL_CALL
    getDouble( sal_Int32 columnIndex );
    virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL
    getBytes( sal_Int32 columnIndex );
    virtual ::com::sun::star::util::Date SAL_CALL
    getDate( sal_Int32 columnIndex );
    virtual ::com::sun::star::util::Time SAL_CALL
    getTime( sal_Int32 columnIndex );
    virtual ::com::sun::star::util::DateTime SAL_CALL
    getTimestamp( sal_Int32 columnIndex );
    virtual ::com::sun::star::uno::Reference<
                ::com::sun::star::io::XInputStream > SAL_CALL
    getBinaryStream( sal_Int32 columnIndex );
    virtual ::com::sun::star::uno::Reference<
                ::com::sun::star::io::XInputStream > SAL_CALL
    getCharacterStream( sal_Int32 columnIndex );
    virtual ::com::sun::star::uno::Any SAL_CALL
    getObject( sal_Int32 columnIndex,
               const ::com::sun::star::uno::Reference<
                ::com::sun::star::container::XNameAccess >& typeMap );
    virtual ::com::sun::star::uno::Reference<
                ::com::sun::star::sdbc::XRef > SAL_CALL
    getRef( sal_Int32 columnIndex );
    virtual ::com::sun::star::uno::Reference<
                ::com::sun::star::sdbc::XBlob > SAL_CALL
    getBlob( sal_Int32 columnIndex );
    virtual ::com::sun::star::uno::Reference<
                ::com::sun::star::sdbc::XClob > SAL_CALL
    getClob( sal_Int32 columnIndex );
    virtual ::com::sun::star::uno::Reference<
                ::com::sun::star::sdbc::XArray > SAL_CALL
    getArray( sal_Int32 columnIndex );

    // XColumnLocate
    virtual sal_Int32 SAL_CALL
    findColumn( const ::rtl::OUString& columnName );

    //////////////////////////////////////////////////////////////////////
    // Non-interface methods
    //////////////////////////////////////////////////////////////////////

    /**
      * This method returns the number of elements of the value set.
      *
      * @return the number of elements of the value set.
      */
    sal_Int32 getLength() const;

    void appendString( const ::rtl::OUString& rPropName, const ::rtl::OUString& rValue );
    void appendString( const sal_Char* pAsciiPropName, const ::rtl::OUString& rValue )
    {
        appendString( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendString( const ::com::sun::star::beans::Property& rProp, const ::rtl::OUString& rValue )
    {
        appendString( rProp.Name, rValue );
    }

    void appendBoolean( const ::rtl::OUString& rPropName, sal_Bool bValue );
    void appendBoolean( const sal_Char* pAsciiPropName, sal_Bool bValue )
    {
        appendBoolean( ::rtl::OUString::createFromAscii( pAsciiPropName ), bValue );
    }
    void appendBoolean( const ::com::sun::star::beans::Property& rProp, sal_Bool bValue )
    {
        appendBoolean( rProp.Name, bValue );
    }

    void appendByte( const ::rtl::OUString& rPropName, sal_Int8 nValue );
    void appendByte( const sal_Char* pAsciiPropName, sal_Int8 nValue )
    {
        appendByte( ::rtl::OUString::createFromAscii( pAsciiPropName ), nValue );
    }
    void appendByte( const ::com::sun::star::beans::Property& rProp, sal_Int8 nValue )
    {
        appendByte( rProp.Name, nValue );
    }

    void appendShort( const ::rtl::OUString& rPropName, sal_Int16 nValue );
    void appendShort( const sal_Char* pAsciiPropName, sal_Int16 nValue )
    {
        appendShort( ::rtl::OUString::createFromAscii( pAsciiPropName ), nValue );
    }
    void appendShort( const ::com::sun::star::beans::Property& rProp, sal_Int16 nValue )
    {
        appendShort( rProp.Name, nValue );
    }

    void appendInt( const ::rtl::OUString& rPropName, sal_Int32 nValue );
    void appendInt( const sal_Char* pAsciiPropName, sal_Int32 nValue )
    {
        appendInt( ::rtl::OUString::createFromAscii( pAsciiPropName ), nValue );
    }
    void appendInt( const ::com::sun::star::beans::Property& rProp, sal_Int32 nValue )
    {
        appendInt( rProp.Name, nValue );
    }

    void appendLong( const ::rtl::OUString& rPropName, sal_Int64 nValue );
    void appendLong( const sal_Char* pAsciiPropName, sal_Int64 nValue )
    {
        appendLong( ::rtl::OUString::createFromAscii( pAsciiPropName ), nValue );
    }
    void appendLong( const ::com::sun::star::beans::Property& rProp, sal_Int64 nValue )
    {
        appendLong( rProp.Name, nValue );
    }

    void appendFloat( const ::rtl::OUString& rPropName, float nValue );
    void appendFloat( const sal_Char* pAsciiPropName, float nValue )
    {
        appendFloat( ::rtl::OUString::createFromAscii( pAsciiPropName ), nValue );
    }
    void appendFloat( const ::com::sun::star::beans::Property& rProp, float nValue )
    {
        appendFloat( rProp.Name, nValue );
    }

    void appendDouble( const ::rtl::OUString& rPropName, double nValue );
    void appendDouble( const sal_Char* pAsciiPropName, double nValue )
    {
        appendDouble( ::rtl::OUString::createFromAscii( pAsciiPropName ), nValue );
    }
    void appendDouble( const ::com::sun::star::beans::Property& rProp, double nValue )
    {
        appendDouble( rProp.Name, nValue );
    }

    void appendBytes( const ::rtl::OUString& rPropName, const ::com::sun::star::uno::Sequence< sal_Int8 >& rValue );
    void appendBytes( const sal_Char* pAsciiPropName, const ::com::sun::star::uno::Sequence< sal_Int8 >& rValue )
    {
        appendBytes( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendBytes( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::uno::Sequence< sal_Int8 >& rValue )
    {
        appendBytes( rProp.Name, rValue );
    }

    void appendDate( const ::rtl::OUString& rPropName, const ::com::sun::star::util::Date& rValue );
    void appendDate( const sal_Char* pAsciiPropName, const ::com::sun::star::util::Date& rValue )
    {
        appendDate( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendDate( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::util::Date& rValue )
    {
        appendDate( rProp.Name, rValue );
    }

    void appendTime( const ::rtl::OUString& rPropName, const ::com::sun::star::util::Time& rValue );
    void appendTime( const sal_Char* pAsciiPropName, const ::com::sun::star::util::Time& rValue )
    {
        appendTime( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendTime( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::util::Time& rValue )
    {
        appendTime( rProp.Name, rValue );
    }

    void appendTimestamp( const ::rtl::OUString& rPropName, const ::com::sun::star::util::DateTime& rValue );
    void appendTimestamp( const sal_Char* pAsciiPropName, const ::com::sun::star::util::DateTime& rValue )
    {
        appendTimestamp( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendTimestamp( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::util::DateTime& rValue )
    {
        appendTimestamp( rProp.Name, rValue );
    }

    void appendBinaryStream( const ::rtl::OUString& rPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rValue );
    void appendBinaryStream( const sal_Char* pAsciiPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rValue )
    {
        appendBinaryStream( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendBinaryStream( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rValue )
    {
        appendBinaryStream( rProp.Name, rValue );
    }

    void appendCharacterStream( const ::rtl::OUString& rPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rValue );
    void appendCharacterStream( const sal_Char* pAsciiPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rValue )
    {
        appendCharacterStream( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendCharacterStream( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rValue )
    {
        appendCharacterStream( rProp.Name, rValue );
    }

    void appendObject( const ::rtl::OUString& rPropName, const ::com::sun::star::uno::Any& rValue );
    void appendObject( const sal_Char* pAsciiPropName, const ::com::sun::star::uno::Any& rValue )
    {
        appendObject( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendObject( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::uno::Any& rValue )
    {
        appendObject( rProp.Name, rValue );
    }

    void appendRef( const ::rtl::OUString& rPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef >& rValue );
    void appendRef( const sal_Char* pAsciiPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef >& rValue )
    {
        appendRef( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendRef( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef >& rValue )
    {
        appendRef( rProp.Name, rValue );
    }

    void appendBlob( const ::rtl::OUString& rPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob >& rValue );
    void appendBlob( const sal_Char* pAsciiPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob >& rValue )
    {
        appendBlob( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendBlob( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob >& rValue )
    {
        appendBlob( rProp.Name, rValue );
    }

    void appendClob( const ::rtl::OUString& rPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob >& rValue );
    void appendClob( const sal_Char* pAsciiPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob >& rValue )
    {
        appendClob( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendClob( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob >& rValue )
    {
        appendClob( rProp.Name, rValue );
    }

    void appendArray( const ::rtl::OUString& rPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray >& rValue );
    void appendArray( const sal_Char* pAsciiPropName, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray >& rValue )
    {
        appendArray( ::rtl::OUString::createFromAscii( pAsciiPropName ), rValue );
    }
    void appendArray( const ::com::sun::star::beans::Property& rProp, const ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray >& rValue )
    {
        appendArray( rProp.Name, rValue );
    }

    void appendVoid( const ::rtl::OUString& rPropName );
    void appendVoid( const sal_Char* pAsciiPropName)
    {
        appendVoid( ::rtl::OUString::createFromAscii( pAsciiPropName ) );
    }
    void appendVoid( const ::com::sun::star::beans::Property& rProp )
    {
        appendVoid( rProp.Name );
    }

    /**
      * This method tries to append all property values contained in a
      * property set to the value set.
      *
      * @param  rSet is a property set containing the property values.
      */
    void appendPropertySet( const ::com::sun::star::uno::Reference<
                                ::com::sun::star::beans::XPropertySet >& rSet );

    /** This method tries to append a single property value contained in a
      * property set to the value set.
      *
      * @param  rSet is a property set containing the property values.
      * @param  rProperty is the property for that the value shall be obtained
      *         from the given property set.
      * @return False, if the property value cannot be obtained from the
      *         given property pet. True, otherwise.
      */
    sal_Bool appendPropertySetValue(
                        const ::com::sun::star::uno::Reference<
                            ::com::sun::star::beans::XPropertySet >& rSet,
                        const ::com::sun::star::beans::Property& rProperty );
};

}

#endif /* !_UCBHELPER_PROPERTYVALUESET_HXX */