com.jimmoores.quandl

Class SearchResult

java.lang.Object

com.jimmoores.quandl.SearchResult

public final class SearchResult
extends Object

Class to hold meta-data for a single Quandl code.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	getCurrentPage() Get the current page of this result set.
int	getDocumentsPerPage() Get the number of documents per page in this result set.
List<MetaDataResult>	getMetaDataResultList() Extract a list of MetaDataResult objects, each one representing a match.
org.json.JSONObject	getRawJSON() Get the underlying JSON object, useful if the data structure has changed since release.
int	getTotalDocuments() Get the total number of documents in this result set.
int	hashCode()
Iterator<MetaDataResult>	iterator() An iterator over the string field names.
static SearchResult	of(org.json.JSONObject jsonObject) Factory method for creating and instance of a MetaDataResult.
String	toPrettyPrintedString() Print a nicely formatted representation of this object.
String	toString() Use the underlying JSON toString() to show full data structure.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static SearchResult of(org.json.JSONObject jsonObject)

Factory method for creating and instance of a MetaDataResult.

Parameters:

jsonObject - the JSON object returned by Quandl, not null

Returns:

a MetaDataResult instance, not null

getTotalDocuments

public int getTotalDocuments()

Get the total number of documents in this result set. Throws a QuandlRuntimeException if Quandl response doesn't contain this field, although it should.

Returns:

the total number of documents in this result set

getDocumentsPerPage

public int getDocumentsPerPage()

Get the number of documents per page in this result set. Throws a QuandlRuntimeException if Quandl response doesn't contain this field, although it should.

Returns:

the number of documents per page in this result set

getCurrentPage

public int getCurrentPage()

Get the current page of this result set. You can specify the page number in the request. Throws a QuandlRuntimeException if Quandl response doesn't contain this field, although it should.

Returns:

the page number of this result set

getMetaDataResultList

public List<MetaDataResult> getMetaDataResultList()

Extract a list of MetaDataResult objects, each one representing a match. Throws a QuandlRuntimeException if it cannot construct a valid HeaderDefinition

Returns:

the header definition, not null

iterator

public Iterator<MetaDataResult> iterator()

An iterator over the string field names.

Returns:

the iterator

getRawJSON

public org.json.JSONObject getRawJSON()

Get the underlying JSON object, useful if the data structure has changed since release.

Returns:

the underlying JSON object

toString

public String toString()

Use the underlying JSON toString() to show full data structure. This means data can be seen even if it isn't in a flat structure. To get a pretty printed version, use getRawJSON().toString(indent)

Overrides:

toString in class Object

Returns:

a string representation of the meta-data laid out as a JSON message (single line).

toPrettyPrintedString

public String toPrettyPrintedString()

Print a nicely formatted representation of this object. Currently prints a nicely formatted JSON representation.

Returns:

a string containing a multi-line description of this object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object