Script: Class dw.io.CSVStreamReader

Class CSVStreamReader

The class supports reading a CSV file. The reader supports handling CSV entries where the separator is contained in quotes and also CSV entries where a quoted entry contains newline characters.

Constructor Summary

CSVStreamReader(ioreader : Reader)

Creates a new CSVReader with a ',' as separator character and a '"' as quote character.

CSVStreamReader(ioreader : Reader, separator : String)

Creates a new CSVReader with the specified separator character and a '"' as quote character.

CSVStreamReader(ioreader : Reader, separator : String, quote : String)

Creates a new CSVReader with the specified separator character and the specified quote character.

CSVStreamReader(ioreader : Reader, separator : String, quote : String, skip : Number)

Creates a new CSVReader.

Method Summary

close() : void

Closes the underlying reader.

readAll() : List

Returns a list of lines representing the entire CSV file.

readNext() : String[]

Returns the next line from the input stream.

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constructor Detail

CSVStreamReader

publicCSVStreamReader(ioreader : Reader)

Creates a new CSVReader with a ',' as separator character and a '"' as quote character. The reader doesn't skip any header lines.

Parameters:

ioreader - the reader to use.

CSVStreamReader

publicCSVStreamReader(ioreader : Reader, separator : String)

Creates a new CSVReader with the specified separator character and a '"' as quote character. The reader doesn't skip any header lines.

Parameters:

ioreader - the reader to use.

separator - a string, which represents the separator character.

CSVStreamReader

publicCSVStreamReader(ioreader : Reader, separator : String, quote : String)

Creates a new CSVReader with the specified separator character and the specified quote character. The reader doesn't skip any header lines.

Parameters:

ioreader - the reader to use.

separator - a string, which represents the separator character.

quote - a string, which represents the quote character.

CSVStreamReader

publicCSVStreamReader(ioreader : Reader, separator : String, quote : String, skip : Number)

Creates a new CSVReader. The separator character, the quote character and the number of header lines can be specified in the call.

Parameters:

ioreader - the reader to use.

separator - a string, which represents the separator character.

quote - a string, which represents the quote character.

skip - the number of lines to skip at the beginning of the file.

Method Detail

close

close() : void

Closes the underlying reader.

readAll

readAll() : List

Returns a list of lines representing the entire CSV file. Each line is a array of strings.

Using this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use method readNext() and process entries line by line.

Returns:

a list of lines representing the entire CSV file.

readNext() : String[]

Returns the next line from the input stream. The line is returned as an array of strings. The method returns null if the end of the stream is reached.

Returns:

the next line from the input stream as an array of strings.