com.jimmoores.quandl

Class MultiDataSetRequest.Builder

java.lang.Object

com.jimmoores.quandl.MultiDataSetRequest.Builder

Enclosing class:

MultiDataSetRequest

public static final class MultiDataSetRequest.Builder
extends Object

Inner builder class. Create an instance using of("QUANDL/CODE"), call any other methods you need, and finish by calling build(). Note you are be able to use a slash as opposed to the period separator as specified in the Quandl REST API docs, but either will work here.

Method Summary

Modifier and Type	Method and Description
MultiDataSetRequest	build() Build the request object.
static MultiDataSetRequest.Builder	of(List<QuandlCodeRequest> quandlCodeRequests) Create the base DataSetRequest object passing in the Quandl code.
static MultiDataSetRequest.Builder	of(QuandlCodeRequest... quandlCodeRequests) Create the base DataSetRequest object passing in the Quandl code.
MultiDataSetRequest.Builder	withEndDate(org.threeten.bp.LocalDate endDate) Optionally specify an end date cut-off for the request.
MultiDataSetRequest.Builder	withFrequency(Frequency frequency) Optionally specify the sampling frequency for the request.
MultiDataSetRequest.Builder	withMaxRows(int maxRows) Optionally specify the maximum number of rows that should be returns for the request.
MultiDataSetRequest.Builder	withSortOrder(SortOrder sortOrder) Optionally specify the sort order of the results.
MultiDataSetRequest.Builder	withStartDate(org.threeten.bp.LocalDate startDate) Optionally specify a start date cut-off for the request.
MultiDataSetRequest.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 MultiDataSetRequest.Builder of(List<QuandlCodeRequest> quandlCodeRequests)

Create the base DataSetRequest object passing in the Quandl code.

Parameters:

quandlCodeRequests - the list of quandl codes/columns you're interested in, not null

Returns:

a Builder instance, not null

of

public static MultiDataSetRequest.Builder of(QuandlCodeRequest... quandlCodeRequests)

Create the base DataSetRequest object passing in the Quandl code.

Parameters:

quandlCodeRequests - the quandl codes/columns (VarArgs) you're interested in, not null

Returns:

a Builder instance, not null

withStartDate

public MultiDataSetRequest.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 MultiDataSetRequest.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

withFrequency

public MultiDataSetRequest.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 MultiDataSetRequest.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 MultiDataSetRequest.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 MultiDataSetRequest.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 MultiDataSetRequest build()

Build the request object.

Returns:

the immutable build object