com.jimmoores.quandl

Class DataSetRequest.Builder

java.lang.Object

com.jimmoores.quandl.DataSetRequest.Builder

Enclosing class:

DataSetRequest

public static final class DataSetRequest.Builder
extends Object

Inner builder class. Create an instance using of("QUANDL/CODE"), call any other methods you need, and finish by calling build().

Method Summary

Modifier and Type	Method and Description
DataSetRequest	build() Build the request object.
static DataSetRequest.Builder	of(String quandlCode) Create the base DataSetRequest object passing in the Quandl code.
DataSetRequest.Builder	withColumn(int columnIndex) Optionally specify a specific column for the request.
DataSetRequest.Builder	withEndDate(org.threeten.bp.LocalDate endDate) Optionally specify an end date cut-off for the request.
DataSetRequest.Builder	withFrequency(Frequency frequency) Optionally specify the sampling frequency for the request.
DataSetRequest.Builder	withMaxRows(int maxRows) Optionally specify the maximum number of rows that should be returns for the request.
DataSetRequest.Builder	withSortOrder(SortOrder sortOrder) Optionally specify the sort order of the results.
DataSetRequest.Builder	withStartDate(org.threeten.bp.LocalDate startDate) Optionally specify a start date cut-off for the request.
DataSetRequest.Builder	withTransform(Transform transform) Optionally specify a data transformation function for the request.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static DataSetRequest.Builder of(String quandlCode)

Create the base DataSetRequest object passing in the Quandl code.

Parameters:

quandlCode - the quandl code for the data you're interested in, not null

Returns:

a Builder instance, not null

withStartDate

public DataSetRequest.Builder withStartDate(org.threeten.bp.LocalDate startDate)

Optionally specify a start date cut-off for the request.

Parameters:

startDate - the start date of the request (inclusive), not null

Returns:

a Builder instance, not null

withEndDate

public DataSetRequest.Builder withEndDate(org.threeten.bp.LocalDate endDate)

Optionally specify an end date cut-off for the request.

Parameters:

endDate - the end date of the request (inclusive), not null

Returns:

a Builder instance, not null

withColumn

public DataSetRequest.Builder withColumn(int columnIndex)

Optionally specify a specific column for the request. This can only be used once per request.

Parameters:

columnIndex - the zero-based column index being requested

Returns:

a Builder instance, not null

withFrequency

public DataSetRequest.Builder withFrequency(Frequency frequency)

Optionally specify the sampling frequency for the request.

Parameters:

frequency - the sampling frequency, not null

Returns:

a Builder instance, not null

withMaxRows

public DataSetRequest.Builder withMaxRows(int maxRows)

Optionally specify the maximum number of rows that should be returns for the request.

Parameters:

maxRows - the maximum number of rows that the server should return from the request

Returns:

a Builder instance, not null

withTransform

public DataSetRequest.Builder withTransform(Transform transform)

Optionally specify a data transformation function for the request.

Parameters:

transform - the data transformation method that the server should pre-process the data with

Returns:

a Builder instance, not null

withSortOrder

public DataSetRequest.Builder withSortOrder(SortOrder sortOrder)

Optionally specify the sort order of the results.

Parameters:

sortOrder - the sort order of the results

Returns:

a Builder object onto which you can chain additional calls

build

public DataSetRequest build()

Build the request object.

Returns:

the immutable build object