com.github.gwtd3.api.dsv

Class Dsv<T>

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.dsv.Dsv<T>

public class Dsv<T>
extends com.google.gwt.core.client.JavaScriptObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Dsv()

Method Summary

Methods

Modifier and Type	Method and Description
Dsv<T>	get(DsvCallback<T> callback) Defines a callback to invoke on request response.
DsvRows<DsvRow>	parse(String csvContent) Parse a CSV string into objects using the header row.
DsvRows<T>	parse(String csvContent, DsvObjectAccessor<T> accessor) Parse a CSV string into objects using the header row.
DsvRows<com.google.gwt.core.client.JsArrayString>	parseRows(String csvContent) Parses the specified string, which is the contents of a CSV file, returning an array of arrays representing the parsed rows.
DsvRows<T>	parseRows(String csvContent, DsvArrayAccessor<T> accessor) Parses the specified string, which is the contents of a CSV file, returning an array of arrays representing the parsed rows.
Dsv<T>	row(DsvObjectAccessor<T> accessor) Defines an accessor to invoke on each rows.

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Dsv

protected Dsv()

Method Detail

get

public final Dsv<T> get(DsvCallback<T> callback)

Defines a callback to invoke on request response.

When the CSV data is available, the specified callback will be invoked with the parsed rows as the argument. If an error occurs, the callback function will instead be invoked with null.

Parameters:

callback - the callback.

Returns:

the CSV module.

row

public final Dsv<T> row(DsvObjectAccessor<T> accessor)

Defines an accessor to invoke on each rows.

An optional accessor function may be specified, which is then passed to d3.csv.parse; the accessor may also be specified by using the return request object’s row function.

Parameters:

accessor - the accessor.

Returns:

the CSV module.

parse

public final DsvRows<DsvRow> parse(String csvContent)

Parse a CSV string into objects using the header row.

Parses the specified string, which is the contents of a CSV file, returning an array of objects representing the parsed rows. The string is assumed to be RFC4180-compliant. Unlike the parseRows method, this method requires that the first line of the CSV file contain a comma-separated list of column names; these column names become the attributes on the returned objects.

Parameters:

csvContent - the content of a CSV file.

Returns:

the rows.

parse

public final DsvRows<T> parse(String csvContent,
               DsvObjectAccessor<T> accessor)

Parse a CSV string into objects using the header row.

Parses the specified string, which is the contents of a CSV file, returning an array of objects representing the parsed rows. The string is assumed to be RFC4180-compliant. Unlike the parseRows method, this method requires that the first line of the CSV file contain a comma-separated list of column names; these column names become the attributes on the returned objects.

Parameters:

csvContent - the content of a CSV file.

accessor - the accessor.

Returns:

the rows.

parseRows

public final DsvRows<com.google.gwt.core.client.JsArrayString> parseRows(String csvContent)

Parses the specified string, which is the contents of a CSV file, returning an array of arrays representing the parsed rows.

The string is assumed to be RFC4180-compliant. Unlike the parse method, this method treats the header line as a standard row, and should be used whenever the CSV file does not contain a header. Each row is represented as an array rather than an object. Rows may have variable length.

Parameters:

csvContent - the contents of a CSV file

Returns:

CSV rows

parseRows

public final DsvRows<T> parseRows(String csvContent,
                   DsvArrayAccessor<T> accessor)

Parses the specified string, which is the contents of a CSV file, returning an array of arrays representing the parsed rows.

The string is assumed to be RFC4180-compliant. Unlike the parse method, this method treats the header line as a standard row, and should be used whenever the CSV file does not contain a header. Each row is represented as an array rather than an object. Rows may have variable length.

Parameters:

csvContent - the contents of a CSV file

accessor - the accessor

Returns:

CSV rows