1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef INCLUDED_XMLOFF_INC_MULTIPROPERTYSETHELPER_HXX
#define INCLUDED_XMLOFF_INC_MULTIPROPERTYSETHELPER_HXX
#include <rtl/ustring.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <tools/debug.hxx>
namespace com { namespace sun { namespace star {
namespace beans { class XMultiPropertySet; }
namespace beans { class XPropertySet; }
namespace beans { class XPropertySetInfo; }
} } }
/**
* The MultiPropertySetHelper performs the following functions:
*
* Given a list of property names (as sal_Char** or OUString*), it can
* query an XMultiPropertySet (or XPropertySet) which of these properties
* it supports (method hasProperties(...)). The properties *MUST* be
* sorted alphabetically.
*
* Then, the X(Multi)PropertySet can be queried for values, and only
* the supported properties are queried. (method getValues(...)) The
* values are stored in the helper itself.
*
* Finally, each property can be queried for existence
* (method hasProperty(...)) or its value (method (getValue(...))).
*
* After some initial preparation (hasProperties, getValues) the
* MultiPropertySetHelper can be used similarly to an
* XPropertySet in that you can query the values in the places where you
* need them. However, if an XMultiPropertySet is supplied, the queries
* are more efficient, often significantly so.
*/
class MultiPropertySetHelper
{
/// names of all properties
OUString* pPropertyNames;
/// length of pPropertyNames array
sal_Int16 nLength;
/// the sequence of property names that the current (multi)
/// property set implementation supports
::com::sun::star::uno::Sequence< OUString > aPropertySequence;
/// an array of indices that maps from pPropertyNames indices to
/// aPropertySequence indices
sal_Int16* pSequenceIndex;
/// the last set of values retrieved by getValues
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > aValues;
/// result of aValues.getConstArray()
const ::com::sun::star::uno::Any* pValues;
/// an empty Any
::com::sun::star::uno::Any aEmptyAny;
public:
MultiPropertySetHelper( const sal_Char** pNames );
~MultiPropertySetHelper();
/**
* Call hasPropertiesByName for the provided XPropertySetInfo and build
* list of allowed properties.
*/
void hasProperties( const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySetInfo> & );
/**
* Return whether hasProperties was called
* (i.e. if we are ready to call getValues)
*/
bool checkedProperties();
/**
* Get values from the XMultiPropertySet.
*
* May only be called after hasProperties() was called for the
* appropriate XPropertySetInfo.
*/
void getValues( const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XMultiPropertySet> & );
/**
* Get values from the XPropertySet. This can be much slower than
* getValues( const Reference<XMultiPropertySet& ) and hence
* should be avoided.
*
* May only be called after hasProperties() was called for the
* appropriate XPropertySetInfo.
*/
void getValues( const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet> & );
/**
* Get a value from the values array.
*
* May only be called after getValues() was called.
*/
inline const ::com::sun::star::uno::Any& getValue( sal_Int16 nIndex );
/**
* Find out if this property is supported.
*
* May only be called after hasProperties() was called.
*/
inline bool hasProperty( sal_Int16 nIndex );
/**
* Get a value from the XPropertySet on demand.
*
* If neither getValues nor getValueOnDemand has been called already
* after the last call to resetValues, the values are retrieved
* using getValues. Otherwise the value already retrieved is returned.
* In case XMultiPropertySet is supported by the XPropertySet and
* bTryMult is set, the XMultiPropertySet is used to get the values.
*
*/
const ::com::sun::star::uno::Any& getValue( sal_Int16 nIndex,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySet> &,
bool bTryMulti = false );
/**
* Get a value from the XMultiPropertySet on demand.
*
* If neither getValues nor getValueOnDemand has been called already
* after the last call to resetValues, the values are retrieved
* using getValues. Otherwise the value already retrieved is returned.
* In case XMultiPropertySet is supported by the XPropertySet,
* XMultiPropertySet is used to get the values.
*
*/
const ::com::sun::star::uno::Any& getValue( sal_Int16 nIndex,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XMultiPropertySet> & );
inline void resetValues() { pValues = nullptr; }
};
// inline implementations of the often-called methods getValue and hasProperty:
const ::com::sun::star::uno::Any& MultiPropertySetHelper::getValue(
sal_Int16 nValueNo )
{
assert(pValues && "called getValue() without calling getValues()");
assert(pSequenceIndex && "called getValue() without calling hasProperties()");
assert(nValueNo < nLength);
sal_Int16 nIndex = pSequenceIndex[ nValueNo ];
return ( nIndex != -1 ) ? pValues[ nIndex ] : aEmptyAny;
}
bool MultiPropertySetHelper::hasProperty( sal_Int16 nValueNo )
{
assert(pSequenceIndex && "called hasProperty() without calling hasProperties()");
assert(nValueNo < nLength);
return pSequenceIndex[ nValueNo ] != -1;
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
