com.github.jep42.roboteasycsv

Class RobotEasyCsv

java.lang.Object

com.github.jep42.roboteasycsv.RobotEasyCsv

public class RobotEasyCsv
extends java.lang.Object

This library provides keywords to read / write values from CSV files using selector expressions. Basically, the selector expression consists of two elements: a *row selector* and a *column selector* in the format . *Row Selector* Rows can be selected directly via row index or via a regular expression. Obviously, a row index always matches exactly one row in the CSV whereas a regular expression may match several rows. *Column Selector* The column can be selected via its name as long as the the CSV contains a header row and the row index of the header row was properly set when parsing the CSV file via `Parse Csv From File`. If the CSV does not contain a header row the column index has to be used as selector. Example selector expressions: | *Selector* | *Comment* | | ``{2}.name`` | If a header row was specified then columns can be accessed via their names. Hence, this expression would find the value of column 'name' of the third row in the CSV. | | ``{*}.name`` | The row selector supports wildcard, so this expression would select all rows and therefore finds all values of column 'name' | | ``{2,3,4}.name`` | A list of row indexes can be used to select particular rows by index. This expression would select column 'name' of rows with index 2, 3 and 4 | | ``{2}.10`` | If no header row was specified then the column has to be selected via its index. Therefore, this expression would find the value of 11th column of the third row in the CSV. | | ``[city=^Ka.*$].name`` | The row selector supports regular expressions to select lines with particular values in particular columns. This expression would select all lines with a value starting with "Ka" in the column name' |

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROBOT_LIBRARY_SCOPE
static java.lang.String	ROBOT_LIBRARY_VERSION

Constructor Summary

Constructors

Constructor and Description
RobotEasyCsv()

Method Summary

Modifier and Type	Method and Description
void	addRow(java.lang.Integer sessionId, java.lang.String... values) Add a row to CSV.
java.util.List<java.lang.String>	getAllCsvValues(java.lang.Integer sessionId, java.lang.String selector) Get the values of all cells matching the given selector expression.
java.lang.String	getFirstCsvValue(java.lang.Integer sessionId, java.lang.String selector) Get the value of the first cell matching the given selector expression.
void	parseCsvFromFile(java.lang.Integer sessionId, java.lang.String pathToCsv, int headerLineIndex) Parse a CSV file from the given path and creates a new CSV session object identified by the given Session ID.
void	parseCsvFromFile(java.lang.Integer sessionId, java.lang.String pathToCsv, int headerLineIndex, java.lang.String columnSeparator, java.lang.String quoteCharacter, java.lang.String lineEndEscaped) Parse a CSV file from the given path and creates a new CSV session object identified by the given Session ID.
void	removeCsvSession(java.lang.Integer sessionId) Removes the CSV session identified by the given session ID.
void	saveCsvToFile(java.lang.Integer sessionId, java.lang.String filePath) Save the CSV to file.
void	setCsvValues(java.lang.Integer sessionId, java.lang.String selector, java.lang.String value) Set the value of a the cell(s) matching the given selector expression.

Methods inherited from class java.lang.Object

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

Field Detail

ROBOT_LIBRARY_VERSION

public static final java.lang.String ROBOT_LIBRARY_VERSION

See Also:

Constant Field Values

ROBOT_LIBRARY_SCOPE

public static final java.lang.String ROBOT_LIBRARY_SCOPE

See Also:

Constant Field Values

Constructor Detail

RobotEasyCsv

public RobotEasyCsv()

Method Detail

parseCsvFromFile

public void parseCsvFromFile(java.lang.Integer sessionId,
                             java.lang.String pathToCsv,
                             int headerLineIndex)

Parse a CSV file from the given path and creates a new CSV session object identified by the given Session ID. The Session ID has to be unique and is used in subsequent calls to specify the CSV session. Arguments: - _sessionId_: unique ID for new CSV session - _pathToCsv_: path to the CSV file - _headerLineIndex_: the line index of the header line within CSV. Set to -1 if no header line exists. Example: | Parse Csv From File | 4711 | {TEMPDIR}/download.csv | 0 |

parseCsvFromFile

public void parseCsvFromFile(java.lang.Integer sessionId,
                             java.lang.String pathToCsv,
                             int headerLineIndex,
                             java.lang.String columnSeparator,
                             java.lang.String quoteCharacter,
                             java.lang.String lineEndEscaped)

Parse a CSV file from the given path and creates a new CSV session object identified by the given Session ID. The Session ID has to be unique and is used in subsequent calls to specify the CSV session. Arguments: - _sessionId_: unique ID for new CSV session - _pathToCsv_: path to the CSV file - _headerLineIndex_: the line index of the header line within CSV. Set to -1 if no header line exists. - _columnSeparator_: the column separator character - _quoteCharacter_: the character used to quote values - _lineEnd_: Specifies the character sequence used to terminate a line, this parameter is only used for save operation. In control characters backslashes have to be escaped (e.g. for new line character use \\n ) Example: | Parse Csv From File | 4711 | {TEMPDIR}/download.csv | 0 | ; | " | \\r\\n

setCsvValues

public void setCsvValues(java.lang.Integer sessionId,
                         java.lang.String selector,
                         java.lang.String value)

Set the value of a the cell(s) matching the given selector expression. Arguments: - _sessionId_: ID of a previously created CSV session - _selector_: a valid CSV selector expression - _value_: the value to be set Example: | Set Csv Values | 4711 | {1}.name | Peter Pan |

getFirstCsvValue

public java.lang.String getFirstCsvValue(java.lang.Integer sessionId,
                                         java.lang.String selector)

Get the value of the first cell matching the given selector expression. Arguments: - _sessionId_: ID of a previously created CSV session - _selector_: a valid CSV selector expression Example: | {name}= | Get First Csv Value | 4711 | {1}.name |

getAllCsvValues

public java.util.List<java.lang.String> getAllCsvValues(java.lang.Integer sessionId,
                                                        java.lang.String selector)

Get the values of all cells matching the given selector expression.

The keyword returns list of values without further information about the corresponding source cells. Arguments: - _sessionId_: ID of a previously created CSV session - _selector_: a valid CSV selector expression Example: | &{name}= | Get All Csv Values | 4711 | [city=^Karlsruhe*$].name |

saveCsvToFile

public void saveCsvToFile(java.lang.Integer sessionId,
                          java.lang.String filePath)

Save the CSV to file. Arguments: - _sessionId_: ID of a previously created CSV session - _filePath_: target path to the CSV file Example: | Save Csv To File | 4711 | {TEMPDIR}/myFile.csv |

addRow

public void addRow(java.lang.Integer sessionId,
                   java.lang.String... values)

Add a row to CSV. Arguments: - _sessionId_: ID of a previously created CSV session - _values_: The values of the new row Example: | Add Row | 4711 | col1value | col2value | col3value |

removeCsvSession

public void removeCsvSession(java.lang.Integer sessionId)

Removes the CSV session identified by the given session ID. Arguments: - _sessionId_: ID of a previously created CSV session Example: | Remove CSV Session | 4711 |