INTEGRATION: CWS eforms2 (1.1.2); FILE ADDED

2004/07/26 10:24:02 fs 1.1.2.5: #i31958# bind controls only to certain supported XSD data types
2004/07/22 10:37:30 fs 1.1.2.4: #i31762# pass the context document of the introspectee to some handlers
2004/07/15 09:53:39 fs 1.1.2.3: #114856# added built-in clasification of the UNO data types
2004/04/27 14:16:25 fs 1.1.2.2: smarter behavior when switching models
2004/04/26 11:50:02 fs 1.1.2.1: helper for dealing with properties related to validating against an XSD data type

1 files changed, 370 insertions, 0 deletions

diff --git a/extensions/source/propctrlr/xsdvalidationhelper.cxx b/extensions/source/propctrlr/xsdvalidationhelper.cxx
new file mode 100644
index 000000000000..242bdd89395f
--- /dev/null
+++ b/extensions/source/propctrlr/xsdvalidationhelper.cxx
@@ -0,0 +1,370 @@
+/*************************************************************************
+ *
+ *  $RCSfile: xsdvalidationhelper.cxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2004-11-16 12:14:16 $
+ *
+ *  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 EXTENSIONS_SOURCE_PROPCTRLR_XSDVALIDATIONHELPER_HXX
+#include "xsdvalidationhelper.hxx"
+#endif
+#ifndef EXTENSIONS_SOURCE_PROPCTRLR_XSDDATATYPES_HXX
+#include "xsddatatypes.hxx"
+#endif
+#ifndef _EXTENSIONS_FORMSCTRLR_FORMSTRINGS_HXX_
+#include "formstrings.hxx"
+#endif
+
+/** === begin UNO includes === **/
+#ifndef _COM_SUN_STAR_XFORMS_XDATATYPEREPOSITORY_HPP_
+#include <com/sun/star/xforms/XDataTypeRepository.hpp>
+#endif
+/** === end UNO includes === **/
+
+//........................................................................
+namespace pcr
+{
+//........................................................................
+
+    using namespace ::com::sun::star;
+    using namespace ::com::sun::star::uno;
+    using namespace ::com::sun::star::beans;
+    using namespace ::com::sun::star::xsd;
+    using namespace ::com::sun::star::xforms;
+
+    //====================================================================
+    //= XSDValidationHelper
+    //====================================================================
+    //--------------------------------------------------------------------
+    XSDValidationHelper::XSDValidationHelper( const Reference< XPropertySet >& _rxIntrospectee, const Reference< frame::XModel >& _rxContextDocument )
+        :EFormsHelper( _rxIntrospectee, _rxContextDocument )
+    {
+    }
+
+    //--------------------------------------------------------------------
+    void XSDValidationHelper::getAvailableDataTypeNames( ::std::vector< ::rtl::OUString >& /* [out] */ _rNames ) const SAL_THROW(())
+    {
+        _rNames.resize( 0 );
+
+        try
+        {
+            Reference< XDataTypeRepository > xRepository = getDataTypeRepository();
+            Sequence< ::rtl::OUString > aElements;
+            if ( xRepository.is() )
+                aElements = xRepository->getElementNames();
+
+            _rNames.resize( aElements.getLength() );
+            ::std::copy( aElements.getConstArray(), aElements.getConstArray() + aElements.getLength(), _rNames.begin() );
+        }
+        catch( const Exception& )
+        {
+            OSL_ENSURE( sal_False, "XSDValidationHelper::getAvailableDataTypeNames: caught an exception!" );
+        }
+    }
+
+    //--------------------------------------------------------------------
+    Reference< XDataTypeRepository > XSDValidationHelper::getDataTypeRepository() const SAL_THROW((Exception))
+    {
+        Reference< XDataTypeRepository > xRepository;
+
+        Reference< xforms::XModel > xModel( getCurrentFormModel( ) );
+        if ( xModel.is() )
+            xRepository = xModel->getDataTypeRepository();
+
+        return xRepository;
+    }
+
+    //--------------------------------------------------------------------
+    Reference< XDataTypeRepository > XSDValidationHelper::getDataTypeRepository( const ::rtl::OUString& _rModelName ) const SAL_THROW((Exception))
+    {
+        Reference< XDataTypeRepository > xRepository;
+
+        Reference< xforms::XModel > xModel( getFormModelByName( _rModelName ) );
+        if ( xModel.is() )
+            xRepository = xModel->getDataTypeRepository();
+
+        return xRepository;
+    }
+
+    //--------------------------------------------------------------------
+    Reference< XDataType > XSDValidationHelper::getDataType( const ::rtl::OUString& _rName ) const SAL_THROW((Exception))
+    {
+        Reference< XDataType > xDataType;
+
+        if ( _rName.getLength() )
+        {
+            Reference< XDataTypeRepository > xRepository = getDataTypeRepository();
+            if ( xRepository.is() )
+                xDataType = xRepository->getDataType( _rName );
+        }
+        return xDataType;
+    }
+
+    //--------------------------------------------------------------------
+    ::rtl::OUString XSDValidationHelper::getValidatingDataTypeName( ) const SAL_THROW(())
+    {
+        ::rtl::OUString sDataTypeName;
+        try
+        {
+            Reference< XPropertySet > xBinding( getCurrentBinding() );
+            // it's allowed here to not (yet) have a binding
+            if ( xBinding.is() )
+            {
+                OSL_VERIFY( xBinding->getPropertyValue( PROPERTY_XSD_DATA_TYPE ) >>= sDataTypeName );
+            }
+        }
+        catch( const Exception& )
+        {
+            OSL_ENSURE( sal_False, "XSDValidationHelper::getValidatingDataTypeName: caught an exception!" );
+        }
+        return sDataTypeName;
+    }
+
+    //--------------------------------------------------------------------
+    ::rtl::Reference< XSDDataType > XSDValidationHelper::getDataTypeByName( const ::rtl::OUString& _rName ) const SAL_THROW(())
+    {
+        ::rtl::Reference< XSDDataType > pReturn;
+
+        try
+        {
+            Reference< XDataType > xValidatedAgainst;
+
+            if ( _rName.getLength() )
+                xValidatedAgainst = getDataType( _rName );
+
+            if ( xValidatedAgainst.is() )
+                pReturn = new XSDDataType( xValidatedAgainst );
+        }
+        catch( const Exception& )
+        {
+            OSL_ENSURE( sal_False, "XSDValidationHelper::getValidatingDataType: caught an exception!" );
+        }
+
+        return pReturn;
+    }
+
+    //--------------------------------------------------------------------
+    ::rtl::Reference< XSDDataType > XSDValidationHelper::getValidatingDataType( ) const SAL_THROW(())
+    {
+        return getDataTypeByName( getValidatingDataTypeName() );
+    }
+
+    //--------------------------------------------------------------------
+    bool XSDValidationHelper::cloneDataType( const ::rtl::Reference< XSDDataType >& _pDataType, const ::rtl::OUString& _rNewName ) const SAL_THROW(())
+    {
+        OSL_ENSURE( _pDataType.is(), "XSDValidationHelper::removeDataTypeFromRepository: invalid data type!" );
+        if ( !_pDataType.is() )
+            return false;
+
+        try
+        {
+            Reference< XDataTypeRepository > xRepository( getDataTypeRepository() );
+            OSL_ENSURE( xRepository.is(), "XSDValidationHelper::removeDataTypeFromRepository: invalid data type repository!" );
+            if ( !xRepository.is() )
+                return false;
+
+            Reference< XDataType > xDataType( _pDataType->getUnoDataType() );
+            OSL_ENSURE( xDataType.is(), "XSDValidationHelper::removeDataTypeFromRepository: invalid data type (II)!" );
+            if ( !xDataType.is() )
+                return false;
+
+            xRepository->cloneDataType( xDataType->getName(), _rNewName );
+        }
+        catch( const Exception& )
+        {
+            OSL_ENSURE( sal_False, "XSDValidationHelper::cloneDataType: caught an exception!" );
+        }
+        return true;
+    }
+
+    //--------------------------------------------------------------------
+    bool XSDValidationHelper::removeDataTypeFromRepository( const ::rtl::OUString& _rName ) const SAL_THROW(())
+    {
+        try
+        {
+            Reference< XDataTypeRepository > xRepository( getDataTypeRepository() );
+            OSL_ENSURE( xRepository.is(), "XSDValidationHelper::removeDataTypeFromRepository: invalid data type repository!" );
+            if ( !xRepository.is() )
+                return false;
+
+            if ( !xRepository->hasByName( _rName ) )
+            {
+                OSL_ENSURE( sal_False, "XSDValidationHelper::removeDataTypeFromRepository: invalid repository and/or data type!" );
+                return false;
+            }
+
+            xRepository->revokeDataType( _rName );
+        }
+        catch( const Exception& )
+        {
+            OSL_ENSURE( sal_False, "XSDValidationHelper::removeDataTypeFromRepository: caught an exception!" );
+            return false;
+        }
+        return true;
+    }
+
+    //--------------------------------------------------------------------
+    void XSDValidationHelper::setValidatingDataTypeByName( const ::rtl::OUString& _rName ) const SAL_THROW(())
+    {
+        try
+        {
+            Reference< XPropertySet > xBinding( getCurrentBinding() );
+            OSL_ENSURE( xBinding.is(), "XSDValidationHelper::setValidatingDataTypeByName: no active binding - how this?" );
+
+            if ( xBinding.is() )
+            {
+                // get the old data type - this is necessary for notifying property changes
+                ::rtl::OUString sDataTypeName;
+                OSL_VERIFY( xBinding->getPropertyValue( PROPERTY_XSD_DATA_TYPE ) >>= sDataTypeName );
+                Reference< XPropertySet > xOldType;
+                try { xOldType = xOldType.query( getDataType( sDataTypeName ) ); } catch( const Exception& ) { }
+
+                // set the new data type name
+                xBinding->setPropertyValue( PROPERTY_XSD_DATA_TYPE, makeAny( _rName ) );
+
+                // retrieve the new data type object
+                Reference< XPropertySet > xNewType( getDataType( _rName ), UNO_QUERY );
+
+                // fire any changes in the properties which result from this new type
+                std::set< ::rtl::OUString > aFilter; aFilter.insert( PROPERTY_NAME );
+                firePropertyChanges( xOldType, xNewType, aFilter );
+            }
+        }
+        catch( const Exception& e )
+        {
+#if OSL_DEBUG_LEVEL > 0
+            ::rtl::OString sMessage( "XSDValidationHelper::setValidatingDataTypeByName: caught an exception!" );
+            sMessage += "\nexception message:\n\n";
+            sMessage += ::rtl::OString( e.Message.getStr(), e.Message.getLength(), RTL_TEXTENCODING_ASCII_US );
+            OSL_ENSURE( sal_False, sMessage.getStr() );
+#endif
+        }
+    }
+
+    //--------------------------------------------------------------------
+    void XSDValidationHelper::copyDataType( const ::rtl::OUString& _rFromModel, const ::rtl::OUString& _rToModel,
+                const ::rtl::OUString& _rDataTypeName ) const SAL_THROW(())
+    {
+        if ( _rFromModel == _rToModel )
+            // nothing to do (me thinks)
+            return;
+
+        try
+        {
+            Reference< XDataTypeRepository > xFromRepository, xToRepository;
+            if ( _rFromModel.getLength() )
+                xFromRepository = getDataTypeRepository( _rFromModel );
+            if ( _rToModel.getLength() )
+                xToRepository = getDataTypeRepository( _rToModel );
+
+            if ( !xFromRepository.is() || !xToRepository.is() )
+                return;
+
+            if ( !xFromRepository->hasByName( _rDataTypeName ) || xToRepository->hasByName( _rDataTypeName ) )
+                // not existent in the source, or already existent (by name) in the destination
+                return;
+
+            // determine the built-in type belonging to the source type
+            ::rtl::Reference< XSDDataType > pSourceType = new XSDDataType( xFromRepository->getDataType( _rDataTypeName ) );
+            ::rtl::OUString sTargetBaseType = getBasicTypeNameForClass( pSourceType->classify(), xToRepository );
+
+            // create the target type
+            Reference< XDataType > xTargetType = xToRepository->cloneDataType( sTargetBaseType, _rDataTypeName );
+            ::rtl::Reference< XSDDataType > pTargetType = new XSDDataType( xTargetType );
+
+            // copy the facets
+            pTargetType->copyFacetsFrom( pSourceType );
+        }
+        catch( const Exception& )
+        {
+            OSL_ENSURE( sal_False, "XSDValidationHelper::copyDataType: caught an exception!" );
+        }
+    }
+
+    //--------------------------------------------------------------------
+    ::rtl::OUString XSDValidationHelper::getBasicTypeNameForClass( sal_Int16 _nClass ) const SAL_THROW(())
+    {
+        return getBasicTypeNameForClass( _nClass, getDataTypeRepository() );
+    }
+
+    //--------------------------------------------------------------------
+    ::rtl::OUString XSDValidationHelper::getBasicTypeNameForClass( sal_Int16 _nClass, Reference< XDataTypeRepository > _rxRepository ) const SAL_THROW(())
+    {
+        ::rtl::OUString sReturn;
+        OSL_ENSURE( _rxRepository.is(), "XSDValidationHelper::getBasicTypeNameForClass: invalid repository!" );
+        if ( !_rxRepository.is() )
+            return sReturn;
+
+        try
+        {
+            Reference< XDataType > xDataType = _rxRepository->getBasicDataType( _nClass );
+            OSL_ENSURE( xDataType.is(), "XSDValidationHelper::getBasicTypeNameForClass: invalid data type returned!" );
+            if ( xDataType.is() )
+                sReturn = xDataType->getName();
+        }
+        catch( const Exception& )
+        {
+            OSL_ENSURE( sal_False, "XSDValidationHelper::getBasicTypeNameForClass: caught an exception!" );
+        }
+
+        return sReturn;
+    }
+
+//........................................................................
+} // namespace pcr
+//........................................................................
+