Module org.refcodes.tabular

Package org.refcodes.tabular

Interface Row<T>

Type Parameters:

T - The type managed by the Row.

All Superinterfaces:

Collection<T>, Iterable<T>, List<T>, SequencedCollection<T>

All Known Implementing Classes:

RowImpl

public interface Row<T>
extends List<T>

A Row holds multiple data elements loosely coupled to a Header. As a Row just contains a list of data elements with no keys (names) directly associated to the elements, a Header with the according list of key (name) and type definitions is required to give a Row its semantics.

In terms of a CSV file, a Row represents a single line of comma separated values. The Header stands for the header line (top line) of the CSV file. The semantics for the content of a Row is provided by the according Header.

Many Row instances are contained in a Rows instance which in turn requires a single Header to give all the therein contained Row instances their semantics (in terms of key (name) and type information).

In contrast to a Row, a Record relates an element field with a key (name), called Field.

In contrast to a Record, a Row does not relate a key (name) to its values. To do this, a Header is required. Similar to a Record, a Row makes use of Column instances (provided by a Header instance) to give the fields additional semantics.

Method Summary

Modifier and Type	Method	Description
T	get(Header<T> aHeader, String aKey)	This method retrieves a value from the row by taking the index of the according column in the header of the given key (the one with the given key) and returns that value.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, addFirst, addLast, clear, contains, containsAll, equals, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, set, size, sort, spliterator, subList, toArray, toArray

Method Details

get

T get(Header<T> aHeader,
 String aKey)
throws HeaderMismatchException,
ColumnMismatchException

This method retrieves a value from the row by taking the index of the according column in the header of the given key (the one with the given key) and returns that value. This is possible as the values in the row and in the header have an order. This method is used as a convenience delegate by Header.get(Row, String).

Parameters:

aHeader - The header being the reference for retrieval of the value by the given key.

aKey - The key for which to retrieve the value.

Returns:

The value in the row representing the key in the header.

Throws:

HeaderMismatchException - Thrown in case there is a mismatch between the given HeaderMismatchException and the Row, i.e. the index for the given key in the header may be out of index of the given row or the given key does not exist in the Header.

ColumnMismatchException - in case the type defined in the column for that key does not match the type in the row identified by the given key.