1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski #ifndef _XMLOFF_CONDITIONALMULTIPROPERTYSETHELPER_HXX
24*b1cdbd2cSJim Jagielski #define _XMLOFF_CONDITIONALMULTIPROPERTYSETHELPER_HXX
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx>
27*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/Sequence.hxx>
28*b1cdbd2cSJim Jagielski #include <tools/debug.hxx>
29*b1cdbd2cSJim Jagielski
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielski namespace com { namespace sun { namespace star {
32*b1cdbd2cSJim Jagielski namespace beans { class XMultiPropertySet; }
33*b1cdbd2cSJim Jagielski namespace beans { class XPropertySet; }
34*b1cdbd2cSJim Jagielski namespace beans { class XPropertySetInfo; }
35*b1cdbd2cSJim Jagielski } } }
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski
38*b1cdbd2cSJim Jagielski /**
39*b1cdbd2cSJim Jagielski * The MultiPropertySetHelper performs the follwing functions:
40*b1cdbd2cSJim Jagielski *
41*b1cdbd2cSJim Jagielski * Given a list of property names (as sal_Char** or OUString*), it can
42*b1cdbd2cSJim Jagielski * query an XMultiPropertySet (or XPropertySet) which of these properties
43*b1cdbd2cSJim Jagielski * it supports (method hasProperties(...)). The properties *MUST* be
44*b1cdbd2cSJim Jagielski * sorted alphabetically.
45*b1cdbd2cSJim Jagielski *
46*b1cdbd2cSJim Jagielski * Then, the X(Multi)PropertySet can be queried for values, and only
47*b1cdbd2cSJim Jagielski * the supported properties are queried. (method getValues(...)) The
48*b1cdbd2cSJim Jagielski * values are stored in the helper itself.
49*b1cdbd2cSJim Jagielski *
50*b1cdbd2cSJim Jagielski * Finally, each property can be queried for existence
51*b1cdbd2cSJim Jagielski * (method hasProperty(...)) or its value (method (getValue(...))).
52*b1cdbd2cSJim Jagielski *
53*b1cdbd2cSJim Jagielski * After some initial preparation (hasProperties, getValues) the
54*b1cdbd2cSJim Jagielski * MultiPropertySetHelper can be used similarly to an
55*b1cdbd2cSJim Jagielski * XPropertySet in that you can query the values in the places where you
56*b1cdbd2cSJim Jagielski * need them. However, if an XMultiPropertySet is supplied, the queries
57*b1cdbd2cSJim Jagielski * are more efficient, often significantly so.
58*b1cdbd2cSJim Jagielski */
59*b1cdbd2cSJim Jagielski class MultiPropertySetHelper
60*b1cdbd2cSJim Jagielski {
61*b1cdbd2cSJim Jagielski /// names of all properties
62*b1cdbd2cSJim Jagielski ::rtl::OUString* pPropertyNames;
63*b1cdbd2cSJim Jagielski
64*b1cdbd2cSJim Jagielski /// length of pPropertyNames array
65*b1cdbd2cSJim Jagielski sal_Int16 nLength;
66*b1cdbd2cSJim Jagielski
67*b1cdbd2cSJim Jagielski /// the sequence of property names that the current (multi)
68*b1cdbd2cSJim Jagielski /// property set implementation supports
69*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Sequence< ::rtl::OUString > aPropertySequence;
70*b1cdbd2cSJim Jagielski
71*b1cdbd2cSJim Jagielski /// an array of indices that maps from pPropertyNames indices to
72*b1cdbd2cSJim Jagielski /// aPropertySequence indices
73*b1cdbd2cSJim Jagielski sal_Int16* pSequenceIndex;
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski /// the last set of values retrieved by getValues
76*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > aValues;
77*b1cdbd2cSJim Jagielski
78*b1cdbd2cSJim Jagielski /// result of aValues.getConstArray()
79*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Any* pValues;
80*b1cdbd2cSJim Jagielski
81*b1cdbd2cSJim Jagielski /// an empty Any
82*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Any aEmptyAny;
83*b1cdbd2cSJim Jagielski
84*b1cdbd2cSJim Jagielski public:
85*b1cdbd2cSJim Jagielski
86*b1cdbd2cSJim Jagielski MultiPropertySetHelper( const sal_Char** pNames );
87*b1cdbd2cSJim Jagielski
88*b1cdbd2cSJim Jagielski MultiPropertySetHelper( const ::rtl::OUString* pNames );
89*b1cdbd2cSJim Jagielski
90*b1cdbd2cSJim Jagielski ~MultiPropertySetHelper();
91*b1cdbd2cSJim Jagielski
92*b1cdbd2cSJim Jagielski
93*b1cdbd2cSJim Jagielski /**
94*b1cdbd2cSJim Jagielski * Call hasPropertiesByName for the provided XPropertySetInfo and build
95*b1cdbd2cSJim Jagielski * list of allowed properties.
96*b1cdbd2cSJim Jagielski */
97*b1cdbd2cSJim Jagielski void hasProperties( const ::com::sun::star::uno::Reference<
98*b1cdbd2cSJim Jagielski ::com::sun::star::beans::XPropertySetInfo> & );
99*b1cdbd2cSJim Jagielski
100*b1cdbd2cSJim Jagielski
101*b1cdbd2cSJim Jagielski /**
102*b1cdbd2cSJim Jagielski * Return whether hasProperties was called
103*b1cdbd2cSJim Jagielski * (i.e. if we are ready to call getValues)
104*b1cdbd2cSJim Jagielski */
105*b1cdbd2cSJim Jagielski sal_Bool checkedProperties();
106*b1cdbd2cSJim Jagielski
107*b1cdbd2cSJim Jagielski /**
108*b1cdbd2cSJim Jagielski * Get values from the XMultiPropertySet.
109*b1cdbd2cSJim Jagielski *
110*b1cdbd2cSJim Jagielski * May only be called after hasProperties() was called for the
111*b1cdbd2cSJim Jagielski * appropriate XPropertySetInfo.
112*b1cdbd2cSJim Jagielski */
113*b1cdbd2cSJim Jagielski void getValues( const ::com::sun::star::uno::Reference<
114*b1cdbd2cSJim Jagielski ::com::sun::star::beans::XMultiPropertySet> & );
115*b1cdbd2cSJim Jagielski
116*b1cdbd2cSJim Jagielski /**
117*b1cdbd2cSJim Jagielski * Get values from the XPropertySet. This can be much slower than
118*b1cdbd2cSJim Jagielski * getValues( const Reference<XMultiPropertySet& ) and hence
119*b1cdbd2cSJim Jagielski * should be avoided.
120*b1cdbd2cSJim Jagielski *
121*b1cdbd2cSJim Jagielski * May only be called after hasProperties() was called for the
122*b1cdbd2cSJim Jagielski * appropriate XPropertySetInfo.
123*b1cdbd2cSJim Jagielski */
124*b1cdbd2cSJim Jagielski void getValues( const ::com::sun::star::uno::Reference<
125*b1cdbd2cSJim Jagielski ::com::sun::star::beans::XPropertySet> & );
126*b1cdbd2cSJim Jagielski
127*b1cdbd2cSJim Jagielski
128*b1cdbd2cSJim Jagielski
129*b1cdbd2cSJim Jagielski /**
130*b1cdbd2cSJim Jagielski * Get a value from the values array.
131*b1cdbd2cSJim Jagielski *
132*b1cdbd2cSJim Jagielski * May only be called after getValues() was called.
133*b1cdbd2cSJim Jagielski */
134*b1cdbd2cSJim Jagielski inline const ::com::sun::star::uno::Any& getValue( sal_Int16 nIndex );
135*b1cdbd2cSJim Jagielski
136*b1cdbd2cSJim Jagielski /**
137*b1cdbd2cSJim Jagielski * Find out if this property is supported.
138*b1cdbd2cSJim Jagielski *
139*b1cdbd2cSJim Jagielski * May only be called after hasProperties() was called.
140*b1cdbd2cSJim Jagielski */
141*b1cdbd2cSJim Jagielski inline sal_Bool hasProperty( sal_Int16 nIndex );
142*b1cdbd2cSJim Jagielski
143*b1cdbd2cSJim Jagielski /**
144*b1cdbd2cSJim Jagielski * Get a value from the XPropertySet on demand.
145*b1cdbd2cSJim Jagielski *
146*b1cdbd2cSJim Jagielski * If neither getValues nor getValueOnDemand has been called already
147*b1cdbd2cSJim Jagielski * after the last call to resetValues, the values are retrieved
148*b1cdbd2cSJim Jagielski * using getValues. Otherwise the value already retrieved is returned.
149*b1cdbd2cSJim Jagielski * In case XMultiPropertySet is supported by the XPropertySet and
150*b1cdbd2cSJim Jagielski * bTryMult is set, the XMultiPropertySet is used to get the values.
151*b1cdbd2cSJim Jagielski *
152*b1cdbd2cSJim Jagielski */
153*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Any& getValue( sal_Int16 nIndex,
154*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference<
155*b1cdbd2cSJim Jagielski ::com::sun::star::beans::XPropertySet> &,
156*b1cdbd2cSJim Jagielski sal_Bool bTryMulti = sal_False );
157*b1cdbd2cSJim Jagielski
158*b1cdbd2cSJim Jagielski /**
159*b1cdbd2cSJim Jagielski * Get a value from the XMultiPropertySet on demand.
160*b1cdbd2cSJim Jagielski *
161*b1cdbd2cSJim Jagielski * If neither getValues nor getValueOnDemand has been called already
162*b1cdbd2cSJim Jagielski * after the last call to resetValues, the values are retrieved
163*b1cdbd2cSJim Jagielski * using getValues. Otherwise the value already retrieved is returned.
164*b1cdbd2cSJim Jagielski * In case XMultiPropertySet is supported by the XPropertySet,
165*b1cdbd2cSJim Jagielski * XMultiPropertySet is used to get the values.
166*b1cdbd2cSJim Jagielski *
167*b1cdbd2cSJim Jagielski */
168*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Any& getValue( sal_Int16 nIndex,
169*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Reference<
170*b1cdbd2cSJim Jagielski ::com::sun::star::beans::XMultiPropertySet> & );
171*b1cdbd2cSJim Jagielski
resetValues()172*b1cdbd2cSJim Jagielski inline void resetValues() { pValues = 0; }
173*b1cdbd2cSJim Jagielski };
174*b1cdbd2cSJim Jagielski
175*b1cdbd2cSJim Jagielski
176*b1cdbd2cSJim Jagielski // inline implementations of the often-called methods getValue and hasProperty:
177*b1cdbd2cSJim Jagielski
getValue(sal_Int16 nValueNo)178*b1cdbd2cSJim Jagielski const ::com::sun::star::uno::Any& MultiPropertySetHelper::getValue(
179*b1cdbd2cSJim Jagielski sal_Int16 nValueNo )
180*b1cdbd2cSJim Jagielski {
181*b1cdbd2cSJim Jagielski DBG_ASSERT( pValues != NULL,
182*b1cdbd2cSJim Jagielski "called getValue() without calling getValues() before");
183*b1cdbd2cSJim Jagielski DBG_ASSERT( pSequenceIndex != NULL,
184*b1cdbd2cSJim Jagielski "called getValue() without calling hasProperties() before" );
185*b1cdbd2cSJim Jagielski DBG_ASSERT( nValueNo < nLength, "index out of range" );
186*b1cdbd2cSJim Jagielski
187*b1cdbd2cSJim Jagielski sal_Int16 nIndex = pSequenceIndex[ nValueNo ];
188*b1cdbd2cSJim Jagielski return ( nIndex != -1 ) ? pValues[ nIndex ] : aEmptyAny;
189*b1cdbd2cSJim Jagielski }
190*b1cdbd2cSJim Jagielski
hasProperty(sal_Int16 nValueNo)191*b1cdbd2cSJim Jagielski sal_Bool MultiPropertySetHelper::hasProperty( sal_Int16 nValueNo )
192*b1cdbd2cSJim Jagielski {
193*b1cdbd2cSJim Jagielski DBG_ASSERT( pSequenceIndex != NULL,
194*b1cdbd2cSJim Jagielski "called getValue() without calling hasProperties() before" );
195*b1cdbd2cSJim Jagielski DBG_ASSERT( nValueNo < nLength, "index out of range" );
196*b1cdbd2cSJim Jagielski
197*b1cdbd2cSJim Jagielski return pSequenceIndex[ nValueNo ] != -1;
198*b1cdbd2cSJim Jagielski }
199*b1cdbd2cSJim Jagielski
200*b1cdbd2cSJim Jagielski #endif
201