xref: /trunk/main/svx/source/inc/sdbdatacolumn.hxx (revision 91144cd0085a7583d2099b982122deb2184ab956)
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 SVX_FORM_SDBDATACOLUMN_HXX
25 #define SVX_FORM_SDBDATACOLUMN_HXX
26 
27 #include <com/sun/star/beans/XPropertySet.hpp>
28 #include <com/sun/star/sdb/XColumn.hpp>
29 #include <com/sun/star/sdb/XColumnUpdate.hpp>
30 #include <osl/diagnose.h>
31 
32 //..............................................................................
33 namespace svxform
34 {
35 //..............................................................................
36 
37     //==========================================================================
38     //= DataColumn - a class wrapping an object implementing a sdb::DataColumn service
39     //==========================================================================
40     class DataColumn
41     {
42         // interfaces needed for sddb::Column
43         ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>    m_xPropertySet;
44         // interfaces needed for sdb::DataColumn
45         ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn>           m_xColumn;
46         ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumnUpdate>     m_xColumnUpdate;
47 
48     public:
DataColumn()49         DataColumn() { };
50         DataColumn(const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& _rxIFace);
51         // if the object behind _rxIFace doesn't fully support the DataColumn service,
52         // (which is checked via the supported interfaces) _all_ members will be set to
53         // void !, even if the object has some of the needed interfaces.
54 
is() const55         sal_Bool is() const { return m_xColumn.is(); }
Is() const56         sal_Bool Is() const { return m_xColumn.is(); }
supportsUpdate() const57         sal_Bool supportsUpdate() const { return m_xColumnUpdate.is(); }
58 
operator ->()59         DataColumn* operator ->() { return this; }
operator ::com::sun::star::uno::Reference<::com::sun::star::uno::XInterface>() const60         operator ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface> () const{ return m_xColumn.get(); }
61 
62         // 'conversions'
getPropertySet() const63         inline const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>& getPropertySet() const
64         {
65             return m_xPropertySet;
66         }
getColumn() const67         inline const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumn>& getColumn() const
68         {
69             return m_xColumn;
70         }
getColumnUpdate() const71         inline const ::com::sun::star::uno::Reference< ::com::sun::star::sdb::XColumnUpdate>& getColumnUpdate() const
72         {
73             OSL_ENSURE(m_xColumnUpdate.is() , "DataColumn::getColumnUpdate: NULL!");
74             return m_xColumnUpdate;
75         }
76 
77         // das normale queryInterface
queryInterface(const::com::sun::star::uno::Type & type)78         ::com::sun::star::uno::Any SAL_CALL queryInterface( const ::com::sun::star::uno::Type& type)
79         { return m_xColumn->queryInterface(type); }
80 
81         // ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet>
82         inline ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo> getPropertySetInfo() const;
83         inline void setPropertyValue(const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Any& aValue);
84         inline ::com::sun::star::uno::Any getPropertyValue(const ::rtl::OUString& PropertyName) const;
85         inline void addPropertyChangeListener(const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener>& xListener);
86         inline void removePropertyChangeListener(const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener>& aListener);
87         inline void addVetoableChangeListener(const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener>& aListener);
88         inline void removeVetoableChangeListener(const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener>& aListener);
89 
90         // ::com::sun::star::sdb::XColumn
91         inline sal_Bool wasNull();
92         inline ::rtl::OUString getString();
93         inline sal_Bool getBoolean();
94         inline sal_Int8 getByte();
95         inline sal_Int16 getShort();
96         inline sal_Int32 getInt();
97         inline sal_Int64 getLong();
98         inline float getFloat();
99         inline double getDouble();
100         inline ::com::sun::star::uno::Sequence< sal_Int8 > getBytes();
101         inline ::com::sun::star::util::Date getDate();
102         inline ::com::sun::star::util::Time getTime();
103         inline ::com::sun::star::util::DateTime  getTimestamp();
104         inline ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream> getBinaryStream();
105         inline ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream> getCharacterStream();
106         inline ::com::sun::star::uno::Any getObject(const ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameAccess>& typeMap);
107         inline ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRef> getRef();
108         inline ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XBlob> getBlob();
109         inline ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XClob> getClob();
110         inline ::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XArray> getArray();
111 
112         // XColumnUpdate
113         inline void updateNull(void);
114         inline void updateBoolean(sal_Bool x);
115         inline void updateByte(sal_Int8 x);
116         inline void updateShort(sal_Int16 x);
117         inline void updateInt(sal_Int32 x);
118         inline void updateLong(sal_Int64 x);
119         inline void updateFloat(float x);
120         inline void updateDouble(double x);
121         inline void updateString(const ::rtl::OUString& x);
122         inline void updateBytes(const ::com::sun::star::uno::Sequence< sal_Int8 >& x);
123         inline void updateDate(const com::sun::star::util::Date& x);
124         inline void updateTime(const ::com::sun::star::util::Time& x);
125         inline void updateTimestamp(const ::com::sun::star::util::DateTime& x);
126         inline void updateBinaryStream(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream>& x, sal_Int32 length);
127         inline void updateCharacterStream(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream>& x, sal_Int32 length);
128         inline void updateObject(const ::com::sun::star::uno::Any& x);
129         inline void updateNumericObject(const ::com::sun::star::uno::Any& x, sal_Int32 scale);
130     };
131 
132 #endif // SVX_FORM_SDBDATACOLUMN_HXX
133 
134 //..............................................................................
135 }   // namespace svxform
136 //..............................................................................
137