import_auto_filter_node

Defined in header: <orcus/spreadsheet/import_interface_auto_filter.hpp>

class import_auto_filter_node

Interface for importing a single node in a larger auto-filter structure.

Note that one auto-filter structure may consist of nested filter nodes.

Public Functions

virtual ~import_auto_filter_node()
virtual void append_item(col_t field, auto_filter_op_t op, double value) = 0

Append to this node a new filter item with a numeric value.

Parameters:
  • field – 0-based field index which is the offset from the left-most column of the filtered range.

  • op – Operator for the filter item.

  • value – Numeric value associated with the operator for the filter item. Note that some operators may not require a value.

virtual void append_item(col_t field, auto_filter_op_t op, std::string_view value, bool regex) = 0

Append to this node a new filter item with a string value.

Note that the the life cycle of the string value passed to this call is only guaranteed to persist during the call.

Parameters:
  • field – 0-based field index which is the offset from the left-most column of the filtered range.

  • op – Operator for the filter item.

  • value – String value associated with the operator for the filter item. Note that some operators may not require a value.

  • regex – Whether or not the string value should be interpreted as a regular expression.

virtual void append_item(col_t field, auto_filter_op_t op) = 0

Append to this node a new filter item with no associated value.

Parameters:
  • field – 0-based field index which is the offset from the left-most column of the filtered range.

  • op – Operator for the filter item.

virtual import_auto_filter_node *start_node(auto_filter_node_op_t op) = 0

Start a new node of filter rules as a filter item to this node. The new node should be appended to this node as new filter item when it is committed.

Note

Note that the import_auto_filter_node implementer must return a non-null pointer.

Parameters:

op – Operator to use to link the items stored in the new node.

Returns:

Interface for importing the filter rules for the new node.

virtual import_auto_filter_multi_values *start_multi_values(col_t field) = 0

Start importing a set of multiple filter values. Note that a set of multiple filter values and individual filter items cannot co-exist in the same filter node.

Note

Note that the import_auto_filter_node implementer must return a non-null pointer.

Returns:

Interface for importing a set of multiple filter values for the current filter node.

virtual void commit() = 0

Commit the filter node data stored in the buffer to the destination store.