Module org.refcodes.tabular

Package org.refcodes.tabular

The tabular package provides a frame to handle tables of data, often occurring when logging or when working with CSV files. As of the anatomy of a DB table or spread sheet or a CSV file (or a log file), the table frame provides the base types:

• @link org.refcodes.tabular.Column}
• Header
• Header
• Row
• Rows
• Record
• Records

Column:

Similar to a column definition for a DB or a spread sheet (or, with reservations, a CSV file), a Column describes properties such as name (key) and type of elements related to that Column (e.g. the according elements of the Row lines).

Header:

A list of Column instances, for example describing the elements of a CSV file (visually speaking the of the CSV file's header line), is represented by the Header. The Header preserves an order for a list of Column instances. A Header provides the semantics for related Row instances.

Header:

In case no order of the Column instances is explicitly required (similar to a DB table or a spread sheet, in contrast to a CSV file) then Column instances are grouped by a Header set.

Header provide additional semantics to the Field instances stored in a Record.

Row:

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.

Rows:

A bunch of Row instances is represented by a Rows instance. As of efficiency reasons, a Rows instance can be iterated through, returning a single Row within each iteration. This approach is making it possible to query a DB in the background and just hold the Row instances being served next in the Rows instance (in memory).

The way how Rows instances manage their related Row instances is implementation specific, a plain java implementation might use some kind of collection for storing the Row instances (this can get memory intensive and not applicable when working with big data). A DB implementation might retrieve the Row instances in blocks one by one, one after the other, by querying the DB accordingly (in terms of "next" result sets).

Record:

A Record is a Map containing Field data structures with support for Column definitions. The Field instances can be managed with the functionality provided by a Column.

A value can be retrieved from a Record by providing an according Column definition, which verifies the value type. Also values can be converted to and from the appropriate interchange and string formats by the according Column instances.

In contrast to a Row, a Record relates the key (name) to its values. Similar to a Row, a Record makes use of Column instances (for example as provided by a Header or a Header instance) to give the fields additional semantics.

Records:

A bunch of Record instances is represented by a Records instance. As of efficiency reasons, a Records instance can be iterated through, returning a single Record within each iteration. This approach is making it possible to query a DB in the background and just hold the Record instances being served next in the Records instance (in memory).

The way how Records instances manage their related Record instances is implementation specific, a plain java implementation might use some kind of collection for storing the Record instances (this can get memory intensive and not applicable when working with big data). A DB implementation might retrieve the Record instances in blocks one by one, one after the other, by querying the DB accordingly (in terms of "next" result sets).

Interface Summary

Interface	Description
Column<T>	Similar to a Column definition for a DB or a spread sheet (or, with reservations, a CSV file), a Column describes properties such as name (key) and type of elements related to that Column (e.g. the according elements of the Row lines).
ColumnAccessor<T>	Provides an accessor for a Column property.
ColumnAccessor.ColumnMutator<T>	Provides a mutator for a Column property.
ColumnAccessor.ColumnProperty<T>	Provides a Column property.
ColumnFactory<T>	A ColumnFactory creates or retrieves a Column instances identified by the provided key (name).
ColumnRow<T,C extends Column<? extends T>>	In case no order of the Column instances is explicitly required (similar to a DB table or a spread sheet, in contrast to a CSV file) then Column instances are grouped by a ColumnRow set.
Columns<T>	In case no order of the Column instances is explicitly required (similar to a DB table or a spread sheet, in contrast to a CSV file) then Column instances are grouped by a Columns set.
Field<T>	A Field stores an attribute consisting of a key (name) and a value.
Fields<T>	A Fields stores an attribute consisting of a key (name) and an array of values.
FormattedColumn<T>	Enriches a Column with rendering metrics (as of the ColumnSetupMetrics) mostly for text-based output such as for generating output for a terminal / console.
FormattedColumns<T>	In case no order of the FormattedColumn instances is explicitly required (similar to a DB table or a spread sheet, in contrast to a CSV file) then FormattedColumn instances are grouped by a FormattedColumns set.
Header<T>	A list of Column instances, for example describing the elements of a CSV file (visually speaking the of the CSV file's header line), is represented by the Header.
HeaderAccessor<T>	Provides an accessor for a Header property.
HeaderAccessor.HeaderBuilder<T extends HeaderAccessor.HeaderBuilder<?>>	Provides a mutator for an header property.
HeaderAccessor.HeaderMutator<T>	Provides a mutator for a Header property.
HeaderAccessor.HeaderProperty<T>	Provides a Header property.
HeaderRow<T,C extends Column<? extends T>>	A list of Column instances, for example describing the elements of a CSV file (visually speaking the of the CSV file's header line), is represented by the HeaderRow.
Record<T>	A Record is a Map containing Field data structures with support for Column definitions.
RecordAccessor<T>	Provides an accessor for a Record property.
RecordAccessor.RecordMutator<T>	Provides a mutator for a Record property.
RecordAccessor.RecordProperty<T>	Provides a Record property.
RecordReader<T>	Extends the Records with functionality for file based implementations regarding header management and means to monitor the state of reading data.
Records<T>	A bunch of Record instances is represented by a Records instance.
RecordsAccessor<T>	Provides an accessor for a Records property.
RecordsAccessor.RecordsMutator<T>	Provides a mutator for a Records property.
RecordsAccessor.RecordsProperty<T>	Provides a Records property.
RecordWriter<T>	The RecordWriter writes data.
Row<T>	A Row holds multiple data elements loosely coupled to a Header.
Rows<T>	A bunch of Row instances is represented by a Rows instance.

Class Summary

Class	Description
AbstractColumn<T>	The AbstractColumn is the default implementation for the Column interface.
AbstractHeader<T,C extends Column<? extends T>>	Implementation of the Header interface being Cloneable.
BooleanColumn	Implementation of the Column interface for working with Boolean instances, being Cloneable.
BooleanColumnFactory	Most generic ColumnFactory for creating Column instances managing instances of the (sub-)type Boolean.
CompositeRecords<T>	Implementation of the Records interface wrapping multiple Records instances.
CsvRecordReader<T>	The CsvRecordReader is an implementation of the RecordReader interface and provides functionality to parse CSV input streams: Column<Float> floatColumn = floatColumn( "volume" ); Column<String> stringColumn = floatColumn( "name" ); Column<Integer> intColumn = floatColumn( "length" ); Column<Date> dateColumn = floatColumn( "time" ); try (CsvRecordReader<?
CsvRecordWriter<T>	The CsvRecordWriter writes CSV-Data.
CsvStringRecordReader	THis implementation of the CsvRecordReader assumes that for ease of use we just want to handle String columns.
CsvStringRecordWriter
DateColumn	DateColumn implements the Column with support for the Date type and various default or custom date formats.
DoubleColumn	Implementation of the Column interface for working with Double instances, being Cloneable.
DoubleColumnFactory	Most generic ColumnFactory for creating Column instances managing instances of the (sub-)type Double.
EnumColumn<T extends Enum<T>>	Implementation of the Column interface for working with Enum instances, being Cloneable.
ExceptionColumn	The Class ExceptionColumnImpl.
FieldImpl<T>	Implementation of the Field interface being Cloneable.
FieldsImpl<T>	Implementation of the Fields interface being Cloneable.
FloatColumn	Implementation of the Column interface for working with Float instances, being Cloneable.
FloatColumnFactory	Most generic ColumnFactory for creating Column instances managing instances of the (sub-)type Float.
FormattedColumnDecorator<T>	Decorator implementation of the HeaderSetupMetrics interface.
FormattedColumnImpl<T>	Implementation of the FormattedColumn interface.
FormattedHeader<T>	A list of Column instances, for example describing the elements of a CSV file (visually speaking the of the CSV file's header line), is represented by the FormattedHeader.
HeaderImpl<T>	Implementation of the Header interface being Cloneable.
IntColumn	Implementation of the Column interface for working with Integer instances, being Cloneable.
IntColumnFactory	Most generic ColumnFactory for creating Column instances managing instances of the (sub-)type Integer.
LongColumn	Implementation of the Column interface for working with Long instances, being Cloneable.
LongColumnFactory	Most generic ColumnFactory for creating Column instances managing instances of the (sub-)type Long.
ObjectColumn<T>	Implementation of a Column supporting Object instances, being Cloneable.
ObjectColumnFactory	Most generic ColumnFactory for creating Column instances managing instances of the (sub-)type Object.
RecordImpl<T>	Implementation of the Record interface being Cloneable.
RecordsImpl<T>	Implementation of the Records interface being Cloneable.
RowImpl<T>	Implementation of the Row interface being Cloneable.
RowsImpl<T>	Implementation of the Rows interface being Cloneable.
StringColumn	Implementation of the Column interface for working with String instances, being Cloneable.
StringColumnFactory	Most generic ColumnFactory for creating Column instances managing instances of the (sub-)type String.
StringHeader	A Header implementation dedicated to the String type.
StringsColumn	Implementation of the Column interface for working with String arrays, being Cloneable.
TabularSugar	Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for the tabular package's elements, e.g. for creating Header or Column instances or CsvRecordReader (CsvStringRecordReader) or CsvRecordWriter (CsvStringRecordWriter) instances.
TabularUtility	Utility for listing specific functionality.

Enum Summary

Enum	Description
PrintStackTrace	The Enum PrintStackTrace.

Exception Summary

Exception	Description
ColumnMismatchException	Thrown in case a value was found in the e.g. in a Record of the wrong type than specified by a provided Column (of for example a Header).
HeaderMismatchException	Thrown in case there is a mismatch between the given Header and a Row (or another Header), i.e. the index for the given key in a header may be out of index of a given row or the given key does not exist in a Header.
TabularException	Base exception for the refcodes-tabular artifact.
TabularRuntimeException	Base runtime exception for the refcodes-tabular artifact.