sparksee.CSVReader Class Reference

CSVReader interface. More...

Inheritance diagram for sparksee.CSVReader:

Inheritance graph
Collaboration diagram for sparksee.CSVReader:

Collaboration graph

List of all members.

Public Member Functions

def reset
 Moves the reader to the beginning.
def close
 Closes the reader.
def set_num_lines
 Used to limit the number of lines that will be read.
def open
 Opens the source file path.
def set_multilines
 Allows the use of fields with more than one line.
def set_separator
 Sets the character used to separate fields in the file.
def set_quotes
 Sets the character used to quote fields.
def set_single_line
 Only allows single line fields.
def read
 Reads the next row as a string array.
def set_start_line
 Sets the number of lines to be skiped from the beginning.
def set_locale
 Sets the locale that will be used to read the file.
def get_row
 The row number for the current row.
def __init__
 Constructs CSVReader.


Detailed Description

CSVReader interface.

A very simple CSV reader.

It works as any other RowReader, but open must be called once before the first read operation.

Using the format RFC 4180.

Except: leading and trailing spaces, adjacent to CSV separator character, are trimmed.

You can use your own separators and quote characters. By default the separator is the comma (,) and the quote character is the double quotes (").

Fields with multiple lines can be allowed (and the maximum lines specified), but the default is a single line.

The locale string can be used to set the language, country and the file encoding. The format must be "[language_territory][.codeset]". But only the file encoding is being used in the current version.

The languages supported are: "en_US", "es_ES" and "ca_ES".

The file encodings supported are: "utf8" and "iso88591".

For example:

To don't change the default locales, use an empty string: "".

To read a file in utf8 with the default language settings use ".utf8".

To read a file in iso88591 with English language use: "en_US.iso88591".

Check out the 'Data import' section in the SPARKSEE User Manual for more details on this.

Author:
Sparsity Technologies http://www.sparsity-technologies.com

Member Function Documentation

def sparksee.CSVReader.reset (   self  ) 

Moves the reader to the beginning.

Restarts the reader.

Returns:
true if the reader can be restarted, false otherwise.
Exceptions:
IOError If bad things happen during the restart.

Reimplemented from sparksee.RowReader.

def sparksee.CSVReader.close (   self  ) 

Closes the reader.

Exceptions:
IOError If the close fails.

Reimplemented from sparksee.RowReader.

def sparksee.CSVReader.set_num_lines (   self,
  numLines 
)

Used to limit the number of lines that will be read.

Parameters:
numLines [in] The maximum number of lines to read (0 == unlimited)

def sparksee.CSVReader.open (   self,
  f 
)

Opens the source file path.

Parameters:
f [in] CSV file path.
Exceptions:
IOError If bad things happen opening the file.

def sparksee.CSVReader.set_multilines (   self,
  numExtralines 
)

Allows the use of fields with more than one line.

Parameters:
numExtralines [in] Maximum number of extra lines for each column (0==unlimited, N==N+1 total rows).

def sparksee.CSVReader.set_separator (   self,
  sep 
)

Sets the character used to separate fields in the file.

Parameters:
sep [in] Separator character.
Exceptions:
RuntimeError null

def sparksee.CSVReader.set_quotes (   self,
  quotes 
)

Sets the character used to quote fields.

Parameters:
quotes [in] Quote character.
Exceptions:
RuntimeError null

def sparksee.CSVReader.read (   self,
  row 
)

Reads the next row as a string array.

Parameters:
row [out] A string list with each comma-separated element as a separate entry.
Returns:
Returns true if a row had been read or false otherwise.
Exceptions:
IOError If bad things happen during the read.

Reimplemented from sparksee.RowReader.

def sparksee.CSVReader.set_start_line (   self,
  startLine 
)

Sets the number of lines to be skiped from the beginning.

Parameters:
startLine [in] The line number to skip for start reading

def sparksee.CSVReader.set_locale (   self,
  localeStr 
)

Sets the locale that will be used to read the file.

Parameters:
localeStr [in] The locale string for the file encoding.

def sparksee.CSVReader.get_row (   self  ) 

The row number for the current row.

Returns:
The current row number; 0 if there is no current row.
Exceptions:
IOError If it fails.

Reimplemented from sparksee.RowReader.


Generated on Fri Feb 7 13:22:17 2014 for SparkseePython by  doxygen 1.5.6