FixedLengthWriteDataProvider.qc.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// Qore FixedLengthWriteDataProvider class definition
/* FixedLengthWriteDataProvider.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 FixedLengthUtil {
class FixedLengthWriteDataProvider : public DataProvider::AbstractDataProvider {
public:
const ProviderInfo = <DataProviderInfo>{
"type": "FixedLengthWriteDataProvider",
"supports_create": True,
"has_record": True,
"constructor_options": ConstructorOptions,
};
const ConstructorOptions = {
"path": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(StringType),
"desc": "the path to the fixed-length data; mutually exclusive with \"stream\"",
},
"stream": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(new Type("OutputStream")),
"desc": "an output stream for fixed-length data; mutually exclusive with \"path\"",
},
"spec": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(AutoHashType),
"desc": "the fixed-length record specification hash",
"required": True,
},
"opts": <DataProviderOptionInfo>{
"type": AbstractDataProviderType::get(AutoHashType),
"desc": "fixed-length generation options",
},
};
protected:
FixedLengthAbstractWriter writer;
public:
constructor(string path, hash<auto> specs, *hash<auto> opts);
constructor(OutputStream stream, hash<auto> specs, *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:
};
}; // FixedLengthUtil namespace
FixedLengthUtil::FixedLengthWriteDataProvider::ConstructorOptions
const ConstructorOptions
Constructor options.
Definition: FixedLengthWriteDataProvider.qc.dox.h:42
FixedLengthUtil::FixedLengthWriteDataProvider::getRecordTypeImpl
*hash< string, AbstractDataField > getRecordTypeImpl(*hash< auto > search_options)
Returns the description of the record type, if any.
FixedLengthUtil::FixedLengthWriteDataProvider::getStaticInfoImpl
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
FixedLengthUtil::FixedLengthWriteDataProvider::ProviderInfo
const ProviderInfo
Provider info.
Definition: FixedLengthWriteDataProvider.qc.dox.h:34
FixedLengthUtil::FixedLengthWriteDataProvider::constructor
constructor(string path, hash< auto > specs, *hash< auto > opts)
Creates the FixedLengthWriteDataProvider with the output path and optionally an option hash.
True
const True
FixedLengthUtil
The FixedLengthUtil namespace contains all the definitions in the FixedLengthUtil module.
Definition: FixedLengthAbstractIterator.qc.dox.h:27
FixedLengthUtil::FixedLengthWriteDataProvider::createRecordImpl
*hash< auto > createRecordImpl(hash< auto > rec, *hash< auto > create_options)
Creates the given record to the data provider.
FixedLengthUtil::FixedLengthWriteDataProvider::constructor
constructor(*hash< auto > options)
Creates the object from constructor options.
FixedLengthUtil::FixedLengthWriteDataProvider
Provides a data provider for reading fixed-length files.
Definition: FixedLengthWriteDataProvider.qc.dox.h:30
FixedLengthUtil::FixedLengthWriteDataProvider::getName
string getName()
Returns the object name.
FixedLengthUtil::FixedLengthWriteDataProvider::constructor
constructor(OutputStream stream, hash< auto > specs, *hash< auto > opts)
Creates the FixedLengthWriteDataProvider with the output data stream where data will be writeen and a...
FixedLengthUtil::FixedLengthAbstractWriter
Structured abstract writer for fixed-length lines.
Definition: FixedLengthAbstractWriter.qc.dox.h:29
FixedLengthUtil::FixedLengthWriteDataProvider::writer
FixedLengthAbstractWriter writer
the writer object
Definition: FixedLengthWriteDataProvider.qc.dox.h:64