com.github.jep42.easycsvmap

Class EasyCSVMap

java.lang.Object

com.github.jep42.easycsvmap.EasyCSVMap

public class EasyCSVMap
extends Object

EasyCSVMap allows parsing CSV files and accessing elements via name and/or index.

Constructor Summary

Constructors

Constructor and Description
EasyCSVMap() Creates EasyCSVMap object.
EasyCSVMap(CSVContext csvContext) Creates EasyCSVMap object.
EasyCSVMap(int headerRowIndex) Creates EasyCSVMap object.

Method Summary

Modifier and Type	Method and Description
int	getNumberOfCSVColumns() Retrieves the total number of columns of the parsed CSV structure
int	getNumberOfCSVRows() Retrieves the total number of rows of the parsed CSV structure (including data rows and header rows)
Iterator<Map<String,String>>	getRowIterator() An iterator over the rows of the CSV file, including a potentially existing header line.
Map<Integer,String>	getValues(String csvSelectorString) Convenient method to retrieve the value of particular cells from the CSV structure.
List<Map<String,String>>	parseCsv(String csvString) Parses the given CSV format
List<Map<String,String>>	parseCsvFromFile(String csvFilePath) Parses the given CSV file
void	saveToFile(String pathToCsv) Writes the CSV structure to file
void	setValues(String csvSelectorString, String value) Convenient method to set the values of particular cells in the CSV structure.

Methods inherited from class java.lang.Object

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

Constructor Detail

EasyCSVMap

public EasyCSVMap(int headerRowIndex)

Creates EasyCSVMap object. By specifying a header row via its row index, it is possible to access columns of the CSV format by its column name.

Parameters:

headerRowIndex - An arbitrary row in the CSV can be used as header row.

EasyCSVMap

public EasyCSVMap()

Creates EasyCSVMap object. This constructor is appropriate if the CSV format does only contain data rows but not a header row. If a header row exists in the CSV format use EasyCSVMap(int) to construct the EasyCSVMap object.

EasyCSVMap

public EasyCSVMap(CSVContext csvContext)

Creates EasyCSVMap object. This constructor allows custom format settings via CSVContext instance

Method Detail

parseCsvFromFile

public List<Map<String,String>> parseCsvFromFile(String csvFilePath)

Parses the given CSV file

Parameters:

csvFilePath - path to CSV file

Returns:

the parsed CSV

parseCsv

public List<Map<String,String>> parseCsv(String csvString)

Parses the given CSV format

Parameters:

csvString - CSV format as String

Returns:

the parsed CSV

getValues

@Nonnull
public Map<Integer,String> getValues(String csvSelectorString)

Convenient method to retrieve the value of particular cells from the CSV structure. These cells can be selected via a selector expression. The syntax of the selector expression is <rowSpecification>.<columnName>|<columnIndex> Examples:

• 2.name => if a header row was specified then the columns can be access via its name. Hence, this expression would find the value of column 'name' of the third row in the CSV (numeric row specification indicates a row index).
• 2.10 => if no header row was explicitly specified then the columns have to be accessed via index. Hence, this expression would find the value of the eleventh column of the third row in the CSV.

Beside simply using numeric row specifications it is also possible to use more complex ones, e.g. search a row via comparing column values with regular expressions. Example:

• [name=^Foo.*$].name => Would find all rows in which column 'name' has a value matching the given regular expression.

When using regular expressions as row specification it is possible that it matches more than just one row. hence, the method may return more then just one value.

Parameters:

csvPath -

Returns:

Map where the row index is used as Map-key and the cells value as Map-value

setValues

public void setValues(String csvSelectorString,
                      String value)

Convenient method to set the values of particular cells in the CSV structure. These cells can be selected via a selector expression, see EasyCSVMap#getValue(String). The given value is set for all cells matching the given selector expressions. If a header row was specified the corresponding row is read-only. An exception is thrown when trying the change a value of the header row.

Parameters:

csvPath -

getRowIterator

public Iterator<Map<String,String>> getRowIterator()

An iterator over the rows of the CSV file, including a potentially existing header line.

Returns:

saveToFile

public void saveToFile(String pathToCsv)

Writes the CSV structure to file

Parameters:

pathToCsv -

getNumberOfCSVRows

public int getNumberOfCSVRows()

Retrieves the total number of rows of the parsed CSV structure (including data rows and header rows)

Returns:

getNumberOfCSVColumns

public int getNumberOfCSVColumns()

Retrieves the total number of columns of the parsed CSV structure

Returns: