office-gobmx/sc/inc/dpcache.hxx
Noel Grandin e189a3f5b5 make some classes module private
Mark some stuff SAL_DLLPUBLIC_RTTI in
    include/vcl/metaact.hxx
in order to make ASAN happy.

Change-Id: I97febe0968bf58b9cbe60ce647f0ada25e6f4bb0
Reviewed-on: https://gerrit.libreoffice.org/84202
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2019-12-05 07:01:44 +01:00

217 lines
6.9 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 .
*/
#ifndef INCLUDED_SC_INC_DPCACHE_HXX
#define INCLUDED_SC_INC_DPCACHE_HXX
#include "address.hxx"
#include "calcmacros.hxx"
#include "dpitemdata.hxx"
#include "dpnumgroupinfo.hxx"
#include "scdllapi.h"
#include "types.hxx"
#include <mdds/flat_segment_tree.hpp>
#include <memory>
#include <set>
#include <unordered_set>
#include <vector>
struct ScQueryParam;
class ScDPObject;
class ScDocument;
class SvNumberFormatter;
enum class SvNumFormatType : sal_Int16;
/**
* This class represents the cached data part of the datapilot cache table
* implementation.
*/
class SC_DLLPUBLIC ScDPCache
{
public:
typedef std::unordered_set<OUString> StringSetType;
typedef mdds::flat_segment_tree<SCROW, bool> EmptyRowsType;
typedef std::vector<ScDPItemData> ScDPItemDataVec;
typedef std::set<ScDPObject*> ScDPObjectSet;
typedef std::vector<SCROW> IndexArrayType;
struct SAL_DLLPRIVATE GroupItems
{
ScDPItemDataVec maItems;
ScDPNumGroupInfo maInfo;
sal_Int32 mnGroupType;
GroupItems();
GroupItems(const GroupItems&) = delete;
const GroupItems& operator=(const GroupItems&) = delete;
GroupItems(const ScDPNumGroupInfo& rInfo, sal_Int32 nGroupType);
};
struct SAL_DLLPRIVATE Field
{
/**
* Optional items for grouped field.
*/
std::unique_ptr<GroupItems> mpGroup;
/**
* Unique values in the field, stored in ascending order.
*/
ScDPItemDataVec maItems;
/**
* Original source data represented as indices to the unique value
* list. The order of the data is as they appear in the original
* data source.
*/
IndexArrayType maData;
sal_uInt32 mnNumFormat;
Field();
Field(const Field&) = delete;
const Field& operator=(const Field&) = delete;
};
/**
* Interface for connecting to database source. Column index is 0-based.
*/
class DBConnector
{
public:
virtual long getColumnCount() const = 0;
virtual OUString getColumnLabel(long nCol) const = 0;
virtual bool first() = 0;
virtual bool next() = 0;
virtual void finish() = 0;
virtual void getValue(long nCol, ScDPItemData& rData, SvNumFormatType& rNumType) const = 0;
virtual ~DBConnector() {}
};
private:
ScDocument* mpDoc;
SCCOL mnColumnCount;
/**
* All pivot table objects that references this cache.
*/
mutable ScDPObjectSet maRefObjects;
typedef std::vector< std::unique_ptr<Field> > FieldsType;
typedef std::vector< std::unique_ptr<GroupItems> > GroupFieldsType;
FieldsType maFields;
GroupFieldsType maGroupFields;
std::vector<StringSetType> maStringPools; // one for each field.
std::vector<OUString> maLabelNames; // Stores dimension names and the data layout dimension name at position 0.
EmptyRowsType maEmptyRows;
SCROW mnDataSize;
SCROW mnRowCount;
bool mbDisposing;
public:
rtl_uString* InternString( size_t nDim, const OUString& rStr );
void AddReference(ScDPObject* pObj) const;
void RemoveReference(ScDPObject* pObj) const;
const ScDPObjectSet& GetAllReferences() const;
SCROW GetIdByItemData(long nDim, const ScDPItemData& rItem) const;
static sal_uInt32 GetLocaleIndependentFormat( SvNumberFormatter& rFormatter, sal_uInt32 nNumFormat );
static OUString GetLocaleIndependentFormattedNumberString( double fValue );
static OUString GetLocaleIndependentFormattedString( double fValue, SvNumberFormatter& rFormatter, sal_uInt32 nNumFormat );
OUString GetFormattedString(long nDim, const ScDPItemData& rItem, bool bLocaleIndependent) const;
SvNumberFormatter* GetNumberFormatter() const;
long AppendGroupField();
void ResetGroupItems(long nDim, const ScDPNumGroupInfo& rNumInfo, sal_Int32 nGroupType);
SCROW SetGroupItem(long nDim, const ScDPItemData& rData);
void GetGroupDimMemberIds(long nDim, std::vector<SCROW>& rIds) const;
void ClearGroupFields();
void ClearAllFields();
const ScDPNumGroupInfo* GetNumGroupInfo(long nDim) const;
/**
* Return a group type identifier. The values correspond with
* css::sheet::DataPilotFieldGroupBy constant values.
*
* @param nDim 0-based dimension index.
*
* @return group type identifier, or 0 on failure.
*/
sal_Int32 GetGroupType(long nDim) const;
SCCOL GetDimensionIndex(const OUString& sName) const;
sal_uInt32 GetNumberFormat( long nDim ) const;
bool IsDateDimension( long nDim ) const ;
long GetDimMemberCount(long nDim) const;
const IndexArrayType* GetFieldIndexArray( size_t nDim ) const;
const ScDPItemDataVec& GetDimMemberValues( SCCOL nDim ) const;
void InitFromDoc(ScDocument* pDoc, const ScRange& rRange);
bool InitFromDataBase(DBConnector& rDB);
/**
* Row count is the number of records plus any trailing empty rows in case
* the source data is sheet and contains trailing empty rows.
*/
SCROW GetRowCount() const;
/**
* Data size is the number of records without any trailing empty rows for
* sheet source data. For any other source type, this should equal the
* row count.
*/
SCROW GetDataSize() const;
SCROW GetItemDataId( sal_uInt16 nDim, SCROW nRow, bool bRepeatIfEmpty ) const;
OUString GetDimensionName(std::vector<OUString>::size_type nDim) const;
bool IsRowEmpty(SCROW nRow) const;
bool ValidQuery(SCROW nRow, const ScQueryParam& rQueryParam) const;
ScDocument* GetDoc() const;
long GetColumnCount() const;
const ScDPItemData* GetItemDataById( long nDim, SCROW nId ) const;
size_t GetFieldCount() const;
size_t GetGroupFieldCount() const;
ScDPCache(const ScDPCache&) = delete;
const ScDPCache& operator=(const ScDPCache&) = delete;
ScDPCache(ScDocument* pDoc);
~ScDPCache();
#if DUMP_PIVOT_TABLE
void Dump() const;
#endif
private:
void PostInit();
void Clear();
const GroupItems* GetGroupItems(long nDim) const;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */