| Qore FixedLengthUtil Module Reference 1.6

Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FixedLengthUtil::FixedLengthWriteDataProvider Class Reference

Provides a data provider for reading fixed-length files. More...

`#include <FixedLengthWriteDataProvider.qc.dox.h>`

## Public Member Functions
| constructor (*hash< auto > options)
| Creates the object from constructor options.
| constructor (OutputStream stream, hash< auto > specs, *hash< auto > opts)
| Creates the FixedLengthWriteDataProvider with the output data stream where data will be writeen and an option hash.
| constructor (string path, hash< auto > specs, *hash< auto > opts)
| Creates the FixedLengthWriteDataProvider with the output path and optionally an option hash.
string | getName ()
| Returns the object name.

## Public Attributes
const | ConstructorOptions = ...
| Constructor options.
const | FixedLengthWriteOptionList = keys (ConstructorOptions - ("path", "stream", "spec"))
| write option list
const | ProviderInfo = ...
| Provider info.

## Protected Member Functions
*hash< auto > | createRecordImpl (hash< auto > rec, *hash< auto > create_options)
| Creates the given record to the data provider.
*hash< string, AbstractDataField > | getRecordTypeImpl (*hash< auto > search_options)
| Returns the description of the record type, if any.
hash< DataProviderInfo > | getStaticInfoImpl ()
| Returns data provider static info.

## Protected Attributes
FixedLengthAbstractWriter | writer
| the writer object

## Detailed Description

Provides a data provider for reading fixed-length files.

## Member Function Documentation

## ◆ constructor() [1/2]

FixedLengthUtil::FixedLengthWriteDataProvider::constructor | ( | OutputStream | stream,
|  | hash< auto > | specs,
|  | *hash< auto > | opts )

Creates the FixedLengthWriteDataProvider with the output data stream where data will be writeen and an option hash.

Parameters

  stream | the output stream for writing the data
  specs | Fixed-length line specification; see Specification Hash for more information
  opts | Global options; see Global Options for valid values

Exceptions

  FIXED-LENGTH-UTIL-PADDING-ERROR | record padding error

## ◆ constructor() [2/2]

FixedLengthUtil::FixedLengthWriteDataProvider::constructor | ( | string | path,
|  | hash< auto > | specs,
|  | *hash< auto > | opts )

Creates the FixedLengthWriteDataProvider with the output path and optionally an option hash.

Parameters

  path | The output file to write
  specs | Fixed-length line specification; see Specification Hash for more information
  opts | Global options; see Global Options for valid values

Exceptions

  FIXED-LENGTH-UTIL-PADDING-ERROR | record padding error

## ◆ createRecordImpl()

*hash< auto > FixedLengthUtil::FixedLengthWriteDataProvider::createRecordImpl | ( | hash< auto > | rec,
|  | *hash< auto > | create_options )
| protected

Creates the given record to the data provider.

Parameters

  rec | a hash representing a single input record
  create_options | the create options after processing by validateCreateOptions()

Returns
  the data written to the data provider