com.jimmoores.quandl

Class HeaderDefinition

java.lang.Object

com.jimmoores.quandl.HeaderDefinition

public final class HeaderDefinition
extends Object

The definition of the names of columns in a Row.

Method Summary

Modifier and Type	Method and Description
int	columnIndex(String columnName) Get the column index of the named column (zero-based).
boolean	equals(Object obj)
List<String>	getColumnNames() Get an immutable copy of the list of column names.
int	hashCode()
Iterator<String>	iterator() Get an iterator to return the names of all the columns in order.
static HeaderDefinition	of(List<String> columnNames) Create a RowDefinition.
static HeaderDefinition	of(String... columnNames) Create a RowDefinition when no type information is available.
int	size() Get the number of columns in this header definition.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static HeaderDefinition of(List<String> columnNames)

Create a RowDefinition. In rare situations, duplicates can occur. These will be renamed so:

   column, column, column, ... 
 

becomes:

   column, column.1, column.2, ...
 

for lookup and display purposes. A warning will be printed to the logger.

Parameters:

columnNames - a list of strings, each naming a column

Returns:

the instance

of

public static HeaderDefinition of(String... columnNames)

Create a RowDefinition when no type information is available. In rare situations, duplicates can occur. These will be renamed so:

   column, column, column, ... 
 

becomes:

   column, column.1, column.2, ...
 

for lookup purposes. A warning will be printed to the logger.

Parameters:

columnNames - a vararg array of strings, each naming a column

Returns:

the instance

columnIndex

public int columnIndex(String columnName)

Get the column index of the named column (zero-based). Throws IllegalArgumentException if column of provided name is not found. Repeated column names can be indexed as column, column.1, column.2, etc.

Parameters:

columnName - the name of the column

Returns:

the column index

size

public int size()

Get the number of columns in this header definition.

Returns:

the number of columns

iterator

public Iterator<String> iterator()

Get an iterator to return the names of all the columns in order.

Returns:

the iterator

getColumnNames

public List<String> getColumnNames()

Get an immutable copy of the list of column names.

Returns:

an immutable copy of the list of column names

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