com.jimmoores.quandl

Class TabularResult

java.lang.Object

com.jimmoores.quandl.TabularResult

All Implemented Interfaces:

Iterable<Row>

public final class TabularResult
extends Object
implements Iterable<Row>

Represents a result in tabular form.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Row	get(int index) Get a row, indexed from zero (excluding the header).
HeaderDefinition	getHeaderDefinition() Get the header definition.
int	hashCode()
boolean	isEmpty() Return whether the result set empty.
Iterator<Row>	iterator() Gets a row iterator.
static TabularResult	of(HeaderDefinition headerDefinition, List<Row> rows) Create a tabular result set from a header definition and an ordered list of rows.
int	size() Get the number of rows in this TabularResult.
String	toPrettyPrintedString() Print a nicely formatted representation of this object.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

of

public static TabularResult of(HeaderDefinition headerDefinition,
                               List<Row> rows)

Create a tabular result set from a header definition and an ordered list of rows.

Parameters:

headerDefinition - the definition of the header row, not null

rows - a list of rows, not null

Returns:

the TabularResult instance

getHeaderDefinition

public HeaderDefinition getHeaderDefinition()

Get the header definition.

Returns:

the header definition, not null

get

public Row get(int index)

Get a row, indexed from zero (excluding the header). Throws an IndexOutOfBoundsException if index >= size()

Parameters:

index - the index of the row

Returns:

the row, not null

size

public int size()

Get the number of rows in this TabularResult.

Returns:

the number of rows

isEmpty

public boolean isEmpty()

Return whether the result set empty.

Returns:

true, if the result set is empty

iterator

public Iterator<Row> iterator()

Gets a row iterator.

Specified by:

iterator in interface Iterable<Row>

Returns:

an iterator over the rows

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toPrettyPrintedString

public String toPrettyPrintedString()

Print a nicely formatted representation of this object. Currently prints a nicely formatted ACSII table.

Returns:

a string containing a multi-line description of this object