CsvWriteDataProvider.qc.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore CsvWriteDataProvider class definition
 
/*  CsvWriteDataProvider.qc Copyright 2012 - 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.
*/
 
// assume local var scope, do not use "$" for vars, members, and method calls
 
namespace CsvUtil {
class CsvWriteDataProvider : public DataProvider::AbstractDataProvider {
 
public:
        const ProviderInfo = <DataProviderInfo>{
            "type": "CsvWriteDataProvider",
            "supports_create": True,
            "has_record": True,
            "constructor_options": ConstructorOptions,
        };
 
        const ConstructorOptions = {
            "path": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "the location for the output CSV data file; mutually exclusive with \"stream\"; the output "
                    "location is handled by a call to FileLocationHandler::getOutputStreamForLocation()",
            },
            "stream": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(new Type("OutputStream")),
                "desc": "an output stream for CSV data; mutually exclusive with \"path\"",
            },
            "block": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(SoftIntType),
                "desc": "the block size when generating bulk output",
            },
            "datamap": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(AutoHashType),
                "desc": "a hash mapping actual data key names to the output field names, for use in case the data "
                    "field names differ; does not have to include every data or output key; keys not present will be "
                    "assumed to be mapped 1:1",
            },
            "date_format": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "the default mask for date value formatting",
            },
            "encoding": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "the character encoding for the data",
            },
            "eol": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "the end of line / record character(s)",
            },
            "fields": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(AutoHashType),
                "desc": "describes the data to be output",
            },
            "headers": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(new Type("softlist<string>")),
                "desc": "list of field header / column names for the data iterated",
            },
            "header_reorder": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(SoftBoolType),
                "desc": "if `true` (the default) then if `headers` are provided, then data fields are reordered to "
                    "follow headers",
            },
            "optimal_quotes": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(SoftBoolType),
                "desc": "set to `false` to disable optimal quoting; when optimal quoting is disabled, all fields are "
                    "quoted regardless of type or content, when it is enabled, then fields are quoted only if they "
                    "require quoting (i.e. they contain a quote or separator character); the default is `true`",
            },
            "quote": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "the quote character to quote fields (default: `\"`)",
            },
            "quote_escape": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "escape character(s) used for `quote` (default: `\\`)",
            },
            "separator": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(StringType),
                "desc": "string separating fields in the data (default: `,`)",
            },
            "verify_columns": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(SoftBoolType),
                "desc": "if `true` (the default is `false`) then if a line is parsed with a different column count "
                    "than other lines, a `CSVFILEWRITER-DATA-ERROR` exception is thrown",
            },
            "write_headers": <DataProviderOptionInfo>{
                "type": AbstractDataProviderType::get(SoftBoolType),
                "desc": "set to `false` to suppress the output of headers; the default is `true`, meaning to output "
                    "headers if they are present",
            },
        };
 
        const CsvGenerationOptionList = keys (ConstructorOptions - ("path", "stream"));
 
protected:
        AbstractCsvWriter writer;
 
public:
 
 
    constructor(string path, *hash<auto> opts);
 
 
 
    constructor(OutputStream stream, *hash<auto> opts);
 
 
    string getName();
 
 
    constructor(*hash<auto> options);
 
 
protected:
     *hash<string, AbstractDataField> getRecordTypeImpl(*hash<auto> search_options);
public:
 
 
 
protected:
     *hash<auto> createRecordImpl(hash<auto> rec, *hash<auto> create_options);
public:
 
 
protected:
     hash<DataProviderInfo> getStaticInfoImpl();
public:
 
};
}; // CsvUtil namespace