Files
loongoffice/chart2/source/model/template/DataInterpreter.cxx
Aritz Erkiaga c8598f28db tdf#138556 Don’t add Open Values to stock chart types 1 and 3
A new function was defined, XdataInterpreter::getChartTypeSpecificData.
Being 100% chart-type-agnostic when retrieving chart data is impossible;
candlestick charts can have different numbers of sequences per series,
and this information is not present in any other chart type.

Change-Id: I0f54b09202c42667331b083d54d90e4ceee81083
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113075
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2021-05-21 09:55:36 +02:00

448 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 "DataInterpreter.hxx"
#include <DataSeries.hxx>
#include <DataSourceHelper.hxx>
#include <DataSeriesHelper.hxx>
#include <CommonConverters.hxx>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/chart2/data/XDataSink.hpp>
#include <cppuhelper/supportsservice.hxx>
#include <tools/diagnose_ex.h>
#include <vector>
#include <algorithm>
using namespace ::com::sun::star;
using namespace ::com::sun::star::chart2;
using namespace ::std;
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::Sequence;
#ifdef DEBUG_CHART2_TEMPLATE
namespace
{
void lcl_ShowDataSource( const Reference< data::XDataSource > & xSource );
}
#endif
namespace chart
{
DataInterpreter::DataInterpreter()
{}
DataInterpreter::~DataInterpreter()
{}
// ____ XDataInterpreter ____
InterpretedData SAL_CALL DataInterpreter::interpretDataSource(
const Reference< data::XDataSource >& xSource,
const Sequence< beans::PropertyValue >& aArguments,
const Sequence< Reference< XDataSeries > >& aSeriesToReUse )
{
if( ! xSource.is())
return InterpretedData();
#ifdef DEBUG_CHART2_TEMPLATE
lcl_ShowDataSource( xSource );
#endif
const Sequence< Reference< data::XLabeledDataSequence > > aData( xSource->getDataSequences() );
Reference< data::XLabeledDataSequence > xCategories;
vector< Reference< data::XLabeledDataSequence > > aSequencesVec;
// check if we should use categories
bool bHasCategories( HasCategories( aArguments, aData ));
// parse data
bool bCategoriesUsed = false;
for( Reference< data::XLabeledDataSequence > const & labeledData : aData )
{
try
{
if( bHasCategories && ! bCategoriesUsed )
{
xCategories.set( labeledData );
if( xCategories.is())
SetRole( xCategories->getValues(), "categories");
bCategoriesUsed = true;
}
else
{
aSequencesVec.push_back( labeledData );
if( labeledData.is())
SetRole( labeledData->getValues(), "values-y");
}
}
catch( const uno::Exception & )
{
DBG_UNHANDLED_EXCEPTION("chart2");
}
}
// create DataSeries
sal_Int32 nSeriesIndex = 0;
vector< Reference< XDataSeries > > aSeriesVec;
aSeriesVec.reserve( aSequencesVec.size());
for (auto const& elem : aSequencesVec)
{
Sequence< Reference< data::XLabeledDataSequence > > aNewData( &elem, 1 );
Reference< XDataSeries > xSeries;
if( nSeriesIndex < aSeriesToReUse.getLength())
xSeries.set( aSeriesToReUse[nSeriesIndex] );
else
xSeries.set( new DataSeries );
OSL_ASSERT( xSeries.is() );
Reference< data::XDataSink > xSink( xSeries, uno::UNO_QUERY );
OSL_ASSERT( xSink.is() );
xSink->setData( aNewData );
aSeriesVec.push_back( xSeries );
++nSeriesIndex;
}
Sequence< Sequence< Reference< XDataSeries > > > aSeries(1);
aSeries[0] = comphelper::containerToSequence( aSeriesVec );
return InterpretedData( aSeries, xCategories );
}
InterpretedData SAL_CALL DataInterpreter::reinterpretDataSeries(
const InterpretedData& aInterpretedData )
{
InterpretedData aResult( aInterpretedData );
sal_Int32 i=0;
Sequence< Reference< XDataSeries > > aSeries( FlattenSequence( aInterpretedData.Series ));
const sal_Int32 nCount = aSeries.getLength();
for( ; i<nCount; ++i )
{
try
{
Reference< data::XDataSource > xSeriesSource( aSeries[i], uno::UNO_QUERY_THROW );
Sequence< Reference< data::XLabeledDataSequence > > aNewSequences;
// values-y
Reference< data::XLabeledDataSequence > xValuesY(
DataSeriesHelper::getDataSequenceByRole( xSeriesSource, "values-y" ));
// re-use values-... as values-y
if( ! xValuesY.is())
{
xValuesY.set(
DataSeriesHelper::getDataSequenceByRole( xSeriesSource, "values", true ));
if( xValuesY.is())
SetRole( xValuesY->getValues(), "values-y");
}
if( xValuesY.is())
{
aNewSequences.realloc(1);
aNewSequences[0] = xValuesY;
}
Sequence< Reference< data::XLabeledDataSequence > > aSeqs( xSeriesSource->getDataSequences());
if( aSeqs.getLength() != aNewSequences.getLength() )
{
#ifdef DEBUG_CHART2_TEMPLATE
sal_Int32 j=0;
for( ; j<aSeqs.(); ++j )
{
assert( aSeqs[j] == xValuesY && "All sequences should be used" );
}
#endif
Reference< data::XDataSink > xSink( xSeriesSource, uno::UNO_QUERY_THROW );
xSink->setData( aNewSequences );
}
}
catch( const uno::Exception & )
{
DBG_UNHANDLED_EXCEPTION("chart2");
}
}
return aResult;
}
// criterion: all series must have exactly one data::XLabeledDataSequence
sal_Bool SAL_CALL DataInterpreter::isDataCompatible(
const chart2::InterpretedData& aInterpretedData )
{
const Sequence< Reference< XDataSeries > > aSeries( FlattenSequence( aInterpretedData.Series ));
for( Reference< XDataSeries > const & i : aSeries )
{
try
{
Reference< data::XDataSource > xSrc( i, uno::UNO_QUERY_THROW );
Sequence< Reference< data::XLabeledDataSequence > > aSeq( xSrc->getDataSequences());
if( aSeq.getLength() != 1 )
return false;
}
catch( const uno::Exception & )
{
DBG_UNHANDLED_EXCEPTION("chart2");
}
}
return true;
}
namespace
{
struct lcl_LabeledSequenceEquals
{
explicit lcl_LabeledSequenceEquals( const Reference< data::XLabeledDataSequence > & xLSeqToCmp ) :
m_bHasLabels ( false ),
m_bHasValues ( false )
{
if( !xLSeqToCmp.is())
return;
Reference< data::XDataSequence > xSeq( xLSeqToCmp->getValues());
if( xSeq.is())
{
m_bHasValues = true;
m_aValuesRangeRep = xSeq->getSourceRangeRepresentation();
}
xSeq.set( xLSeqToCmp->getLabel());
if( xSeq.is())
{
m_bHasLabels = true;
m_aLabelRangeRep = xSeq->getSourceRangeRepresentation();
}
}
bool operator() ( const Reference< data::XLabeledDataSequence > & xSeq )
{
if( ! xSeq.is())
return false;
Reference< data::XDataSequence > xSeqValues( xSeq->getValues() );
Reference< data::XDataSequence > xSeqLabels( xSeq->getLabel() );
bool bHasValues = xSeqValues.is();
bool bHasLabels = xSeqLabels.is();
return ( ( (m_bHasValues == bHasValues) &&
(!bHasValues || m_aValuesRangeRep == xSeqValues->getSourceRangeRepresentation()) ) &&
( (m_bHasLabels == bHasLabels) &&
(!bHasLabels || m_aLabelRangeRep == xSeqLabels->getSourceRangeRepresentation()) )
);
}
private:
bool m_bHasLabels;
bool m_bHasValues;
OUString m_aValuesRangeRep;
OUString m_aLabelRangeRep;
};
} // anonymous namespace
Reference< data::XDataSource > SAL_CALL DataInterpreter::mergeInterpretedData(
const InterpretedData& aInterpretedData )
{
vector< Reference< data::XLabeledDataSequence > > aResultVec;
aResultVec.reserve( aInterpretedData.Series.getLength() +
1 // categories
);
if( aInterpretedData.Categories.is())
aResultVec.push_back( aInterpretedData.Categories );
const Sequence< Reference< XDataSeries > > aSeries( FlattenSequence( aInterpretedData.Series ));
for( Reference< XDataSeries > const & dataSeries : aSeries )
{
try
{
Reference< data::XDataSource > xSrc( dataSeries, uno::UNO_QUERY_THROW );
const Sequence< Reference< data::XLabeledDataSequence > > aSeq( xSrc->getDataSequences());
// add all sequences of data series
for( Reference< data::XLabeledDataSequence > const & xAdd : aSeq )
{
// only add if sequence is not yet in the result
if( none_of( aResultVec.begin(), aResultVec.end(),
lcl_LabeledSequenceEquals( xAdd )) )
{
aResultVec.push_back( xAdd );
}
}
}
catch( const uno::Exception & )
{
DBG_UNHANDLED_EXCEPTION("chart2");
}
}
return DataSourceHelper::createDataSource( comphelper::containerToSequence( aResultVec ) );
}
uno::Any SAL_CALL DataInterpreter::getChartTypeSpecificData(
const OUString & )
{
return uno::Any();
}
// convenience methods
OUString DataInterpreter::GetRole( const Reference< data::XDataSequence > & xSeq )
{
OUString aResult;
if( ! xSeq.is())
return aResult;
try
{
Reference< beans::XPropertySet > xProp( xSeq, uno::UNO_QUERY_THROW );
xProp->getPropertyValue( "Role") >>= aResult;
}
catch( const uno::Exception & )
{
DBG_UNHANDLED_EXCEPTION("chart2");
}
return aResult;
}
void DataInterpreter::SetRole( const Reference< data::XDataSequence > & xSeq, const OUString & rRole )
{
if( ! xSeq.is())
return;
try
{
Reference< beans::XPropertySet > xProp( xSeq, uno::UNO_QUERY_THROW );
xProp->setPropertyValue( "Role", uno::Any( rRole ));
}
catch( const uno::Exception & )
{
DBG_UNHANDLED_EXCEPTION("chart2");
}
}
uno::Any DataInterpreter::GetProperty(
const Sequence< beans::PropertyValue > & aArguments,
std::u16string_view rName )
{
for( sal_Int32 i=aArguments.getLength(); i--; )
{
if( aArguments[i].Name == rName )
return aArguments[i].Value;
}
return uno::Any();
}
bool DataInterpreter::HasCategories(
const Sequence< beans::PropertyValue > & rArguments,
const Sequence< Reference< data::XLabeledDataSequence > > & rData )
{
bool bHasCategories = false;
if( rArguments.hasElements() )
GetProperty( rArguments, u"HasCategories" ) >>= bHasCategories;
for( sal_Int32 nLSeqIdx=0; ! bHasCategories && nLSeqIdx<rData.getLength(); ++nLSeqIdx )
bHasCategories = ( rData[nLSeqIdx].is() && GetRole( rData[nLSeqIdx]->getValues() ) == "categories");
return bHasCategories;
}
bool DataInterpreter::UseCategoriesAsX( const Sequence< beans::PropertyValue > & rArguments )
{
bool bUseCategoriesAsX = true;
if( rArguments.hasElements() )
GetProperty( rArguments, u"UseCategoriesAsX" ) >>= bUseCategoriesAsX;
return bUseCategoriesAsX;
}
OUString SAL_CALL DataInterpreter::getImplementationName()
{
return "com.sun.star.comp.chart2.DataInterpreter";
}
sal_Bool SAL_CALL DataInterpreter::supportsService( const OUString& rServiceName )
{
return cppu::supportsService(this, rServiceName);
}
css::uno::Sequence< OUString > SAL_CALL DataInterpreter::getSupportedServiceNames()
{
return { "com.sun.star.chart2.DataInterpreter" };
}
} // namespace chart
#ifdef DEBUG_CHART2_TEMPLATE
namespace
{
void lcl_ShowDataSource( const Reference< data::XDataSource > & xSource )
{
if( ! xSource.is())
return;
SAL_INFO("chart2", "DataSource in DataInterpreter:" );
Sequence< Reference< data::XLabeledDataSequence > > aSequences( xSource->getDataSequences());
Reference< beans::XPropertySet > xProp;
OUString aId;
const sal_Int32 nMax = aSequences.getLength();
for( sal_Int32 k = 0; k < nMax; ++k )
{
if( aSequences[k].is())
{
OUString aSourceRepr("<none>");
if( aSequences[k]->getValues().is())
aSourceRepr = aSequences[k]->getValues()->getSourceRangeRepresentation();
xProp.set( aSequences[k]->getValues(), uno::UNO_QUERY );
if( xProp.is() &&
( xProp->getPropertyValue( "Role") >>= aId ))
{
SAL_INFO("chart2", " <data sequence " << k << "> Role: " << aId << ", Source: "<< aSourceRepr);
}
else
{
SAL_INFO("chart2", " <data sequence " << k << "> unknown Role, Source: " << aSourceRepr );
}
aSourceRepr = "<none>";
if( aSequences[k]->getLabel().is())
aSourceRepr = aSequences[k]->getLabel()->getSourceRangeRepresentation();
xProp.set( aSequences[k]->getLabel(), uno::UNO_QUERY );
if( xProp.is() &&
( xProp->getPropertyValue( "Role") >>= aId ))
{
SAL_INFO("chart2", " <data sequence label " << k << "> Role: " << aId
<< ", Source: " << aSourceRepr );
}
else
{
SAL_INFO("chart2", " <data sequence label " << k << "> unknown Role, Source: " << aSourceRepr );
}
}
}
}
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */