org.refcodes.tabular (org.refcodes:refcodes-tabular 3.3.5 API)

package org.refcodes.tabular

This archetype helps processing table like data structures including the processing of CSV files with records, headers as well as comments whilst supporting Plain old Java objects (POJO) and simple new Java record types.

Please refer to the refcodes-tabular: Process tabular data and CSV files using POJOs documentation for an up-to-date and detailed description on the usage of this artifact.

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.

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).

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).

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.

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. Field<T> A Field stores an attribute consisting of a key (name) and a value. FieldImpl<T> Implementation of the Field interface being Cloneable. Fields<T> A Fields stores an attribute consisting of a key (name) and an array of values. 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. 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. FormattedColumnDecorator<T> Decorator implementation of the HeaderSetupMetrics interface. FormattedColumnImpl<T> Implementation of the FormattedColumn interface. 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. 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. 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. HeaderImpl<T> Implementation of the Header interface being Cloneable. 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. 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. 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. PrintStackTrace The Enum PrintStackTrace. 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. RecordImpl<T> Implementation of the Record interface being Cloneable. 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. RecordsComposite<T> Implementation of the Records interface wrapping multiple Records instances. RecordsImpl<T> Implementation of the Records interface being Cloneable. RecordWriter<T> The RecordWriter writes data. Row<T> A Row holds multiple data elements loosely coupled to a Header. RowImpl<T> Implementation of the Row interface being Cloneable. Rows<T> A bunch of Row instances is represented by a Rows instance. 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. TabularException Base exception for this artifact. TabularException.ColumnException Base exception with a Column. TabularException.ColumnException.ColumnValueException Base exception with a Column and a related value. TabularException.HeaderException Base exception with a Header. TabularException.KeyException Base exception with a key (name). TabularRuntimeException Base runtime exception for the refcodes-tabular artifact. 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.

Package org.refcodes.tabular