| Qore CsvUtil Module Reference 1.7.2

CsvFileIterator.qc.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // Qore CsvFileIterator class definition
3
4 /* CsvFileIterator.qc Copyright 2012 - 2018 Qore Technologies, s.r.o.
5
6 Permission is hereby granted, free of charge, to any person obtaining a
7 copy of this software and associated documentation files (the "Software"),
8 to deal in the Software without restriction, including without limitation
9 the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 and/or sell copies of the Software, and to permit persons to whom the
11 Software is furnished to do so, subject to the following conditions:
12
13 The above copyright notice and this permission notice shall be included in
14 all copies or substantial portions of the Software.
15
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 DEALINGS IN THE SOFTWARE.
23 */
24
25 // assume local var scope, do not use "$" for vars, members, and method calls
26
28 namespace CsvUtil {
30
37 class CsvFileIterator : public CsvUtil::AbstractCsvIterator {
38
39 public:
40 protected:
42 string m_file_path;
43
44 public:
45
47
52 constructor(string path, *hash opts) ;
53
54
56
60 constructor(string path, hash spec, hash opts) ;
61
62
64 auto memberGate(string name);
65
66
68 string getEncoding();
69
70
72 string getFileName();
73
74
76 hash<Qore::StatInfo> hstat();
77
78
80 list stat();
81
82 }; // CsvFileIterator class
83 }; // CsvUtil namespace
CsvUtil::AbstractCsvIterator
the AbstractCsvIterator class is an abstract base class that allows abstract CSV data to be iterated ...
Definition: AbstractCsvIterator.qc.dox.h:285
CsvUtil::CsvFileIterator::getFileName
string getFileName()
Returns the file path/name used to open the file.
CsvUtil::CsvFileIterator::constructor
constructor(string path, *hash opts)
Creates the CsvFileIterator in single-type mode with the path of the file to read and an option hash...
CsvUtil::CsvFileIterator
The CsvFileIterator class allows CSV files to be iterated on a record basis.
Definition: CsvFileIterator.qc.dox.h:37
list
list< auto > list(...)
CsvUtil::CsvFileIterator::stat
list stat()
Returns a stat list of the underlying file.
hash
hash< auto > hash(object obj)
CsvUtil::CsvFileIterator::m_file_path
string m_file_path
the path of the file being iterated
Definition: CsvFileIterator.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::CsvFileIterator::memberGate
auto memberGate(string name)
calls AbstractCsvIterator::memberGate()
CsvUtil::CsvFileIterator::hstat
hash< Qore::StatInfo > hstat()
Returns a StatInfo hash of the underlying file.
CsvUtil::CsvFileIterator::getEncoding
string getEncoding()
Returns the character encoding for the file.