com.knowgate.stringutils

Class CSVParser

java.lang.Object

com.knowgate.stringutils.CSVParser

public class CSVParser
extends Object

Delimited Text Parser

Parses a delimited text file into a memory array

Version:

6.0

Author:

Sergio Montoro Ten

Constructor Summary

Constructors

Constructor and Description
CSVParser()
CSVParser(String sCharSetName) Create CSV Parser and set encoding to be used

Method Summary

Modifier and Type	Method and Description
String	charSet()
void	charSet(String sCharSetName)
int	errorLine()
int	find(int iCol, String sVal) Find first occurence of a value at a given column
int	findi(int iCol, String sVal) Find first occurence of a value at a given column
int	getColumnCount() Get column count
int	getColumnPosition(String sColumnName)
char	getDelimiter()
String	getField(int iCol, int iRow) Get value for a field at a given row and column.
String	getField(String sCol, int iRow) Get value for a field at a given row and column.
String	getLine(int iLine) Get line from a parsed file.
HashMap	getLineAsMap(int iLine) Get line from a parsed file as a Map of named values.
int	getLineCount() Get line count
void	parseData(char[] aCharData, String sFileDescriptor) Parse data from a character array
void	parseFile(File oFile, String sFileDescriptor) Parse a delimited text file
void	parseFile(String sFilePath, String sFileDescriptor) Parse a delimited text file
void	parseSheet(org.apache.poi.hssf.usermodel.HSSFSheet oSheet, String sFileDescriptor)
void	writeToFile(String sFilePath) Write CSVParser matrix to delimited text file
void	writeToStream(OutputStream oStrm) Write CSVParser matrix to an output stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CSVParser

public CSVParser()

CSVParser

public CSVParser(String sCharSetName)

Create CSV Parser and set encoding to be used

Parameters:

sCharSetName - Name of charset encoding

Method Detail

charSet

public String charSet()

charSet

public void charSet(String sCharSetName)

getLineCount

public int getLineCount()

Get line count

Returns:

int

Since:

3.0

getColumnCount

public int getColumnCount()

Get column count

Returns:

int

Since:

3.0

errorLine

public int errorLine()

getDelimiter

public char getDelimiter()

parseSheet

public void parseSheet(org.apache.poi.hssf.usermodel.HSSFSheet oSheet,
                       String sFileDescriptor)

parseData

public void parseData(char[] aCharData,
                      String sFileDescriptor)
               throws ArrayIndexOutOfBoundsException,
                      RuntimeException,
                      NullPointerException,
                      IllegalArgumentException

Parse data from a character array

Parsed values are stored at an internal array in this CSVParser.

Parameters:

aCharData - Character array to be parsed

sFileDescriptor - A list of column names separated by ',' ';' '|' '`' or '\t'. Column names may be quoted. Lines are delimiter by '\n' characters
Example 1) tx_mail,tx_name,tx_surname
Example 2) "tx_name","tx_surname","tx_salutation"

Throws:

ArrayIndexOutOfBoundsException - Delimited values for a file is greater than columns specified at descriptor.

RuntimeException - If delimiter is not one of { ',' ';' '|' '`' or '\t' }

NullPointerException - if sFileDescriptor is null

IllegalArgumentException - if sFileDescriptor is ""

parseFile

public void parseFile(File oFile,
                      String sFileDescriptor)
               throws ArrayIndexOutOfBoundsException,
                      IOException,
                      FileNotFoundException,
                      RuntimeException,
                      NullPointerException,
                      IllegalArgumentException,
                      UnsupportedEncodingException

Parse a delimited text file

Parsed values are stored at an internal array in this CSVParser.
File is readed using the character set specifid at constructor

Parameters:

oFile - CSV File

sFileDescriptor - A list of column names separated by ',' ';' '|' '`' or '\t'. Column names may be quoted. Lines are delimiter by '\n' characters
Example 1) tx_mail,tx_name,tx_surname
Example 2) "tx_name","tx_surname","tx_salutation"

Throws:

IOException

FileNotFoundException

ArrayIndexOutOfBoundsException - Delimited values for a file is greater than columns specified at descriptor.

RuntimeException - If delimiter is not one of { ',' ';' '|' '`' or '\t' }

NullPointerException - if oFile or sFileDescriptor are null

IllegalArgumentException - if sFileDescriptor is ""

UnsupportedEncodingException

Since:

3.0

parseFile

public void parseFile(String sFilePath,
                      String sFileDescriptor)
               throws ArrayIndexOutOfBoundsException,
                      IOException,
                      FileNotFoundException,
                      RuntimeException,
                      NullPointerException,
                      IllegalArgumentException,
                      UnsupportedEncodingException

Parse a delimited text file

Parsed values are stored at an internal array in this CSVParser.

Parameters:

sFilePath - File Path

sFileDescriptor - A list of column names separated by ',' ';' '|' '`' or '\t'. Column names may be quoted. Lines are delimiter by '\n' characters
Example 1) tx_mail,tx_name,tx_surname
Example 2) "tx_name","tx_surname","tx_salutation"

Throws:

IOException

FileNotFoundException

ArrayIndexOutOfBoundsException - Delimited values for a file is greater than columns specified at descriptor.

RuntimeException - If delimiter is not one of { ',' ';' '|' '`' or '\t' }

NullPointerException - if oFile or sFileDescriptor are null

IllegalArgumentException - if sFileDescriptor is ""

UnsupportedEncodingException

getColumnPosition

public int getColumnPosition(String sColumnName)

Parameters:

sColumnName - Column Name

Returns:

Zero based index for column position or -1 if column was not found.

getLine

public String getLine(int iLine)
               throws IllegalStateException,
                      UnsupportedEncodingException

Get line from a parsed file.

Lines are delimited by the Line Feed (LF, CHAR(10), '\n') character

Parameters:

iLine - Line Number [0..getLineCount()-1]

Returns:

Full Text for Line. If iLine<0 or iLine>=getLineCount() then null

Throws:

IllegalStateException - If parseFile() has not been called prior to getLine()

UnsupportedEncodingException

getLineAsMap

public HashMap getLineAsMap(int iLine)
                     throws IllegalStateException,
                            UnsupportedEncodingException,
                            ArrayIndexOutOfBoundsException

Get line from a parsed file as a Map of named values.

This method is usefull when parsing plain text lines into DBPersist instances

Parameters:

iLine - Line Number [0..getLineCount()-1]

Returns:

HashMap

Throws:

IllegalStateException - If parseFile() has not been called prior to getLine()

UnsupportedEncodingException

ArrayIndexOutOfBoundsException

Since:

4.0

getField

public String getField(int iCol,
                       int iRow)
                throws IllegalStateException,
                       ArrayIndexOutOfBoundsException,
                       StringIndexOutOfBoundsException,
                       UnsupportedEncodingException

Get value for a field at a given row and column.

Column indexes are zero based.
Row indexes range from 0 to getLineCount()-1.

Parameters:

iCol - Column Index

iRow - Row Index

Returns:

Field Value

Throws:

IllegalStateException - If parseFile() method was not called prior to getField()

ArrayIndexOutOfBoundsException - If Column or Row Index is out of bounds.

StringIndexOutOfBoundsException - If Row is malformed.

UnsupportedEncodingException - If charset encoding name is not recognized.

getField

public String getField(String sCol,
                       int iRow)
                throws IllegalStateException,
                       ArrayIndexOutOfBoundsException,
                       StringIndexOutOfBoundsException,
                       UnsupportedEncodingException

Get value for a field at a given row and column.

Parameters:

sCol - Column name

iRow - Row position [0..getLineCount()-1]

Returns:

Field value

Throws:

IllegalStateException

ArrayIndexOutOfBoundsException

StringIndexOutOfBoundsException

UnsupportedEncodingException

find

public int find(int iCol,
                String sVal)
         throws UnsupportedEncodingException

Find first occurence of a value at a given column

Search is case sensitive

Parameters:

iCol - int Column index [0..getColumnCount()-1]

sVal - String Value sought

Returns:

int

Throws:

UnsupportedEncodingException

Since:

3.0

findi

public int findi(int iCol,
                 String sVal)
          throws UnsupportedEncodingException

Find first occurence of a value at a given column

Search is case insensitive

Parameters:

iCol - int Column index [0..getColumnCount()-1]

sVal - String Value sought

Returns:

int

Throws:

UnsupportedEncodingException

Since:

3.0

writeToStream

public void writeToStream(OutputStream oStrm)
                   throws IOException

Write CSVParser matrix to an output stream

Parameters:

oStrm - OutputStream

Throws:

IOException

Since:

3.0

writeToFile

public void writeToFile(String sFilePath)
                 throws IOException,
                        SecurityException

Write CSVParser matrix to delimited text file

Parameters:

sFilePath - String Path to output file

Throws:

IOException

SecurityException

Since:

3.0