Mapper.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  Mapper.qm Copyright 2014 - 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
// minimum required Qore version
 
// require type definitions everywhere
 
// enable all warnings
 
// do not use "$" for vars
 
// common definitions
 
// supports using the DataProvider module to describe input and output records
 
 
namespace Mapper {
public hashdecl MapperOptionInfo {
    string type;
 
    string desc;
};
 
class Mapper : public DataProvider::AbstractDataProcessor {
 
public:
        const ConstantConflictList = ("name", "struct", "code", "default");
 
        const OptionKeys = ...;
 
 
        const UserOptions = {
            "allow_dot": <MapperOptionInfo>{
                "type": "bool",
                "desc": "a flag to allow dots in input field names instead of interpreting them as field structure "
                    "separators",
            },
 
            "allow_output_dot": <MapperOptionInfo>{
                "type": "bool",
                "desc": "a flag to allow dots in input field names instead of interpreting them as field structure "
                    "separators",
            },
 
            "disable_bulk": <MapperOptionInfo>{
                "type": "bool",
                "desc": "a flag to disable bulk operations when there is a hash of lists as input when calling "
                    "mapAuto",
            },
 
            "global_type_options": <MapperOptionInfo>{
                "type": "type-option-hash",
                "desc": "a hash of global type options to be used by applicable fields if they do not override the "
                    "option",
            },
 
            "ignore_missing_input": <MapperOptionInfo>{
                "type": "bool",
                "desc": "if true and if an output field has an input mapping but the input hash has no such value, "
                    "and the output field does not require a value, in this case, the output field is omitted "
                    "entirely; this option is useful when the mapper output is used for delta updates with variable "
                    "input, for example; this option cannot be used with bulk input",
            },
 
            "input_provider_search": <MapperOptionInfo>{
                "type": "hash",
                "desc": "the input provider search criteria",
            },
 
            "input_request": <MapperOptionInfo>{
                "type": "any",
                "desc": "the arguments for input providers using the request/response API",
            },
 
            "input_request_options": <MapperOptionInfo>{
                "type": "hash",
                "desc": "any options to input providers using the request/response API",
            },
 
            "input_response_error": <MapperOptionInfo>{
                "type": "string",
                "desc": "a string indicating the input providers using the request/response API should "
                "use the given error response message for the record format",
            },
 
            "input_search_options": <MapperOptionInfo>{
                "type": "hash",
                "desc": "the input provider search options",
            },
 
            "input_suppress_data_provider": <MapperOptionInfo>{
                "type": "bool",
                "desc": "use any input data provider for type information only",
            },
 
            "mapper_handler_context": <MapperOptionInfo>{
                "type": "hash",
                "desc": "a hash that will be passed to any field handlers as the context argument",
            },
 
            "output_create_ignore_duplicates": <MapperOptionInfo>{
                "type": "bool",
                "desc": "a flag that indicates that duplicate records should be ignored when creating records with "
                    "an output data provider",
            },
 
            "output_nullable": <MapperOptionInfo>{
                "type": "bool",
                "desc": "set output fields as nullable",
            },
 
            "output_provider_bulk": <MapperOptionInfo>{
                "type": "bool",
                "desc": "a flag to enable bulk operations with an output provider; this option only has an "
                    "effect when used with an output provider that supports bulk operations on output",
            },
 
            "output_provider_passive": <MapperOptionInfo>{
                "type": "bool",
                "desc": "a flag to disable writing to the output provider while mapping; if this flag is set, the "
                    "output provider will only be used to set the output record type; this option only has an effect "
                    "when used with an output provider",
            },
 
            "output_provider_upsert": <MapperOptionInfo>{
                "type": "bool",
                "desc": "a flag to enable upserting instead of creating records with an output "
                "data provider; this option only has an effect when used with an output provider",
            },
 
            "output_request_options": <MapperOptionInfo>{
                "type": "hash",
                "desc": "any options to output providers using the request/response API",
            },
 
            "output_suppress_data_provider": <MapperOptionInfo>{
                "type": "bool",
                "desc": "use any output data provider for type information only",
            },
 
            "runtime": <MapperOptionInfo>{
                "type": "hash",
                "desc": "defines key-value pairs lookups for the \"runtime\" field mapping key",
            },
 
            "submappers": <MapperOptionInfo>{
                "type": "hash",
                "desc": "each hash key is the name of a global submapper and must have a hash value giving the "
                    "options for submapper as a value; requires the \"submapper_get\" option as well",
            },
        };
 
        const ValidKeys = ...;
 
 
        const OutputKeys = {
            "desc": True,
            "mand": True,
            "maxlen": True,
            "type": True,
        };
 
        static Type recordType("hash<string, AbstractDataField>");
 
protected:
 
        hash mapc;
 
        hash<auto> mapd;
 
        hash<auto> mapo;
 
        *string name;
 
        *code info_log;
 
        *code input_log;
 
        *code output_log;
 
        *code submapper_get;
 
        *code template_subst;
 
        hash<auto> global_transform_opts = {} + {
            "date.input_timezone": TimeZone::get(),
        };
 
        bool trunc_all = False;
 
 
        bool allow_dot = False;
 
 
        bool allow_output_dot = False;
 
        *hash<string, AbstractDataField> input;
 
        *AbstractDataProvider input_provider;
 
        *hash<auto> input_provider_search;
 
        *hash<auto> input_search_options;
 
        bool input_do_request;
 
        auto input_request;
 
        *hash<auto> input_request_options;
 
        bool input_request_search;
 
        bool ignore_missing_input;
 
        bool disable_bulk;
 
        *hash<string, AbstractDataField> output;
 
        *AbstractDataProvider output_provider;
 
        *AbstractDataProviderBulkOperation output_provider_bulk_operation;
 
        bool output_provider_passive;
 
        bool output_provider_upsert;
 
        bool output_do_request;
 
        *hash<auto> output_request_options;
 
        bool output_nullable = False;
 
        bool structured_input;
 
        bool structured_output;
 
        bool output_create_ignore_duplicates;
 
        int count = 0;
 
 
        *hash<auto> m_runtime;
 
        hash<auto> identh;
 
        *list<auto> identl;
 
        hash<auto> consth;
 
        hash<auto> rconsth;
 
        hash<string, hash<MapperRuntimeKeyInfo>> runtime_keys;
 
        hash<string, hash<auto>> runtime_keys_with_handler;
 
        hash<string, hash<MapperRuntimeKeyInfo>> runtime_independent_keys;
 
        hash<string, bool> valid_keys;
 
        hash<auto> mapper_handler_context = {};
 
        *hash<auto> mapper_thread_context;
 
        *hash<auto> global_submappers;
 
        bool input_suppress_data_provider;
 
        bool output_suppress_data_provider;
 
        const TypeMap = {
            "hash": "hash<auto>",
            "*hash": "*hash<auto>",
            "list": "list<auto>",
            "*list": "*list<auto>",
            "softlist": "softlist<auto>",
            "*softlist": "*softlist<auto>",
        };
 
        const DeprecatedGlobalTransformOptionMap = {
            "encoding": "string.encoding",
            "empty_strings_to_nothing": "string.empty_to_nothing",
            "date_format": "date.format",
            "timezone": "date.output_timezone",
            "input_timezone": "date.input_timezone",
            "number_format": "number.format",
        };
 
        const _Mapper_Thread_Key = "_Mapper_Thread_Key";
 
public:
 
 
    constructor(hash<auto> mapv, *hash<auto> opts);
 
 
protected:
     constructor();
public:
 
 
      static hash<string, AbstractDataField> getInputFromHash(hash<auto> input);
 
      static hash<string, AbstractDataField> getOutputFromHash(hash<auto> output, *hash<auto> mapv, *hash<auto> global_options);
 
 
protected:
     submitImpl(code enqueue, auto _data);
public:
 
 
 
protected:
     bool supportsBulkApiImpl();
public:
 
 
protected:
     *AbstractDataProviderType getExpectedTypeImpl();
public:
 
 
protected:
     *AbstractDataProviderType getReturnTypeImpl();
public:
 
 
protected:
     AbstractDataProviderType getOutputType(hash<auto> hdesc, *hash<auto> mapdesc);
public:
 
 
protected:
      static AbstractDataProviderType getOutputType(hash<auto> hdesc, *hash<auto> mapdesc, *hash<auto> global_options, *bool has_default_value);
public:
 
 
    private static hash<string, AbstractDataField> getInputFromHashIntern(hash<auto> input,
            *reference<bool> structured_input) {
        HashDataType input_data();
        foreach hash<auto> h in (input.pairIterator());
 
        return input_data.getFields();
    }
 
    private static hash<string, AbstractDataField> getOutputFromHashIntern(hash<auto> output, *hash<auto> mapv,
            *hash<auto> global_options, *reference<bool> structured_output) {
        HashDataType output_data();
        foreach hash<auto> h in (output.pairIterator());
 
        return output_data.getFields();
    }
 
protected:
     checkInputOutputOption(hash<auto> opts, string var, *hash<auto> mapv);
public:
 
 
protected:
     setInputProvider(hash<auto> opts);
public:
 
 
private:
     *hash<string, AbstractDataField> getFields(string pfx, AbstractDataProviderType type);
public:
 
 
protected:
     setOutputProvider(hash<auto> opts);
public:
 
 
protected:
     setup(hash<auto> mapv, *hash<auto> opts);
public:
 
 
protected:
     checkMap();
public:
 
 
protected:
     convertToHash(int t, string k, reference<auto> fh);
public:
 
 
protected:
     processStructuredInputField(string k, string name, reference<list<string>> struct);
public:
 
 
protected:
     *AbstractDataField processStructuredOutputField(string k, reference<hash<auto>> fh);
public:
 
 
protected:
     checkInputField(string k, string name);
public:
 
 
      static list<string> splitDottedFields(string k);
 
 
protected:
     checkMapField(string k, reference<auto> fh);
public:
 
 
protected:
     checkTimezoneOption(string rn);
public:
 
 
 
    setRuntime(string key, auto value);
 
 
 
    setRuntime(hash<auto> runtime);
 
 
 
    replaceRuntime(*hash<auto> runtime);
 
 
 
    auto getRuntime(string key);
 
 
    string getFieldName(string fname);
 
 
 
    hash<string, bool> validKeys();
 
 
 
    hash<auto> optionKeys();
 
 
    hash<string, hash<MapperOptionInfo>> getUserOptions();
 
 
    *AbstractDataProvider getInputProvider();
 
 
    *AbstractDataProvider getOutputProvider();
 
 
    *hash<string, AbstractDataField> getInputRecord();
 
 
    *hash<string, AbstractDataField> getOutputRecord();
 
 
 
    setNullableOutput();
 
 
 
    MapperOutputRecordIterator getOutputIterator();
 
 
 
    commit();
 
 
 
    rollback();
 
 
 
    flushOutput();
 
 
 
    discardOutput();
 
 
 
    runAutonomous();
 
 
 
    *softlist<hash<auto>> mapAutoInput();
 
 
 
private:
     AbstractDataProviderRecordIterator getInputProviderRecordIterator();
public:
 
 
 
    list<hash<auto>> mapAll(list<auto> recs);
 
 
 
    list<hash<auto>> mapAll(hash<auto> recs);
 
 
 
    list<hash<auto>> mapAll(AbstractIterator recs);
 
 
 
    hash<auto> mapData(hash<auto> rec);
 
 
 
    auto mapAuto(auto recs);
 
 
 
    *hash<auto> mapBulk(hash<auto> rec, *hash<auto> crec);
 
 
      static *hash<auto> getMapperThreadContext();
 
 
protected:
     hash<auto> mapDataIntern(hash<auto> rec, *bool do_log_output);
public:
 
 
protected:
     *hash<auto> doCreateRecordIntern(hash<auto> rec);
public:
 
 
protected:
      static *hash<auto> swapMapperThreadContext(*hash<auto> new_ctx);
public:
 
 
protected:
     *int getRecListSize(hash<auto> rec);
public:
 
 
 
protected:
     nothing mapFieldIntern(reference<hash<auto>> h, string key, hash<auto> rec, bool do_list, int list_size);
public:
 
 
    hash<auto> getOptionsFromTemplate(hash<auto> opts, hash<auto> input_rec, *hash<auto> output_rec);
 
 
    // recursively remove a key from the output
protected:
     removeHashOutputKey(reference<auto> output, list<auto> path, int offset);
public:
 
 
    // recursively write output hash
protected:
     writeHashOutput(reference<auto> output, auto value, list<auto> path, int offset);
public:
 
 
protected:
     string truncateField(string k, string val, int ix, int sze, int maxlen);
public:
 
 
protected:
     fieldLengthError(string k, string val, int ix, int sze, int maxlen, hash<auto> rc);
public:
 
 
    logOutput(hash<auto> h);
 
 
 
    int getCount();
 
 
 
    resetCount();
 
 
    private auto mapFieldType(string key, hash<auto> mapping, AbstractDataProviderType type, auto value,
            hash<auto> rec, auto v) {
        try {
            return type.acceptsValue(value);
        } catch (hash<ExceptionInfo> ex) {
            rethrow ex.err, sprintf("error in field %y with value %y; %s; rec: %y; output value derived from %s (v: %y)", key,
                value, ex.desc, rec, getMappingDescription(key, mapping), v), ex.arg;
        }
    }
 
protected:
     string getMappingDescription(string key, hash<auto> mapping);
public:
 
 
protected:
     checkInputProvider();
public:
 
 
 
protected:
     checkOutputProvider();
public:
 
 
 
protected:
     checkOutputBulkOperation();
public:
 
 
 
protected:
     error(string fmt);
public:
 
 
protected:
     error2(string ex, string fmt);
public:
 
 
protected:
     auto mapSubclass(hash<auto> m, auto v);
public:
 
 
protected:
      static AbstractDataProviderType getInputType(*string type);
public:
 
};
 
class AbstractMapperIterator : public Qore::AbstractIterator {
 
public:
 
protected:
        Qore::AbstractIterator i;
 
public:
 
 
    constructor(Qore::AbstractIterator iter);
 
 
    bool next();
 
 
    bool valid();
 
 
    bool hasBulk();
 
 
 
    list<hash> mapBulk(int size);
 
};
 
class MapperIterator : public Mapper::AbstractMapperIterator {
 
public:
 
protected:
        Mapper::Mapper mapc;
 
public:
 
 
    constructor(Qore::AbstractIterator i, hash<auto> mapv, *hash<auto> opts) ;
 
 
 
    constructor(Qore::AbstractIterator i, Mapper::Mapper mapv) ;
 
 
    hash<auto> getValue();
 
 
 
    int getCount();
 
 
 
    resetCount();
 
};
 
class AnythingDataType : public AbstractDataProviderType {
 
public:
protected:
        const SupportedOptions = {
            "string.max_size_chars": <DataProviderTypeOptionInfo>{
                "type": Type::Int,
                "desc": "the maximum size of strings in chars",
            },
            "string.empty_to_nothing": <DataProviderTypeOptionInfo>{
                "type": Type::Boolean,
                "desc": "if an empty string should be converted to no value",
            },
        };
 
public:
 
    constructor(*hash<auto> options) ;
 
 
    string getName();
 
 
    string getDesc();
 
 
    bool isAssignableFrom(AbstractDataProviderType t);
 
 
    bool isAssignableFrom(Type t);
 
 
    *Type getValueType();
 
 
    *AbstractDataProviderType getElementType();
 
 
 
    auto acceptsValue(auto value);
 
 
    *hash<string, AbstractDataField> getFields();
 
 
    *hash<string, hash<DataProviderTypeOptionInfo>> getSupportedOptions();
 
 
    hash<string, bool> getAcceptTypeHash();
 
 
    hash<string, bool> getReturnTypeHash();
 
};
 
class SomethingDataType : public AnythingDataType {
 
public:
    constructor(*hash<auto> options) ;
 
 
    string getName();
 
 
    bool isAssignableFrom(AbstractDataProviderType t);
 
 
    bool isAssignableFrom(Type t);
 
 
    *Type getValueType();
 
 
 
    auto acceptsValue(auto value);
 
};
 
class MapperOutputRecordIterator : public AbstractDataProviderRecordIterator {
 
public:
protected:
        Mapper mapper;
 
        AbstractDataProviderRecordIterator i;
 
public:
 
    constructor(Mapper mapper, AbstractDataProvider input, *hash<auto> where_cond, *hash<auto> search_options);
 
 
    bool next();
 
 
    hash<auto> getValue();
 
 
    bool valid();
 
};
};