---

IDataMerger.h

Go to the documentation of this file.

/**
* @file         IDataMerger.h
* @brief    Data-merge interface
*
* @author       Nakashima h
* @date     2021-10-06
*
* $Id: IDataMerger.h 32 2022-07-14 03:20:43Z shingo.yoneda $
*
* Copyright (c) 2020-2022 Antenna House, Inc. All rights reserved.
*/

#pragma once
#include <queue>
#include <memory>

#include "SimpleTypeParameter.h"
#include "CompoundTypeParameter.h"
#include "NestedTableTypeParameter.h"

/**
* @brief    Data-merge interface
*/
class IDataMerger {
protected:
    /**
    * @brief    Default constructor
    */
    IDataMerger() = default;

    /**
    * @brief    Copy constructor
    */
    IDataMerger(const IDataMerger&) = delete;
    /**
    * @brief    Copy assignment operator
    */
    IDataMerger& operator=(const IDataMerger&) = delete;

    /**
    * @brief    Move constructor
    */
    IDataMerger(IDataMerger&&) = delete;
    /**
    * @brief    Move assignment operator
    */
    IDataMerger& operator=(IDataMerger&&) = delete;

public:

    /**
    * @brief    Destructor
    */
    virtual ~IDataMerger() = default;

    /**
    * @brief    Get a list of data-merge field names
    * @param    input_param - Input parameter
    * @return List of data-merge field names
    */
    virtual std::vector<std::string> getDataMergeFields(InputParam const& input_param) = 0;

    /**
    * @brief    Generate the object that executes the simple type data-merge
    * @param    simple_type_parameter - Parameter to use for the simple type data-merge
    * @return Object that executes the simple type data-merge
    */
    static std::unique_ptr<IDataMerger> create(SimpleTypeParameter simple_type_parameter);

    /**
    * @brief    Generate the object that executes the compound type data-merge
    * @param    compound_type_parameter - Parameter to use for the compound type data-merge
    * @return Object that executes the compound type data-merge
    */
    static std::unique_ptr<IDataMerger> create(CompoundTypeParameter compound_type_parameter);

    /**
    * @brief    Generate an object to perform data-merge of a nested table type
    * @param    nested_table_type_parameter - Parameters used for data-merge of nested table type
    * @return Object to perform data-merge of a nested table type
    */
    static std::unique_ptr<IDataMerger> create(NestedTableTypeParameter nested_table_type_parameter);

    /**
    * @brief    Execute the data-merge to the template
    * @param    input_param - Input parameter
    * @param    output_param - Output parameter
    */
    virtual void execute(InputParam const& input_param, OutputParam const& output_param) = 0;
};

---