Files
libreoffice/svx/source/form/dataaccessdescriptor.cxx
Stephan Bergmann 54e87df11f Change INetProtocol enumerators to CamelCase
...to avoid clashes with macros and poor warnings about hiding global FILE

Change-Id: I444e8b958f029201b228937e088efabc4b6d3050
2015-04-02 18:33:37 +02:00

407 lines
14 KiB
C++

/* -*- 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 .
*/
#include <svx/dataaccessdescriptor.hxx>
#include <comphelper/propertysetinfo.hxx>
#include <comphelper/genericpropertyset.hxx>
#include <osl/diagnose.h>
#include <com/sun/star/sdbc/XConnection.hpp>
#include <com/sun/star/ucb/XContent.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <tools/urlobj.hxx>
namespace svx
{
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::sdbc;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::ucb;
using namespace ::comphelper;
class ODADescriptorImpl
{
protected:
bool m_bSetOutOfDate : 1;
bool m_bSequenceOutOfDate : 1;
public:
typedef ::std::map< DataAccessDescriptorProperty, Any > DescriptorValues;
DescriptorValues m_aValues;
Sequence< PropertyValue > m_aAsSequence;
Reference< XPropertySet > m_xAsSet;
typedef ::std::map< OUString, PropertyMapEntry const * > MapString2PropertyEntry;
public:
ODADescriptorImpl();
ODADescriptorImpl(const ODADescriptorImpl& _rSource);
void invalidateExternRepresentations();
void updateSequence();
/** builds the descriptor from a property value sequence
@return <TRUE/>
if and only if the sequence contained valid properties only
*/
bool buildFrom( const Sequence< PropertyValue >& _rValues );
/** builds the descriptor from a property set
@return <TRUE/>
if and only if the set contained valid properties only
*/
bool buildFrom( const Reference< XPropertySet >& _rValues );
protected:
static PropertyValue buildPropertyValue( const DescriptorValues::const_iterator& _rPos );
static const MapString2PropertyEntry& getPropertyMap( );
static PropertyMapEntry const * getPropertyMapEntry( const DescriptorValues::const_iterator& _rPos );
};
ODADescriptorImpl::ODADescriptorImpl()
:m_bSetOutOfDate(true)
,m_bSequenceOutOfDate(true)
{
}
ODADescriptorImpl::ODADescriptorImpl(const ODADescriptorImpl& _rSource)
:m_bSetOutOfDate( _rSource.m_bSetOutOfDate )
,m_bSequenceOutOfDate( _rSource.m_bSequenceOutOfDate )
,m_aValues( _rSource.m_aValues )
{
if (!m_bSetOutOfDate)
m_xAsSet = _rSource.m_xAsSet;
if (!m_bSequenceOutOfDate)
m_aAsSequence = _rSource.m_aAsSequence;
}
bool ODADescriptorImpl::buildFrom( const Sequence< PropertyValue >& _rValues )
{
const MapString2PropertyEntry& rProperties = getPropertyMap();
bool bValidPropsOnly = true;
// loop through the sequence, and fill our m_aValues
const PropertyValue* pValues = _rValues.getConstArray();
const PropertyValue* pValuesEnd = pValues + _rValues.getLength();
for (;pValues != pValuesEnd; ++pValues)
{
MapString2PropertyEntry::const_iterator aPropPos = rProperties.find( pValues->Name );
if ( aPropPos != rProperties.end() )
{
DataAccessDescriptorProperty eProperty = (DataAccessDescriptorProperty)aPropPos->second->mnHandle;
m_aValues[eProperty] = pValues->Value;
}
else
// unknown property
bValidPropsOnly = false;
}
if (bValidPropsOnly)
{
m_aAsSequence = _rValues;
m_bSequenceOutOfDate = false;
}
else
m_bSequenceOutOfDate = true;
return bValidPropsOnly;
}
bool ODADescriptorImpl::buildFrom( const Reference< XPropertySet >& _rxValues )
{
Reference< XPropertySetInfo > xPropInfo;
if (_rxValues.is())
xPropInfo = _rxValues->getPropertySetInfo();
if (!xPropInfo.is())
{
OSL_FAIL("ODADescriptorImpl::buildFrom: invalid property set!");
return false;
}
// build a PropertyValue sequence with the current values
Sequence< Property > aProperties = xPropInfo->getProperties();
const Property* pProperty = aProperties.getConstArray();
const Property* pPropertyEnd = pProperty + aProperties.getLength();
Sequence< PropertyValue > aValues(aProperties.getLength());
PropertyValue* pValues = aValues.getArray();
for (;pProperty != pPropertyEnd; ++pProperty, ++pValues)
{
pValues->Name = pProperty->Name;
pValues->Value = _rxValues->getPropertyValue(pProperty->Name);
}
bool bValidPropsOnly = buildFrom(aValues);
if (bValidPropsOnly)
{
m_xAsSet = _rxValues;
m_bSetOutOfDate = false;
}
else
m_bSetOutOfDate = true;
return bValidPropsOnly;
}
void ODADescriptorImpl::invalidateExternRepresentations()
{
m_bSetOutOfDate = true;
m_bSequenceOutOfDate = true;
}
const ODADescriptorImpl::MapString2PropertyEntry& ODADescriptorImpl::getPropertyMap( )
{
// the properties we know
static MapString2PropertyEntry s_aProperties;
if ( s_aProperties.empty() )
{
static PropertyMapEntry const s_aDesriptorProperties[] =
{
{ OUString("ActiveConnection"), daConnection, cppu::UnoType<XConnection>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("BookmarkSelection"), daBookmarkSelection, cppu::UnoType<bool>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("Column"), daColumnObject, cppu::UnoType<XPropertySet>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("ColumnName"), daColumnName, ::cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("Command"), daCommand, ::cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("CommandType"), daCommandType, ::cppu::UnoType<sal_Int32>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("Component"), daComponent, cppu::UnoType<XContent>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("ConnectionResource"), daConnectionResource, ::cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("Cursor"), daCursor, cppu::UnoType<XResultSet>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("DataSourceName"), daDataSource, ::cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("DatabaseLocation"), daDatabaseLocation, ::cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("EscapeProcessing"), daEscapeProcessing, cppu::UnoType<bool>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("Filter"), daFilter, ::cppu::UnoType<OUString>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString("Selection"), daSelection, cppu::UnoType<Sequence< Any >>::get(), PropertyAttribute::TRANSIENT, 0 },
{ OUString(), 0, css::uno::Type(), 0, 0 }
};
PropertyMapEntry const * pEntry = s_aDesriptorProperties;
while ( !pEntry->maName.isEmpty() )
{
s_aProperties[ pEntry->maName ] = pEntry;
++pEntry;
}
}
return s_aProperties;
}
PropertyMapEntry const * ODADescriptorImpl::getPropertyMapEntry( const DescriptorValues::const_iterator& _rPos )
{
const MapString2PropertyEntry& rProperties = getPropertyMap();
sal_Int32 nNeededHandle = (sal_Int32)(_rPos->first);
for ( MapString2PropertyEntry::const_iterator loop = rProperties.begin();
loop != rProperties.end();
++loop
)
{
if ( nNeededHandle == loop->second->mnHandle )
return loop->second;
}
throw RuntimeException();
}
PropertyValue ODADescriptorImpl::buildPropertyValue( const DescriptorValues::const_iterator& _rPos )
{
// the map entry
PropertyMapEntry const * pProperty = getPropertyMapEntry( _rPos );
// build the property value
PropertyValue aReturn;
aReturn.Name = pProperty->maName;
aReturn.Handle = pProperty->mnHandle;
aReturn.Value = _rPos->second;
aReturn.State = PropertyState_DIRECT_VALUE;
// outta here
return aReturn;
}
void ODADescriptorImpl::updateSequence()
{
if (!m_bSequenceOutOfDate)
return;
m_aAsSequence.realloc(m_aValues.size());
PropertyValue* pValue = m_aAsSequence.getArray();
// loop through all our values
for ( DescriptorValues::const_iterator aLoop = m_aValues.begin();
aLoop != m_aValues.end();
++aLoop, ++pValue
)
{
*pValue = buildPropertyValue(aLoop);
}
// don't need to rebuild next time
m_bSequenceOutOfDate = false;
}
ODataAccessDescriptor::ODataAccessDescriptor()
:m_pImpl(new ODADescriptorImpl)
{
}
ODataAccessDescriptor::ODataAccessDescriptor( const ODataAccessDescriptor& _rSource )
:m_pImpl(new ODADescriptorImpl(*_rSource.m_pImpl))
{
}
const ODataAccessDescriptor& ODataAccessDescriptor::operator=(const ODataAccessDescriptor& _rSource)
{
delete m_pImpl;
m_pImpl = new ODADescriptorImpl(*_rSource.m_pImpl);
return *this;
}
ODataAccessDescriptor::ODataAccessDescriptor( const Reference< XPropertySet >& _rValues )
:m_pImpl(new ODADescriptorImpl)
{
m_pImpl->buildFrom(_rValues);
}
ODataAccessDescriptor::ODataAccessDescriptor( const Any& _rValues )
:m_pImpl(new ODADescriptorImpl)
{
// check if we know the format in the Any
Sequence< PropertyValue > aValues;
Reference< XPropertySet > xValues;
if ( _rValues >>= aValues )
m_pImpl->buildFrom( aValues );
else if ( _rValues >>= xValues )
m_pImpl->buildFrom( xValues );
}
ODataAccessDescriptor::ODataAccessDescriptor( const Sequence< PropertyValue >& _rValues )
:m_pImpl(new ODADescriptorImpl)
{
m_pImpl->buildFrom(_rValues);
}
ODataAccessDescriptor::~ODataAccessDescriptor()
{
delete m_pImpl;
}
void ODataAccessDescriptor::clear()
{
m_pImpl->m_aValues.clear();
}
void ODataAccessDescriptor::erase(DataAccessDescriptorProperty _eWhich)
{
OSL_ENSURE(has(_eWhich), "ODataAccessDescriptor::erase: invalid call!");
if (has(_eWhich))
m_pImpl->m_aValues.erase(_eWhich);
}
bool ODataAccessDescriptor::has(DataAccessDescriptorProperty _eWhich) const
{
return m_pImpl->m_aValues.find(_eWhich) != m_pImpl->m_aValues.end();
}
const Any& ODataAccessDescriptor::operator [] ( DataAccessDescriptorProperty _eWhich ) const
{
if (!has(_eWhich))
{
OSL_FAIL("ODataAccessDescriptor::operator[]: invalid acessor!");
static const Any aDummy;
return aDummy;
}
return m_pImpl->m_aValues[_eWhich];
}
Any& ODataAccessDescriptor::operator[] ( DataAccessDescriptorProperty _eWhich )
{
m_pImpl->invalidateExternRepresentations();
return m_pImpl->m_aValues[_eWhich];
}
void ODataAccessDescriptor::initializeFrom(const Sequence< PropertyValue >& _rValues, bool _bClear)
{
if (_bClear)
clear();
m_pImpl->buildFrom(_rValues);
}
Sequence< PropertyValue > ODataAccessDescriptor::createPropertyValueSequence()
{
m_pImpl->updateSequence();
return m_pImpl->m_aAsSequence;
}
OUString ODataAccessDescriptor::getDataSource() const
{
OUString sDataSourceName;
if ( has(daDataSource) )
(*this)[daDataSource] >>= sDataSourceName;
else if ( has(daDatabaseLocation) )
(*this)[daDatabaseLocation] >>= sDataSourceName;
return sDataSourceName;
}
void ODataAccessDescriptor::setDataSource(const OUString& _sDataSourceNameOrLocation)
{
if ( !_sDataSourceNameOrLocation.isEmpty() )
{
INetURLObject aURL(_sDataSourceNameOrLocation);
(*this)[ (( aURL.GetProtocol() == INetProtocol::File ) ? daDatabaseLocation : daDataSource)] <<= _sDataSourceNameOrLocation;
}
else
(*this)[ daDataSource ] <<= OUString();
}
} // namespace svx
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */