orcus::spreadsheet::iface::import_pivot_cache_definition Class Reference

#include <import_interface_pivot.hpp>

Public Member Functions
virtual void	set_worksheet_source (const char *ref, size_t n_ref, const char *sheet_name, size_t n_sheet_name)=0
virtual void	set_field_count (size_t n)=0
virtual void	set_field_name (const char *p, size_t n)=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_group *	create_field_group (size_t base_index)=0
virtual void	commit_field ()=0
virtual void	set_field_item_string (const char *p, size_t n)=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 definition.

Member Function Documentation

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

pure virtual

Commit the current pivot cache model to the document model.

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.

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.

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

pure virtual

Mark the current field as a group field.

This method gets called first to signify that the current field is a group field.

Parameters

base_index

0-based index of the field this field is the parent group of.

Returns

interface for importing group field data.

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

n	total number of fields in this pivot cache.

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

dt	date-time value.

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

ev	error value.

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

v	numeric value.

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_item_string ( const char *  p, size_t  n  )

pure virtual

Set a string value to the current field item buffer.

Parameters

p	pointer to the char array that contains the string value.
n	size of the aforementioned char array.

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

dt	highest date value of the field.

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

v	highest value of the field.

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

dt	lowest date value of the field.

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

v	lowest value of the field.

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_field_name ( const char *  p, size_t  n  )

pure virtual

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

Parameters

p	pointer to the char array that contains the field name.
n	size of the aforementioned char array.

virtual void orcus::spreadsheet::iface::import_pivot_cache_definition::set_worksheet_source ( const char *  ref, size_t  n_ref, const char *  sheet_name, size_t  n_sheet_name  )

pure virtual

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

Parameters

ref	pointer to the char array that contains the range string specifying the source range.
n_ref	size of the aforementioned char array.
sheet_name	pointer to the char array that contains the name of the worksheet where the source data is located.
n_sheet_name	size of the aforementioned char array.