com.jimmoores.quandl

Class MetaDataResult

java.lang.Object

com.jimmoores.quandl.MetaDataResult

public final class MetaDataResult
extends Object

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Double	getDouble(String fieldName) Get a Double field.
HeaderDefinition	getHeaderDefinition() Extract a HeaderDefinition from the meta data.
org.threeten.bp.LocalDate	getLocalDate(String fieldName) Get a LocalDate field (converted from a String internally).
org.threeten.bp.OffsetDateTime	getOffsetDateTime(String fieldName) Get a LocalDate field (converted from a String internally).
String	getQuandlCode() Get the Quandl code associated with this metadata.
org.json.JSONObject	getRawJSON() Get the underlying JSON object, useful if the data structure has changed since release.
String	getString(String fieldName) Get a String field.
boolean	has(String fieldName) Return whether a field is present.
int	hashCode()
Iterator<String>	iterator() An iterator over the string field names.
static MetaDataResult	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 MetaDataResult 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

getHeaderDefinition

public HeaderDefinition getHeaderDefinition()

Extract a HeaderDefinition from the meta data. Throws a QuandlRuntimeException if it cannot construct a valid HeaderDefinition

Returns:

the header definition, not null

getQuandlCode

public String getQuandlCode()

Get the Quandl code associated with this metadata.

Returns:

the quandl code (DATASOURCE/CODE form), null if not present.

getString

public String getString(String fieldName)

Get a String field. Throws a QuandlRuntimeException if it cannot find the field

Parameters:

fieldName - the name of the field

Returns:

the field value, or null if the field is null

getLocalDate

public org.threeten.bp.LocalDate getLocalDate(String fieldName)

Get a LocalDate field (converted from a String internally). Throws a QuandlRuntimeException if it cannot find the field

Parameters:

fieldName - the name of the field

Returns:

the field value, or null if the field is null

getOffsetDateTime

public org.threeten.bp.OffsetDateTime getOffsetDateTime(String fieldName)

Get a LocalDate field (converted from a String internally). Throws a QuandlRuntimeException if it cannot find the field

Parameters:

fieldName - the name of the field

Returns:

the field value, or null if the field is null

has

public boolean has(String fieldName)

Return whether a field is present.

Parameters:

fieldName - the name of the field

Returns:

true, if the field is present

getDouble

public Double getDouble(String fieldName)

Get a Double field. This attempts to work around the stupid NaN is null behavior by explicitly testing for null. Throws a QuandlRuntimeException if it cannot find the field

Parameters:

fieldName - the name of the field

Returns:

the field value, or null if the field is null

iterator

public Iterator<String> 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 toPrettyPrintedString()

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