import_interface_pivot.hpp

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * 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/.
 */
 
#ifndef INCLUDED_ORCUS_SPREADSHEET_IMPORT_INTERFACE_PIVOT_HPP
#define INCLUDED_ORCUS_SPREADSHEET_IMPORT_INTERFACE_PIVOT_HPP
 
#include <cstdlib>
 
#include "types.hpp"
#include "../types.hpp"
#include "../env.hpp"
 
// NB: This header must not depend on ixion, as it needs to be usable for
// those clients that provide their own formula engine.  Other headers in
// the orcus::spreadsheet namespace may depend on ixion.
 
namespace orcus { namespace spreadsheet { namespace iface {
 
class import_pivot_cache_field_group;

class ORCUS_DLLPUBLIC import_pivot_cache_definition
{
public:
    virtual ~import_pivot_cache_definition();

    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_group* start_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;
};

class ORCUS_DLLPUBLIC import_pivot_cache_field_group
{
public:
    virtual ~import_pivot_cache_field_group();

    virtual void link_base_to_group_items(size_t group_item_index) = 0;

    virtual void set_field_item_string(std::string_view value) = 0;

    virtual void set_field_item_numeric(double v) = 0;

    virtual void commit_field_item() = 0;

    virtual void set_range_grouping_type(pivot_cache_group_by_t group_by) = 0;

    virtual void set_range_auto_start(bool b) = 0;

    virtual void set_range_auto_end(bool b) = 0;

    virtual void set_range_start_number(double v) = 0;

    virtual void set_range_end_number(double v) = 0;

    virtual void set_range_start_date(const date_time_t& dt) = 0;

    virtual void set_range_end_date(const date_time_t& dt) = 0;

    virtual void set_range_interval(double v) = 0;

    virtual void commit() = 0;
};

class ORCUS_DLLPUBLIC import_pivot_cache_records
{
public:
    virtual ~import_pivot_cache_records();

    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;
};
 
}}}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */