MapperUtil.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
 
 
namespace Mapper {
    const MapperKeyInfo = {
        "code": <MapperRuntimeKeyInfo>{
            "desc": "a code block for generating the field output programmatically",
            "value_type": "mapper-code",
        },
        "constant": <MapperRuntimeKeyInfo>{
            "desc": "a constant value for the output field",
            "value_type": "any",
            "requires_field_type": True,
            "unique_roles": "*",
        },
        "default": <MapperRuntimeKeyInfo>{
            "desc": "the default value for the field if no input is provided",
            "value_type": "any",
            "requires_field_type": True,
        },
        "index": <MapperRuntimeKeyInfo>{
            "desc": "the index number of the row; an integer value will be added to the current row number, a string "
                "will be prepended to the current row number",
            "value_type": "any",
            "unique_roles": "*",
        },
        "name": <MapperRuntimeKeyInfo>{
            "desc": "the name of the input field; dot notation accepted",
            "value_type": "string",
            "unique_roles": "value",
        },
        "runtime": <MapperRuntimeKeyInfo>{
            "desc": "the name of the field in the runtime hash where to take the value from",
            "value_type": "string",
            "unique_roles": "*",
        },
        "submapper": <MapperRuntimeKeyInfo>{
            "desc": "the name or identifier of a submapper that will provide a list of values for this field (cannot "
                "be used with bulk APIs)",
            "value_type": "string",
            "unique_roles": "submapper",
        },
        "submapper_auto_input": <MapperRuntimeKeyInfo>{
            "desc": "use the input provider from the submapper for the output of the field; requires "
            "\"submapper_options\" to provide input configuration for the submapper",
            "value_type": "bool",
            "requires_roles": ("submapper", "submapper_options"),
        },
        "submapper_options": <MapperRuntimeKeyInfo>{
            "desc": "allows a parent mapper to affect the options of the submapper based on current data; use "
                "\"$local:input.<field>\" to refer to mapped data in the current parent mapper input row to affect "
                "submapper options",
            "value_type": "hash",
            "unique_roles": ("submapper_options"),
            "requires_roles": "submapper",
        },
        "trunc": <MapperRuntimeKeyInfo>{
            "desc": "if True and the input is longer than the output field permits, the input will be "
                "silently truncated",
            "value_type": "bool",
        },
        "type_options": <MapperRuntimeKeyInfo>{
            "desc": "a hash of type options; this must correspond to option values for the output data type",
            "value_type": "option_hash",
        },
        "use_input_record": <MapperRuntimeKeyInfo>{
            "desc": "The entire input record will be used for the output field mapping; only compatible with hash "
                "output fields",
            "value_type": "bool",
            "unique_roles": "*",
            "returns_type": "hash",
        },
    };
 
    public hashdecl MapperRuntimeKeyInfo {
        string desc;
 
        string value_type = "string";
 
        *hash<string, bool> conflicting_keys;
 
        bool requires_field_type = False;
 
 
        *softlist<string> unique_roles;
 
        *softlist<string> requires_roles;
 
        *string returns_type;
 
 
        *code handler;
    };
};