CsvWriteDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore CsvWriteDataProvider class definition
/* CsvWriteDataProvider.qc Copyright 2012 - 2020 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 path to the CSV data; mutually exclusive with \"stream\"",
},
"stream": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(new Type("OutputStream")),
"desc": "an output stream for CSV data; mutually exclusive with \"path\"",
},
"opts": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(AutoHashType),
"desc": "CSV generation options",
},
};
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
CsvUtil::CsvWriteDataProvider::constructor
constructor(string path, *hash< auto > opts)
Creates the CsvWriteDataProvider with the output path and optionally an option hash.
CsvUtil::CsvWriteDataProvider::createRecordImpl
*hash< auto > createRecordImpl(hash< auto > rec, *hash< auto > create_options)
Creates the given record to the data provider.
True
const True
CsvUtil::CsvWriteDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition: CsvWriteDataProvider.qc.dox.h:42
CsvUtil
the CsvUtil namespace. All classes used in the CsvUtil module should be inside this namespace
Definition: AbstractCsvIterator.qc.dox.h:28
CsvUtil::CsvWriteDataProvider::writer
AbstractCsvWriter writer
the writer object
Definition: CsvWriteDataProvider.qc.dox.h:59
CsvUtil::CsvWriteDataProvider::getName
string getName()
Returns the object name.
CsvUtil::AbstractCsvWriter
The AbstractCsvWriter class provides a parent for all CSV writers.
Definition: AbstractCsvWriter.qc.dox.h:139
CsvUtil::CsvWriteDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
CsvUtil::CsvWriteDataProvider::getRecordTypeImpl
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
CsvUtil::CsvWriteDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: CsvWriteDataProvider.qc.dox.h:34
CsvUtil::CsvWriteDataProvider
Provides a data provider for reading CSV files.
Definition: CsvWriteDataProvider.qc.dox.h:30