Orcus
Loading...
Searching...
No Matches
orcus::spreadsheet::iface::import_pivot_cache_definition Class Referenceabstract

#include <import_interface_pivot.hpp>

Public Member Functions

virtual void set_worksheet_source (std::string_view ref, std::string_view sheet_name)=0
virtual void set_worksheet_source (std::string_view table_name)=0
virtual void set_field_count (size_t n)=0
virtual void set_field_name (std::string_view name)=0
virtual void set_field_min_value (double v)=0
virtual void set_field_max_value (double v)=0
virtual void set_field_min_date (const date_time_t &dt)=0
virtual void set_field_max_date (const date_time_t &dt)=0
virtual import_pivot_cache_field_groupstart_field_group (size_t base_index)=0
virtual void commit_field ()=0
virtual void set_field_item_string (std::string_view value)=0
virtual void set_field_item_numeric (double v)=0
virtual void set_field_item_date_time (const date_time_t &dt)=0
virtual void set_field_item_error (error_value_t ev)=0
virtual void commit_field_item ()=0
virtual void commit ()=0

Detailed Description

Interface for importing pivot cache definitions.

Member Function Documentation

◆ commit()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::commit ( )
pure virtual

Commit the current pivot cache model to the document model.

◆ commit_field()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::commit_field ( )
pure virtual

Commit the field in the current field buffer to the pivot cache model.

◆ commit_field_item()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::commit_field_item ( )
pure virtual

Commit the field item in current field item buffer to the current field model.

◆ set_field_count()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_count ( size_t n)
pure virtual

Set the total number of fields present in this pivot cache.

Parameters
ntotal number of fields in this pivot cache.

◆ set_field_item_date_time()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_item_date_time ( const date_time_t & dt)
pure virtual

Set a date-time value to the current field item buffer.

Parameters
dtdate-time value.

◆ set_field_item_error()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_item_error ( error_value_t ev)
pure virtual

Set an error value to the current field item buffer,

Parameters
everror value.

◆ set_field_item_numeric()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_item_numeric ( double v)
pure virtual

Set a numeric value to the current field item buffer.

Parameters
vnumeric value.

◆ set_field_item_string()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_item_string ( std::string_view value)
pure virtual

Set a string value to the current field item buffer.

Parameters
valuestring value.

◆ set_field_max_date()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_max_date ( const date_time_t & dt)
pure virtual

Set the highest date value of the field in the current field buffer.

Parameters
dthighest date value of the field.

◆ set_field_max_value()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_max_value ( double v)
pure virtual

Set the highest value of the field in the current field buffer.

Parameters
vhighest value of the field.

◆ set_field_min_date()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_min_date ( const date_time_t & dt)
pure virtual

Set the lowest date value of the field in the current field buffer.

Parameters
dtlowest date value of the field.

◆ set_field_min_value()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_min_value ( double v)
pure virtual

Set the lowest value of the field in the current field buffer.

Parameters
vlowest value of the field.

◆ set_field_name()

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_name ( std::string_view name)
pure virtual

Set the name of the field in the current field buffer.

Parameters
namefield name.

◆ set_worksheet_source() [1/2]

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_worksheet_source ( std::string_view ref,
std::string_view sheet_name )
pure virtual

Specify that the source data of this pivot cache is located on a local worksheet.

Parameters
refrange string specifying the source range.
sheet_namename of the worksheet where the source data is located.
Todo
use the ref resolver to resolve the range.

◆ set_worksheet_source() [2/2]

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_worksheet_source ( std::string_view table_name)
pure virtual

Specify that the source data of this pivot cache is associated with a table.

Parameters
table_namename of the table.

◆ start_field_group()

virtual import_pivot_cache_field_group * orcus::spreadsheet::iface::import_pivot_cache_definition::start_field_group ( size_t base_index)
pure virtual

Mark the current field as a group field and initiate its import.

The implementor should create an internal storage to prepare for the importing of field group data when this method gets called.

Parameters
base_index0-based index of the field this group field uses as its base.
Returns
interface for importing group field data, or a nullptr if the implementor doesn't support it.