chart2/source/tools/RegressionCurveModel.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 // MARKER(update_precomp.py): autogen include statement, do not remove
  29 #include "precompiled_chart2.hxx"
  30 #include "RegressionCurveModel.hxx"
  31 #include "macros.hxx"
  32 #include "LineProperties.hxx"
  33 #include "RegressionCurveHelper.hxx"
  34 #include "RegressionCalculationHelper.hxx"
  35 #include "RegressionEquation.hxx"
  36 #include "ContainerHelper.hxx"
  37 #include "CloneHelper.hxx"
  38 #include "PropertyHelper.hxx"
  39 #include <com/sun/star/beans/PropertyAttribute.hpp>
  40 #include <rtl/math.hxx>
  41 #include <rtl/ustrbuf.hxx>
  42
  43 using namespace ::com::sun::star;
  44
  45 using ::rtl::OUString;
  46 using ::rtl::OUStringBuffer;
  47 using ::com::sun::star::beans::Property;
  48 using ::osl::MutexGuard;
  49
  50 namespace
  51 {
  52 static const OUString lcl_aImplementationName_MeanValue(
  53     RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.chart2.MeanValueRegressionCurve" ));
  54 static const OUString lcl_aImplementationName_Linear(
  55     RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.chart2.LinearRegressionCurve" ));
  56 static const OUString lcl_aImplementationName_Logarithmic(
  57     RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.chart2.LogarithmicRegressionCurve" ));
  58 static const OUString lcl_aImplementationName_Exponential(
  59     RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.chart2.ExponentialRegressionCurve" ));
  60 static const OUString lcl_aImplementationName_Potential(
  61     RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.comp.chart2.PotentialRegressionCurve" ));
  62
  63 static const OUString lcl_aServiceName(
  64     RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.chart2.RegressionCurve" ));
  65
  66 const uno::Sequence< Property > & lcl_GetPropertySequence()
  67 {
  68     static uno::Sequence< Property > aPropSeq;
  69
  70     // /--
  71     MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
  72     if( 0 == aPropSeq.getLength() )
  73     {
  74         // get properties
  75         ::std::vector< ::com::sun::star::beans::Property > aProperties;
  76         ::chart::LineProperties::AddPropertiesToVector( aProperties );
  77
  78         // and sort them for access via bsearch
  79         ::std::sort( aProperties.begin(), aProperties.end(),
  80                      ::chart::PropertyNameLess() );
  81
  82         // transfer result to static Sequence
  83         aPropSeq = ::chart::ContainerHelper::ContainerToSequence( aProperties );
  84     }
  85
  86     return aPropSeq;
  87 }
  88
  89 ::cppu::IPropertyArrayHelper & lcl_getInfoHelper()
  90 {
  91     static ::cppu::OPropertyArrayHelper aArrayHelper(
  92         lcl_GetPropertySequence(),
  93         /* bSorted = */ sal_True );
  94
  95     return aArrayHelper;
  96 }
  97
  98 } // anonymous namespace
  99
 100 namespace chart
 101 {
 102
 103 RegressionCurveModel::RegressionCurveModel(
 104     uno::Reference< uno::XComponentContext > const & xContext,
 105     tCurveType eCurveType ) :
 106         ::property::OPropertySet( m_aMutex ),
 107     m_xContext( xContext ),
 108     m_eRegressionCurveType( eCurveType ),
 109         m_xModifyEventForwarder( ModifyListenerHelper::createModifyEventForwarder()),
 110         m_xEquationProperties( new RegressionEquation( xContext ))
 111 {
 112     // set 0 line width (default) hard, so that it is always written to XML,
 113     // because the old implementation uses different defaults
 114     setFastPropertyValue_NoBroadcast(
 115         LineProperties::PROP_LINE_WIDTH, uno::makeAny( sal_Int32( 0 )));
 116     ModifyListenerHelper::addListener( m_xEquationProperties, m_xModifyEventForwarder );
 117 }
 118
 119 RegressionCurveModel::RegressionCurveModel( const RegressionCurveModel & rOther ) :
 120         MutexContainer(),
 121         impl::RegressionCurveModel_Base(),
 122         ::property::OPropertySet( rOther, m_aMutex ),
 123     m_xContext( rOther.m_xContext ),
 124     m_eRegressionCurveType( rOther.m_eRegressionCurveType ),
 125     m_xModifyEventForwarder( ModifyListenerHelper::createModifyEventForwarder())
 126 {
 127     m_xEquationProperties.set( CloneHelper::CreateRefClone< uno::Reference< beans::XPropertySet > >()( rOther.m_xEquationProperties ));
 128     ModifyListenerHelper::addListener( m_xEquationProperties, m_xModifyEventForwarder );
 129 }
 130
 131 RegressionCurveModel::~RegressionCurveModel()
 132 {}
 133
 134 // ____ XRegressionCurve ____
 135 uno::Reference< chart2::XRegressionCurveCalculator > SAL_CALL
 136     RegressionCurveModel::getCalculator()
 137     throw (uno::RuntimeException)
 138 {
 139     return RegressionCurveHelper::createRegressionCurveCalculatorByServiceName( getServiceName());
 140 }
 141
 142 uno::Reference< beans::XPropertySet > SAL_CALL RegressionCurveModel::getEquationProperties()
 143     throw (uno::RuntimeException)
 144 {
 145     return m_xEquationProperties;
 146 }
 147
 148 void SAL_CALL RegressionCurveModel::setEquationProperties( const uno::Reference< beans::XPropertySet >& xEquationProperties )
 149     throw (uno::RuntimeException)
 150 {
 151     if( xEquationProperties.is())
 152     {
 153         if( m_xEquationProperties.is())
 154             ModifyListenerHelper::removeListener( m_xEquationProperties, m_xModifyEventForwarder );
 155
 156         m_xEquationProperties.set( xEquationProperties );
 157         ModifyListenerHelper::addListener( m_xEquationProperties, m_xModifyEventForwarder );
 158         fireModifyEvent();
 159     }
 160 }
 161
 162 // ____ XServiceName ____
 163 ::rtl::OUString SAL_CALL RegressionCurveModel::getServiceName()
 164     throw (uno::RuntimeException)
 165 {
 166     switch( m_eRegressionCurveType )
 167     {
 168         case CURVE_TYPE_MEAN_VALUE:
 169             return C2U( "com.sun.star.chart2.MeanValueRegressionCurve" );
 170         case CURVE_TYPE_LINEAR:
 171             return C2U( "com.sun.star.chart2.LinearRegressionCurve" );
 172         case CURVE_TYPE_LOGARITHM:
 173             return C2U( "com.sun.star.chart2.LogarithmicRegressionCurve" );
 174         case CURVE_TYPE_EXPONENTIAL:
 175             return C2U( "com.sun.star.chart2.ExponentialRegressionCurve" );
 176         case CURVE_TYPE_POWER:
 177             return C2U( "com.sun.star.chart2.PotentialRegressionCurve" );
 178     }
 179
 180     return ::rtl::OUString();
 181 }
 182
 183 // ____ XModifyBroadcaster ____
 184 void SAL_CALL RegressionCurveModel::addModifyListener( const uno::Reference< util::XModifyListener >& aListener )
 185     throw (uno::RuntimeException)
 186 {
 187     try
 188     {
 189         uno::Reference< util::XModifyBroadcaster > xBroadcaster( m_xModifyEventForwarder, uno::UNO_QUERY_THROW );
 190         xBroadcaster->addModifyListener( aListener );
 191     }
 192     catch( const uno::Exception & ex )
 193     {
 194         ASSERT_EXCEPTION( ex );
 195     }
 196 }
 197
 198 void SAL_CALL RegressionCurveModel::removeModifyListener( const uno::Reference< util::XModifyListener >& aListener )
 199     throw (uno::RuntimeException)
 200 {
 201     try
 202     {
 203         uno::Reference< util::XModifyBroadcaster > xBroadcaster( m_xModifyEventForwarder, uno::UNO_QUERY_THROW );
 204         xBroadcaster->removeModifyListener( aListener );
 205     }
 206     catch( const uno::Exception & ex )
 207     {
 208         ASSERT_EXCEPTION( ex );
 209     }
 210 }
 211
 212 // ____ XModifyListener ____
 213 void SAL_CALL RegressionCurveModel::modified( const lang::EventObject& aEvent )
 214     throw (uno::RuntimeException)
 215 {
 216     m_xModifyEventForwarder->modified( aEvent );
 217 }
 218
 219 // ____ XEventListener (base of XModifyListener) ____
 220 void SAL_CALL RegressionCurveModel::disposing( const lang::EventObject& /* Source */ )
 221     throw (uno::RuntimeException)
 222 {
 223     // nothing
 224 }
 225
 226 // ____ OPropertySet ____
 227 void RegressionCurveModel::firePropertyChangeEvent()
 228 {
 229     fireModifyEvent();
 230 }
 231
 232 void RegressionCurveModel::fireModifyEvent()
 233 {
 234     m_xModifyEventForwarder->modified( lang::EventObject( static_cast< uno::XWeak* >( this )));
 235 }
 236
 237 // ================================================================================
 238
 239 // ____ OPropertySet ____
 240 uno::Any RegressionCurveModel::GetDefaultValue( sal_Int32 nHandle ) const
 241     throw(beans::UnknownPropertyException)
 242 {
 243     static tPropertyValueMap aStaticDefaults;
 244
 245     // /--
 246     ::osl::MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
 247     if( 0 == aStaticDefaults.size() )
 248     {
 249         // initialize defaults
 250         LineProperties::AddDefaultsToMap( aStaticDefaults );
 251     }
 252
 253     tPropertyValueMap::const_iterator aFound(
 254         aStaticDefaults.find( nHandle ));
 255
 256     if( aFound == aStaticDefaults.end())
 257         return uno::Any();
 258
 259     return (*aFound).second;
 260     // \--
 261 }
 262
 263 ::cppu::IPropertyArrayHelper & SAL_CALL RegressionCurveModel::getInfoHelper()
 264 {
 265     return lcl_getInfoHelper();
 266 }
 267
 268
 269 // ____ XPropertySet ____
 270 uno::Reference< beans::XPropertySetInfo > SAL_CALL
 271     RegressionCurveModel::getPropertySetInfo()
 272     throw (uno::RuntimeException)
 273 {
 274     static uno::Reference< beans::XPropertySetInfo > xInfo;
 275
 276     // /--
 277     MutexGuard aGuard( ::osl::Mutex::getGlobalMutex() );
 278     if( !xInfo.is())
 279     {
 280         xInfo = ::cppu::OPropertySetHelper::createPropertySetInfo(
 281             getInfoHelper());
 282     }
 283
 284     return xInfo;
 285     // \--
 286 }
 287
 288 // ================================================================================
 289
 290 // needed by MSC compiler
 291 using impl::RegressionCurveModel_Base;
 292
 293 IMPLEMENT_FORWARD_XINTERFACE2( RegressionCurveModel, RegressionCurveModel_Base, OPropertySet )
 294 IMPLEMENT_FORWARD_XTYPEPROVIDER2( RegressionCurveModel, RegressionCurveModel_Base, OPropertySet )
 295
 296
 297
 298 // implementations
 299
 300 // --------------------------------------------------------------------------------
 301
 302 MeanValueRegressionCurve::MeanValueRegressionCurve(
 303     const uno::Reference< uno::XComponentContext > & xContext )
 304         : RegressionCurveModel( xContext, RegressionCurveModel::CURVE_TYPE_MEAN_VALUE )
 305 {}
 306 MeanValueRegressionCurve::MeanValueRegressionCurve(
 307     const MeanValueRegressionCurve & rOther ) :
 308         RegressionCurveModel( rOther )
 309 {}
 310 MeanValueRegressionCurve::~MeanValueRegressionCurve()
 311 {}
 312 uno::Sequence< ::rtl::OUString > MeanValueRegressionCurve::getSupportedServiceNames_Static()
 313 {
 314     uno::Sequence< ::rtl::OUString > aServices( 2 );
 315     aServices[ 0 ] = lcl_aServiceName;
 316     aServices[ 1 ] = C2U( "com.sun.star.chart2.MeanValueRegressionCurve" );
 317     return aServices;
 318 }
 319 // implement XServiceInfo methods basing upon getSupportedServiceNames_Static
 320 APPHELPER_XSERVICEINFO_IMPL( MeanValueRegressionCurve, lcl_aImplementationName_MeanValue );
 321
 322 uno::Reference< util::XCloneable > SAL_CALL MeanValueRegressionCurve::createClone()
 323     throw (uno::RuntimeException)
 324 {
 325     return uno::Reference< util::XCloneable >( new MeanValueRegressionCurve( *this ));
 326 }
 327
 328 // --------------------------------------------------------------------------------
 329
 330 LinearRegressionCurve::LinearRegressionCurve(
 331     const uno::Reference< uno::XComponentContext > & xContext )
 332         : RegressionCurveModel( xContext, RegressionCurveModel::CURVE_TYPE_LINEAR )
 333 {}
 334 LinearRegressionCurve::LinearRegressionCurve(
 335     const LinearRegressionCurve & rOther ) :
 336         RegressionCurveModel( rOther )
 337 {}
 338 LinearRegressionCurve::~LinearRegressionCurve()
 339 {}
 340 uno::Sequence< ::rtl::OUString > LinearRegressionCurve::getSupportedServiceNames_Static()
 341 {
 342     uno::Sequence< ::rtl::OUString > aServices( 2 );
 343     aServices[ 0 ] = lcl_aServiceName;
 344     aServices[ 1 ] = C2U( "com.sun.star.chart2.LinearRegressionCurve" );
 345     return aServices;
 346 }
 347 // implement XServiceInfo methods basing upon getSupportedServiceNames_Static
 348 APPHELPER_XSERVICEINFO_IMPL( LinearRegressionCurve, lcl_aImplementationName_Linear );
 349
 350 uno::Reference< util::XCloneable > SAL_CALL LinearRegressionCurve::createClone()
 351     throw (uno::RuntimeException)
 352 {
 353     return uno::Reference< util::XCloneable >( new LinearRegressionCurve( *this ));
 354 }
 355
 356 // --------------------------------------------------------------------------------
 357
 358 LogarithmicRegressionCurve::LogarithmicRegressionCurve(
 359     const uno::Reference< uno::XComponentContext > & xContext )
 360         : RegressionCurveModel( xContext, RegressionCurveModel::CURVE_TYPE_LOGARITHM )
 361 {}
 362 LogarithmicRegressionCurve::LogarithmicRegressionCurve(
 363     const LogarithmicRegressionCurve & rOther ) :
 364         RegressionCurveModel( rOther )
 365 {}
 366 LogarithmicRegressionCurve::~LogarithmicRegressionCurve()
 367 {}
 368 uno::Sequence< ::rtl::OUString > LogarithmicRegressionCurve::getSupportedServiceNames_Static()
 369 {
 370     uno::Sequence< ::rtl::OUString > aServices( 2 );
 371     aServices[ 0 ] = lcl_aServiceName;
 372     aServices[ 1 ] = C2U( "com.sun.star.chart2.LogarithmicRegressionCurve" );
 373     return aServices;
 374 }
 375 // implement XServiceInfo methods basing upon getSupportedServiceNames_Static
 376 APPHELPER_XSERVICEINFO_IMPL( LogarithmicRegressionCurve, lcl_aImplementationName_Logarithmic );
 377
 378 uno::Reference< util::XCloneable > SAL_CALL LogarithmicRegressionCurve::createClone()
 379     throw (uno::RuntimeException)
 380 {
 381     return uno::Reference< util::XCloneable >( new LogarithmicRegressionCurve( *this ));
 382 }
 383
 384 // --------------------------------------------------------------------------------
 385
 386 ExponentialRegressionCurve::ExponentialRegressionCurve(
 387     const uno::Reference< uno::XComponentContext > & xContext )
 388         : RegressionCurveModel( xContext, RegressionCurveModel::CURVE_TYPE_EXPONENTIAL )
 389 {}
 390 ExponentialRegressionCurve::ExponentialRegressionCurve(
 391     const ExponentialRegressionCurve & rOther ) :
 392         RegressionCurveModel( rOther )
 393 {}
 394 ExponentialRegressionCurve::~ExponentialRegressionCurve()
 395 {}
 396 uno::Sequence< ::rtl::OUString > ExponentialRegressionCurve::getSupportedServiceNames_Static()
 397 {
 398     uno::Sequence< ::rtl::OUString > aServices( 2 );
 399     aServices[ 0 ] = lcl_aServiceName;
 400     aServices[ 1 ] = C2U( "com.sun.star.chart2.ExponentialRegressionCurve" );
 401     return aServices;
 402 }
 403 // implement XServiceInfo methods basing upon getSupportedServiceNames_Static
 404 APPHELPER_XSERVICEINFO_IMPL( ExponentialRegressionCurve, lcl_aImplementationName_Exponential );
 405
 406 uno::Reference< util::XCloneable > SAL_CALL ExponentialRegressionCurve::createClone()
 407     throw (uno::RuntimeException)
 408 {
 409     return uno::Reference< util::XCloneable >( new ExponentialRegressionCurve( *this ));
 410 }
 411
 412 // --------------------------------------------------------------------------------
 413
 414 PotentialRegressionCurve::PotentialRegressionCurve(
 415     const uno::Reference< uno::XComponentContext > & xContext )
 416         : RegressionCurveModel( xContext, RegressionCurveModel::CURVE_TYPE_POWER )
 417 {}
 418 PotentialRegressionCurve::PotentialRegressionCurve(
 419     const PotentialRegressionCurve & rOther ) :
 420         RegressionCurveModel( rOther )
 421 {}
 422 PotentialRegressionCurve::~PotentialRegressionCurve()
 423 {}
 424 uno::Sequence< ::rtl::OUString > PotentialRegressionCurve::getSupportedServiceNames_Static()
 425 {
 426     uno::Sequence< ::rtl::OUString > aServices( 2 );
 427     aServices[ 0 ] = lcl_aServiceName;
 428     aServices[ 1 ] = C2U( "com.sun.star.chart2.PotentialRegressionCurve" );
 429     return aServices;
 430 }
 431 // implement XServiceInfo methods basing upon getSupportedServiceNames_Static
 432 APPHELPER_XSERVICEINFO_IMPL( PotentialRegressionCurve, lcl_aImplementationName_Potential );
 433
 434 uno::Reference< util::XCloneable > SAL_CALL PotentialRegressionCurve::createClone()
 435     throw (uno::RuntimeException)
 436 {
 437     return uno::Reference< util::XCloneable >( new PotentialRegressionCurve( *this ));
 438 }
 439
 440
 441 } //  namespace chart