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:

   new SearchRequest.Builder().withQuery("query").withPageNumber(5).withMaxPerPage(100).build();
   new SearchRequest.Builder().withQuery("query").build();
   new SearchRequest.Builder().withDatabaseCode("databasecode").build();
 

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SearchRequest	build() Build an instance of the underlying request object.
static SearchRequest.Builder	of(String query) Deprecated. use Builder().withQuery(query) instead
SearchRequest.Builder	withDatabaseCode(String databaseCode) Specify the database to search within.
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).
SearchRequest.Builder	withQuery(String query) Specify the search term to use for your query.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

of

@Deprecated
public static SearchRequest.Builder of(String query)

Deprecated. use Builder().withQuery(query) instead

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.

withDatabaseCode

public SearchRequest.Builder withDatabaseCode(String databaseCode)

Specify the database to search within. For example WIKI

Parameters:

databaseCode - the database code to search within.

Returns:

this Builder, with this database code specified

withQuery

public SearchRequest.Builder withQuery(String query)

Specify the search term to use for your query. Multiple search terms can be separated by the + character.

Parameters:

query - the query string to use

Returns:

this Builder, with this query added

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