Mapper.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  Mapper.qm Copyright 2014 - 2024 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;
};
public hashdecl MapperOptionInfo {…};
 
class Mapper : public DataProvider::AbstractDataProcessor {
 
public:
        const ConstantConflictList = ("name", "struct", "code", "default");
 
        const OptionKeys = ...;
 
 
        const UserOptions = ...;
 
 
        const ValidKeys = ...;
 
 
        const OutputKeys = ...;
 
 
        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(),
        };
        hash<auto> global_transform_opts = {} + {…};
 
        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 = ...;
 
 
        const DeprecatedGlobalTransformOptionMap = ...;
 
 
        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:
 
 
protected:
      static hash<string, AbstractDataField> getInputFromHashIntern(hash<auto> input, *reference<bool> structured_input);
public:
 
 
protected:
      static hash<string, AbstractDataField> getOutputFromHashIntern(hash<auto> output, *hash<auto> mapv, *hash<auto> global_options, *reference<bool> structured_output);
public:
 
 
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();
 
 
protected:
     auto mapFieldType(string key, hash<auto> mapping, AbstractDataProviderType type, auto value, hash<auto> rec, auto v);
public:
 
 
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 Mapper : public DataProvider::AbstractDataProcessor {…};
 
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 AbstractMapperIterator : public Qore::AbstractIterator {…};
 
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 MapperIterator : public Mapper::AbstractMapperIterator {…};
 
class AnythingDataType : public AbstractDataProviderType {
 
public:
protected:
        const SupportedOptions = ...;
 
 
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(*bool simple);
 
 
    hash<string, bool> getReturnTypeHash(*bool simple);
 
};
class AnythingDataType : public AbstractDataProviderType {…};
 
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 SomethingDataType : public AnythingDataType {…};
 
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();
 
};
class MapperOutputRecordIterator : public AbstractDataProviderRecordIterator {…};
};