Skip to main content
[ This file is autogenerated from apexdoc ]

AqCsv

Encapsulates processing of comma-separated values file

Group apex/csv reader

Constructors​

public AqCsv(Config config)​

Construct and pass in configuration

public AqCsv(String configResourceName)​

Load config from a resource


Fields​

public config → Config​

public csvString → String​

public hasHeaders → Boolean​


Properties​

public CurrentRowIndex → Integer​


Methods​

public void load(String csvString, Boolean hasHeaders)​

Load contents from a string

public void reset()​

Reset to beginning of file

public Row getNextRow()​

Get next CSV row, return null if no more rows Does custom parsing so we don't have to parse whole string at once Some of this could be done with regex and could be tightened up as a whole.


Classes​

Config​

Defines structure of a CSV

Inheritance

AqRestResource > Config

Constructors​

public Config()​

Fields​

public theColumnMap → Map<String,ColumnDef>​

Column defs mapped by name


Properties​

public Separator → String​
public Delimiter → String​
public Columns → List<ColumnDef>​
public ColumnMap → Map<String,ColumnDef>​

Methods​

protected override void doValidate()​

ColumnDef​

Defines a column in a CSV

Inheritance

AqRestResource > ColumnDef

Properties​

public Name → String​
public DataType → String​
public MaxLength → Integer​
public Required → Boolean​

Methods​

protected override void doValidate()​

Row​

One row of values from CSV file, values are mapped by column name

Constructors​

public Row(AqCsv csv, Integer index)​

Properties​

public Index → Integer​

Row number in the file

public Values → Map<String,object>​

List of values mapped by column name

public Result → AqResult​

Warning or error information on the row


Methods​

public void addValue(ColumnDef column, String stringValue)​

Add string value

public object getValue(String columnName)​
public String getStringValue(String columnName)​
public Id getIdValue(String columnName)​
public Boolean getBooleanValue(String columnName)​
public Date getDateValue(String columnName)​
public Time getTimeValue(String columnName)​
public Datetime getDatetimeValue(String columnName)​
public Integer getIntegerValue(String columnName)​
public Decimal getDecimalValue(String columnName)​
public void validateAndConvert(List<ColumnDef> columns)​

Check all column values for required and data type, and convert to the right data type Set results into the Result property Should only be run once per row.