Orcus
Loading...
Searching...
No Matches
Public Member Functions | List of all members
orcus::spreadsheet::iface::import_pivot_cache_records Class Referenceabstract

#include <import_interface_pivot.hpp>

Public Member Functions

virtual void set_record_count (size_t n)=0
 
virtual void append_record_value_numeric (double v)=0
 
virtual void append_record_value_character (std::string_view s)=0
 
virtual void append_record_value_shared_item (size_t index)=0
 
virtual void commit_record ()=0
 
virtual void commit ()=0
 

Detailed Description

Interface for importing pivot cache records.

Member Function Documentation

◆ append_record_value_character()

virtual void orcus::spreadsheet::iface::import_pivot_cache_records::append_record_value_character ( std::string_view s)
pure virtual

Append to the current record buffer a character value as a column value.

Parameters
scharacter value to append to the current record buffer as a column value.

◆ append_record_value_numeric()

virtual void orcus::spreadsheet::iface::import_pivot_cache_records::append_record_value_numeric ( double v)
pure virtual

Append to the current record buffer a numeric value as a column value.

Parameters
vnumeric value to append to the current record buffer as a column value.

◆ append_record_value_shared_item()

virtual void orcus::spreadsheet::iface::import_pivot_cache_records::append_record_value_shared_item ( size_t index)
pure virtual

Append to the current record buffer a column value referenced by an index into the shared items table of a pivot cache field. The corresponding field in the pivot cache definition should provide the shared items table that this index references.

Parameters
indexindex into the shared items table of a pivot cache field.

◆ commit()

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

Commit the entire records set to the document store.

◆ commit_record()

virtual void orcus::spreadsheet::iface::import_pivot_cache_records::commit_record ( )
pure virtual

Commit the record in the current record buffer.

The implementor can clear the buffer afterward.

◆ set_record_count()

virtual void orcus::spreadsheet::iface::import_pivot_cache_records::set_record_count ( size_t n)
pure virtual

Set the number of records included in pivot cache records.

Note
This method gets called before the very first record gets imported. The implementor can use this call as an opportunity to initialize any internal buffers used to store the imported records.
Parameters
nnumber of records included in pivot cache records.