io.github.tuzon.java.csv.api

Class CsvReaderApi

java.lang.Object

io.github.tuzon.projects.core.base.ObjectBase

io.github.tuzon.java.csv.api.CsvApiBase

io.github.tuzon.java.csv.api.CsvReaderApi

public class CsvReaderApi
extends CsvApiBase

Parse CSV file.

Author:

Eyal Tuzon

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CSV_CONTAIN_HEADERS

Fields inherited from class io.github.tuzon.java.csv.api.CsvApiBase

CELLS_DEFAULT_SPLITTER, cellsSplitter, csvRows, filePath, headerList

Constructor Summary

Constructors

Constructor and Description
CsvReaderApi(String filePath) Constructor.
CsvReaderApi(String filePath, boolean isCsvContainHeaders) Constructor.
CsvReaderApi(String filePath, CellsSplitterEnum cellsSplitter) Constructor.
CsvReaderApi(String filePath, char cellsSplitter) Constructor.
CsvReaderApi(String filePath, char cellsSplitter, boolean isCsvContainHeaders) Constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	getColumn(String headerName) Get column cells.
int	getColumnIndex(String headerName) Get column index that it's header is 'headerName'.
String	getFieldValue(String headerName, int rowIndex) Get cell value.
List<String>	getHeaderList() Get header list.
String	getPath() Get CSV file path.
List<String>	getRow(int index) Get row in index.
int	getRowIndex(String headerName, String value) Get row index thats it's column header is 'headerName', and cell in that column is 'value'.
List<List<String>>	getRows() Get rows not include headers row.
int	getRowsAmount() Get CSV rows amount.
boolean	isCsvEmpty() Return true if CSV not contain rows, Ignore headers line if exists.

Methods inherited from class io.github.tuzon.projects.core.base.ObjectBase

validateNotNegative, validateNotNegative, validateNotNull, validateNotNull

Methods inherited from class java.lang.Object

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

Field Detail

CSV_CONTAIN_HEADERS

public static final boolean CSV_CONTAIN_HEADERS

See Also:

Constant Field Values

Constructor Detail

CsvReaderApi

public CsvReaderApi(String filePath)
             throws IOException

Constructor.

Parameters:

filePath - CSV file path.

Throws:

IOException - in case fail read CSV file.

CsvReaderApi

public CsvReaderApi(String filePath,
                    CellsSplitterEnum cellsSplitter)
             throws IOException

Constructor.

Parameters:

filePath - CSV file path.

cellsSplitter - CSV cells splitter enum.

Throws:

IOException - in case fail read CSV file.

CsvReaderApi

public CsvReaderApi(String filePath,
                    boolean isCsvContainHeaders)
             throws IOException

Constructor.

Parameters:

filePath - CSV file path.

isCsvContainHeaders - true in case CSV file contain headers, else the value is false.

Throws:

IOException - in case fail read CSV file.

CsvReaderApi

public CsvReaderApi(String filePath,
                    char cellsSplitter)
             throws IOException

Constructor.

Parameters:

filePath - CSV file path.

cellsSplitter - Cells splitter char.

Throws:

IOException - in case fail read CSV file.

CsvReaderApi

public CsvReaderApi(String filePath,
                    char cellsSplitter,
                    boolean isCsvContainHeaders)
             throws IOException

Constructor.

Parameters:

filePath - CSV file path.

cellsSplitter - CSV cells splitter char.

isCsvContainHeaders - true in case CSV file contain headers, else the value is false.

Throws:

IOException - in case fail read CSV file.

Method Detail

getRowsAmount

public int getRowsAmount()

Get CSV rows amount. Not include headers line.

Returns:

CSV rows amount.

isCsvEmpty

public boolean isCsvEmpty()

Return true if CSV not contain rows, Ignore headers line if exists.

Returns:

true in case the CSV file not contain any row.

getHeaderList

public List<String> getHeaderList()

Get header list.

Returns:

String list of CSV headers.

getColumnIndex

public int getColumnIndex(String headerName)

Get column index that it's header is 'headerName'. First index is 0.

Parameters:

headerName - Header name.

Returns:

Column index. Return -1 in case header not exists.

getRowIndex

public int getRowIndex(String headerName,
                       String value)
                throws IndexOutOfBoundsException

Get row index thats it's column header is 'headerName', and cell in that column is 'value'.

Parameters:

headerName - Header name.

value - Field value.

Returns:

Row index. Return -1 in case column or cell not exist.

Throws:

IndexOutOfBoundsException - In case column index exceed row.

getColumn

public List<String> getColumn(String headerName)

Get column cells.

Parameters:

headerName - Header name.

Returns:

List of column cells. Return null in case column not exists.

getFieldValue

public String getFieldValue(String headerName,
                            int rowIndex)
                     throws io.github.tuzon.projects.core.expections.InvalidValueException,
                            IndexOutOfBoundsException

Get cell value.

Parameters:

headerName - Header name.

rowIndex - Row index.

Returns:

Field value in column that it's header is 'headerName', and the cell exists in 'rowIndex'. Return null in case 'headerName' column not exists.

Throws:

io.github.tuzon.projects.core.expections.InvalidValueException - Row index is negative number.

IndexOutOfBoundsException - Row index exceed of column size.

getRows

public List<List<String>> getRows()

Get rows not include headers row.

Returns:

CSV cells not include headers line.

getRow

public List<String> getRow(int index)
                    throws io.github.tuzon.projects.core.expections.InvalidValueException,
                           IndexOutOfBoundsException

Get row in index. Index 0 start after headers row.

Parameters:

index - Row index not include headers row.

Returns:

Row cells.

Throws:

io.github.tuzon.projects.core.expections.InvalidValueException - Index is negative number.

IndexOutOfBoundsException - Index exceed of rows amount.

getPath

public String getPath()

Get CSV file path.

Returns:

CSV file path.