com.jimmoores.quandl

Class SearchRequest.Builder

java.lang.Object

com.jimmoores.quandl.SearchRequest.Builder

Enclosing class:

SearchRequest

public static final class SearchRequest.Builder
extends Object

Builder for this class. Examples:

   SearchRequest.Builder.of("query").withPageNumber(5).withMaxPerPage(100).build();
   SearchRequest.Builder.of("query").build();
 

Method Summary

Modifier and Type	Method and Description
SearchRequest	build() Build an instance of the underlying request object.
static SearchRequest.Builder	of(String query) Factory method to create a meta data request instance.
SearchRequest.Builder	withMaxPerPage(int maxDocsPerPage) Specify the maximum number of documents per page of results.
SearchRequest.Builder	withPageNumber(int pageNumber) Specify the page number of the results (1-based).

Methods inherited from class java.lang.Object

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

Method Detail

of

public static SearchRequest.Builder of(String query)

Factory method to create a meta data request instance. Use empty string to get all documents.

Parameters:

query - an arbitrary query string, not null (note: can be empty string to get all documents)

Returns:

an instance of this Builder for the given query string.

withPageNumber

public SearchRequest.Builder withPageNumber(int pageNumber)

Specify the page number of the results (1-based).

Parameters:

pageNumber - the page number of the results, 1-based.

Returns:

this Builder, with the page number information added

withMaxPerPage

public SearchRequest.Builder withMaxPerPage(int maxDocsPerPage)

Specify the maximum number of documents per page of results. Currently, this is limited to 100, but this library does not enforce that in case the limit changes.

Parameters:

maxDocsPerPage - the maximum number of documents per page (currently limited to 100 by API)

Returns:

this Builder, with the page number information added

build

public SearchRequest build()

Build an instance of the underlying request object.

Returns:

an instance of the seach request object