added: MultiPropertySetHelper

1 files changed, 227 insertions, 0 deletions

diff --git a/xmloff/inc/MultiPropertySetHelper.hxx b/xmloff/inc/MultiPropertySetHelper.hxx
new file mode 100644
index 000000000000..992365c2d2da
--- /dev/null
+++ b/xmloff/inc/MultiPropertySetHelper.hxx
@@ -0,0 +1,227 @@
+/*************************************************************************
+ *
+ *  $RCSfile: MultiPropertySetHelper.hxx,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: dvo $ $Date: 2001-05-14 13:04:53 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef _XMLOFF_CONDITIONALMULTIPROPERTYSETHELPER_HXX
+#define _XMLOFF_CONDITIONALMULTIPROPERTYSETHELPER_HXX
+
+#ifndef _RTL_USTRING_HXX_
+#include <rtl/ustring.hxx>
+#endif
+
+#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
+#include <com/sun/star/uno/Sequence.hxx>
+#endif
+
+#ifndef _TOOLS_DEBUG_HXX
+#include <tools/debug.hxx>
+#endif
+
+
+namespace com { namespace sun { namespace star {
+    namespace beans { class XMultiPropertySet; }
+    namespace beans { class XPropertySet; }
+    namespace beans { class XPropertySetInfo; }
+} } }
+
+
+/**
+ * The MultiPropertySetHelper performs the follwing 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(...)).
+ *
+ * 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 seom 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
+    ::rtl::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<::rtl::OUString> aPropertySequence;
+
+#ifndef PRODUCT
+    /// name of the implementation for which hasProperties() was called
+    ::rtl::OUString sImplementationName;
+#endif
+
+    /// 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( const ::rtl::OUString* 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> & );
+
+    /**
+     * Call hasProperties for the XMultiPropertySet's info.
+     */
+    void hasProperties( const ::com::sun::star::uno::Reference<
+                            ::com::sun::star::beans::XMultiPropertySet> & );
+
+    /**
+     * Call hasProperties for the XPropertySet's info.
+     */
+    void hasProperties( const ::com::sun::star::uno::Reference<
+                            ::com::sun::star::beans::XPropertySet> & );
+
+
+
+    /**
+     * 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 sal_Bool hasProperty( sal_Int16 nIndex );
+
+};
+
+
+// inline implementations of the often-called methods getValue and hasProperty:
+
+const ::com::sun::star::uno::Any& MultiPropertySetHelper::getValue(
+    sal_Int16 nValueNo )
+{
+    DBG_ASSERT( pValues != NULL,
+                "called getValue() without calling getValues() before");
+    DBG_ASSERT( pSequenceIndex != NULL,
+                "called getValue() without calling hasProperties() before" );
+    DBG_ASSERT( nValueNo < nIndex, "index out of range" );
+
+    sal_Int16 nIndex = pSequenceIndex[ nValueNo ];
+    return ( nIndex != -1 ) ? pValues[ nIndex ] : aEmptyAny;
+}
+
+sal_Bool MultiPropertySetHelper::hasProperty( sal_Int16 nValueNo )
+{
+    DBG_ASSERT( pSequenceIndex != NULL,
+                "called getValue() without calling hasProperties() before" );
+    DBG_ASSERT( nValueNo < nIndex, "index out of range" );
+
+    return pSequenceIndex[ nValueNo ] != -1;
+}
+
+#endif